User Oauth Client Actions

https://api.losant.com/me/oauth-clients/CLIENT_ID

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

Delete

Deletes a private OAuth client

Method And Url

DELETE https://api.losant.com/me/oauth-clients/CLIENT_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, userOauthClient.*, or userOauthClient.delete.

Request Path Components

Path Component	Description	Example
CLIENT_ID	ID associated with the OAuth client	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.losant.com/me/oauth-clients/CLIENT_ID

Successful Responses

Code	Type	Description
200	Success	If OAuth client was successfully deleted

Error Responses

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

Get

Retrieves information on a private OAuth client

Method And Url

GET https://api.losant.com/me/oauth-clients/CLIENT_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, userOauthClient.*, or userOauthClient.get.

Request Path Components

Path Component	Description	Example
CLIENT_ID	ID associated with the OAuth client	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.losant.com/me/oauth-clients/CLIENT_ID

Successful Responses

Code	Type	Description
200	User OAuth Client	OAuth client information

Error Responses

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

Patch

Updates information about a private OAuth client

Method And Url

PATCH https://api.losant.com/me/oauth-clients/CLIENT_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, userOauthClient.*, or userOauthClient.patch.

Request Path Components

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

{
  "client_name": "Updated Private Client Name",
  "description": "Updated description",
  "redirect_uris": [
    "https://example.com/new-callback"
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"client_name":"Updated Private Client Name","description":"Updated description","redirect_uris":["https://example.com/new-callback"]}' \
    https://api.losant.com/me/oauth-clients/CLIENT_ID

Successful Responses

Code	Type	Description
200	User OAuth Client	Updated OAuth client information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if OAuth client 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:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

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 Client

Schema for a single private OAuth client

User OAuth Client Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys
▶
id:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
client_id:{} 2 keys
▶
client_secret:{} 2 keys
▶
client_name:{} 3 keys
▶
description:{} 2 keys
▶
client_uri:{} 3 keys
▶
logo_uri:{} 4 keys
▶
redirect_uris:{} 5 keys
▶
grant_types:{} 3 keys
▶
response_types:{} 3 keys
▶
token_endpoint_auth_method:{} 3 keys
▶
scope:{} 4 keys
▶
contacts:{} 4 keys
▶
tos_uri:{} 3 keys
▶
policy_uri:{} 3 keys

User OAuth Client Example

▶
(root){} 17 keys
id:"575ec7417ae143cd83dc4a95"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
client_id:"575ec7417ae143cd83dc4a95"
client_secret:"8f14e45fceea167a5a36dedd4bea2543"
client_name:"My Private Client"
description:"Private OAuth client for automation"
client_uri:"https://example.com"
logo_uri:"https://example.com/logo.png"
▶
redirect_uris:[] 1 item
▶
grant_types:[] 2 items
▶
response_types:[] 1 item
token_endpoint_auth_method:"client_secret_basic"
▶
scope:[] 2 items
▶
contacts:[] 1 item
tos_uri:"https://example.com/tos"
policy_uri:"https://example.com/privacy"

User OAuth Client Patch

Schema for the body of a private OAuth client modification request

User OAuth Client Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
client_name:{} 3 keys
▶
description:{} 2 keys
▶
client_uri:{} 1 key
▶
logo_uri:{} 1 key
▶
redirect_uris:{} 5 keys
▶
token_endpoint_auth_method:{} 3 keys
▶
scope:{} 4 keys
▶
contacts:{} 4 keys
▶
tos_uri:{} 1 key
▶
policy_uri:{} 1 key
additionalProperties:false

User OAuth Client Patch Example

▶
(root){} 3 keys
client_name:"Updated Private Client Name"
description:"Updated description"
▶
redirect_uris:[] 1 item