Service Credentials Actions

https://api.losant.com/applications/APPLICATION_ID/credentials

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

Get

Returns a collection of credentials for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/credentials

Authentication

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

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, type, creationDate, lastUpdated	creationDate	`sortField=creationDate`
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	desc	`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: name, type		`filterField=type`
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		`filter=aws`

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/applications/APPLICATION_ID/credentials

Successful Responses

Code	Type	Description
200	Credentials	Collection of credentials

Error Responses

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

Post

Create a new credential for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/credentials

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, credentials.*, or credentials.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

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

{
  "name": "locker",
  "type": "azure",
  "enabled": true,
  "azureConfig": {
    "account": "my account",
    "accountKey": "123abc"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"locker","type":"azure","enabled":true,"azureConfig":{"account":"my account","accountKey":"123abc"}}' \
    https://api.losant.com/applications/APPLICATION_ID/credentials

Successful Responses

Code	Type	Description
201	Credential	Successfully created credential

Error Responses

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

Schemas

Credential

Schema for a single Credential

Credential Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 29 keys▶
id:{} 2 keys
▶
credentialId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
type:{} 2 keys
▶
awsConfig:{} 4 keys
▶
azureConfig:{} 3 keys
▶
gcpConfig:{} 4 keys
▶
httpConfig:{} 4 keys
▶
sendgridConfig:{} 3 keys
▶
twilioConfig:{} 4 keys
▶
logglyConfig:{} 3 keys
▶
jwtConfig:{} 4 keys
▶
whatsappConfig:{} 4 keys
▶
sqlConfig:{} 4 keys
▶
mongodbConfig:{} 3 keys
▶
mailgunConfig:{} 3 keys
▶
snowflakeConfig:{} 4 keys
▶
gitConfig:{} 4 keys
▶
datadogConfig:{} 3 keys
▶
certificateKeyPairConfig:{} 3 keys
additionalProperties:false
▶
required:[] 2 items

Credential Example

▶
(root){} 12 keysid:"575ece2b7ae143cd83dc4a9b"
applicationId:"575ece2b7ae143cd83dc4a9c"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
lastUpdatedByType:"user"
lastUpdatedById:"575ece2b7ae143cd83dc4a9d"
createdByType:"user"
createdById:"575ece2b7ae143cd83dc4a9d"
name:"Dave"
type:"azure"
enabled:true
▶
azureConfig:{} 1 key

Credential Post

Schema for a Credential creation request

Credential Post Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 20 keys▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
type:{} 2 keys
▶
awsConfig:{} 4 keys
▶
azureConfig:{} 4 keys
▶
gcpConfig:{} 4 keys
▶
httpConfig:{} 4 keys
▶
sendgridConfig:{} 4 keys
▶
twilioConfig:{} 4 keys
▶
logglyConfig:{} 4 keys
▶
jwtConfig:{} 4 keys
▶
whatsappConfig:{} 4 keys
▶
sqlConfig:{} 4 keys
▶
mongodbConfig:{} 4 keys
▶
mailgunConfig:{} 4 keys
▶
snowflakeConfig:{} 4 keys
▶
gitConfig:{} 4 keys
▶
datadogConfig:{} 4 keys
▶
certificateKeyPairConfig:{} 4 keys
additionalProperties:false
▶
required:[] 2 items

Credential Post Example

▶
(root){} 4 keysname:"locker"
type:"azure"
enabled:true
▶
azureConfig:{} 2 keys

Credentials

Schema for a collection of Credentials

Credentials Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 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
▶
applicationId:{} 2 keys

Credentials Example

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

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 keystype:"NotFound"
message:"Application was not found"

Was this page helpful?

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

Get​

Method And Url​

Authentication​

Request Path Components​

Request Query Parameters​

Request Headers​

Curl Example​

Successful Responses​

Error Responses​

Post​

Method And Url​

Authentication​

Request Path Components​

Request Headers​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Schemas​

Credential​

Credential Schema​

Credential Example​

Credential Post​

Credential Post Schema​

Credential Post Example​

Credentials​

Credentials Schema​

Credentials Example​

Error​

Error Schema​

Error Example​

Was this page helpful?

Get

Method And Url

Authentication

Request Path Components

Request Query Parameters

Request Headers

Curl Example

Successful Responses

Error Responses

Post

Method And Url

Authentication

Request Path Components

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Schemas

Credential

Credential Schema

Credential Example

Credential Post

Credential Post Schema

Credential Post Example

Credentials

Credentials Schema

Credentials Example

Error

Error Schema

Error Example