User Oauth Clients Actions

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

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

Get

Returns the private OAuth clients for a user

Method And Url

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

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, userOauthClients.*, or userOauthClients.get.

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: client_name, id, creationDate, lastUpdated	client_name	sortField=client_name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: client_name		filterField=client_name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*app

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

Successful Responses

Code	Type	Description
200	User OAuth Clients	Collection of private OAuth clients

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new private OAuth client for a user

Method And Url

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

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, userOauthClients.*, or userOauthClients.post.

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 Post schema. For example, the following would be a valid body for this request:

{
  "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": [
    "https://example.com/callback"
  ],
  "token_endpoint_auth_method": "client_secret_basic",
  "scope": [
    "only.User.read",
    "all.Application.read"
  ],
  "contacts": [
    "admin@example.com"
  ],
  "tos_uri": "https://example.com/tos",
  "policy_uri": "https://example.com/privacy"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"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":["https://example.com/callback"],"token_endpoint_auth_method":"client_secret_basic","scope":["only.User.read","all.Application.read"],"contacts":["admin@example.com"],"tos_uri":"https://example.com/tos","policy_uri":"https://example.com/privacy"}' \
    https://api.losant.com/me/oauth-clients

Successful Responses

Code	Type	Description
201	User OAuth Client	The successfully created OAuth client. client_secret is only ever returned on this response.

Error Responses

Code	Type	Description
400	Error	Error if malformed request

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"

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 Post

Schema for the body of a private OAuth client creation request

User OAuth Client Post Schema

▶
(root){} 5 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
▶
required:[] 2 items

User OAuth Client Post Example

▶
(root){} 10 keys
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
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 Clients

Schema for a collection of private OAuth clients

User OAuth Clients Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys

User OAuth Clients Example

▶
(root){} 7 keys
▶
items:[] 1 item
count:1
totalCount:1
perPage:1000
page:0
sortField:"client_name"
sortDirection:"asc"