Device Certificate Authorities Actions

https://api.losant.com/applications/APPLICATION_ID/certificate-authorities

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

Get

Returns the application certificate authorities for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/certificate-authorities

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, applicationCertificateAuthorities.*, or applicationCertificateAuthorities.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, status, id, creationDate, lastUpdated	name	sortField=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: name, status		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=the*name

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/certificate-authorities

Successful Responses

Code	Type	Description
200	Application Certificate Authorities	Collection of application certificate authorities

Error Responses

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

Post

Create a new application certificate authority for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/certificate-authorities

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

{
  "name": "my certificate authority",
  "description": "An example new authority description",
  "caBundle": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"my certificate authority","description":"An example new authority description","caBundle":"-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----"}' \
    https://api.losant.com/applications/APPLICATION_ID/certificate-authorities

Successful Responses

Code	Type	Description
201	Application Certificate Authority	Successfully created application certificate authority

Error Responses

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

Schemas

Application Certificate Authorities

Schema for a collection of Application Certificate Authorities

Application Certificate Authorities 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

Application Certificate Authorities Example

▶
(root){} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"key"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"

Application Certificate Authority

Schema for a single Application Certificate Authority

Application Certificate Authority Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 14 keys
▶
id:{} 2 keys
▶
applicationCertificateAuthorityId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
status:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
caBundle:{} 3 keys
▶
caInfo:{} 2 keys

Application Certificate Authority Example

▶
(root){} 10 keys
id:"5cd02a7bdf66feb0994c7197"
applicationCertificateAuthorityId:"5cd02a7bdf66feb0994c7197"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
status:"active"
name:"my certificate authority"
description:"An example certificate authority description"
caBundle:"-----BEGIN CERTIFICATE-----
MY_SSL_CERTIFICATE
-----END CERTIFICATE-----"
▶
caInfo:[] 1 item

Application Certificate Authority Post

Schema for the body of an Application Certificate Authority creation request

Application Certificate Authority Post Schema

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

Application Certificate Authority Post Example

▶
(root){} 3 keys
name:"my certificate authority"
description:"An example new authority description"
caBundle:"-----BEGIN CERTIFICATE-----
MY_SSL_CERTIFICATE
-----END CERTIFICATE-----"

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"