Credentials Actions
https://api.losant.com/applications/APPLICATION_ID
/credentials
Below are the various requests that can be performed against the 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.read, all.Organization, all.Organization.read, all.User, 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.Organization, all.User, 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 |
Was this page helpful?
Still looking for help? You can also search the Losant Forums or submit your question there.