User Oauth Token Actions

https://api.app.wnology.io/me/oauth-tokens/OAUTH_TOKEN_ID

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

Delete

Deletes an OAuth Token

Method And Url

DELETE https://api.app.wnology.io/me/oauth-tokens/OAUTH_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, only.User, userOauthToken.*, or userOauthToken.delete.

Request Path Components

Path Component	Description	Example
OAUTH_TOKEN_ID	ID associated with the OAuth 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/oauth-tokens/OAUTH_TOKEN_ID

Successful Responses

Code	Type	Description
200	Success	If OAuth token was successfully deleted

Error Responses

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

Get

Retrieves information on an OAuth token

Method And Url

GET https://api.app.wnology.io/me/oauth-tokens/OAUTH_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.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userOauthToken.*, or userOauthToken.get.

Request Path Components

Path Component	Description	Example
OAUTH_TOKEN_ID	ID associated with the OAuth 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/oauth-tokens/OAUTH_TOKEN_ID

Successful Responses

Code	Type	Description
200	User OAuth Token	OAuth token information

Error Responses

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

Patch

Updates information about an OAuth token

Method And Url

PATCH https://api.app.wnology.io/me/oauth-tokens/OAUTH_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, only.User, userOauthToken.*, or userOauthToken.patch.

Request Path Components

Path Component	Description	Example
OAUTH_TOKEN_ID	ID associated with the OAuth 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 User OAuth Token Patch schema. For example, the following would be a valid body for this request:

{
  "name": "Updated OAuth App Name",
  "description": "Updated description",
  "defaultRole": "edit",
  "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":"Updated OAuth App Name","description":"Updated description","defaultRole":"edit","status":"inactive"}' \
    https://api.app.wnology.io/me/oauth-tokens/OAUTH_TOKEN_ID

Successful Responses

Code	Type	Description
200	User OAuth Token	Updated OAuth token information

Error Responses

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

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
(root){} 1 key
success:true

User OAuth Token

Schema for a single OAuth Token

User OAuth Token Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 12 keys
▶
id:{} 2 keys
▶
oauthTokenId:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
expirationDate:{} 2 keys
▶
defaultRole:{} 2 keys
▶
orgRoles:{} 3 keys
▶
scope:{} 4 keys
▶
status:{} 2 keys
▶
oauth:{} 2 keys

User OAuth Token Example

▶
(root){} 11 keys
id:"575ec7417ae143cd83dc4a95"
oauthTokenId:"575ec7417ae143cd83dc4a95"
name:"My OAuth App"
description:"OAuth application for automation"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
▶
scope:[] 2 items
defaultRole:"view"
orgRoles:[] 0 items
status:"active"
▶
oauth:{} 6 keys

User OAuth Token Patch

Schema for the body of an OAuth Token modification request

User OAuth Token Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
defaultRole:{} 2 keys
▶
orgRoles:{} 3 keys
▶
status:{} 2 keys
additionalProperties:false

User OAuth Token Patch Example

▶
(root){} 4 keys
name:"Updated OAuth App Name"
description:"Updated description"
defaultRole:"edit"
status:"inactive"