User Api Token Actions

https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Below are the various requests that can be performed against the User Api Token resource, as well as the expected parameters and the potential responses.

Delete

Deletes an API Token

Method And Url

DELETE https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, userApiToken.*, or userApiToken.delete.

Request Path Components

Path Component Description Example
APITOKENID ID associated with the API token 575ec7417ae143cd83dc4a95

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Successful Responses

Code Type Description
200 Success If API token was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if API token was not found

Get

Retrieves information on an API token

Method And Url

GET https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.read, userApiToken.*, or userApiToken.get.

Request Path Components

Path Component Description Example
APITOKENID ID associated with the API token 575ec7417ae143cd83dc4a95

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Successful Responses

Code Type Description
200 API Token API token information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if API token was not found

Patch

Updates information about an API token

Method And Url

PATCH https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, userApiToken.*, or userApiToken.patch.

Request Path Components

Path Component Description Example
APITOKENID ID associated with the API token 575ec7417ae143cd83dc4a95

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the API Token Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated API Token",
  "status": "inactive"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated API Token","status":"inactive"}' \
    https://api.app.wnology.io/me/tokens/API_TOKEN_ID

Successful Responses

Code Type Description
200 API Token Updated API token information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if API token was not found

Was this page helpful?

Still looking for help? You can also search the WEGnology Forums or submit your question there.