Device Certificate Authority Actions

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

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

Delete

Deletes an application certificate authority

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/certificate-authorities/APPLICATION_CERTIFICATE_AUTHORITY_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.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificateAuthority.*, or applicationCertificateAuthority.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
APPLICATION_CERTIFICATE_AUTHORITY_ID	ID associated with the application certificate authority	575ec76c7ae143cd83dc4a96

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/applications/APPLICATION_ID/certificate-authorities/APPLICATION_CERTIFICATE_AUTHORITY_ID

Successful Responses

Code	Type	Description
200	Success	If application certificate authority was successfully deleted

Error Responses

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

Get

Retrieves information on an application certificate authority

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/certificate-authorities/APPLICATION_CERTIFICATE_AUTHORITY_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.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationCertificateAuthority.*, or applicationCertificateAuthority.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
APPLICATION_CERTIFICATE_AUTHORITY_ID	ID associated with the application certificate authority	575ec76c7ae143cd83dc4a96

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/APPLICATION_CERTIFICATE_AUTHORITY_ID

Successful Responses

Code	Type	Description
200	Application Certificate Authority	Application certificate authority information

Error Responses

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

Patch

Updates information about an application certificate authority

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/certificate-authorities/APPLICATION_CERTIFICATE_AUTHORITY_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.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificateAuthority.*, or applicationCertificateAuthority.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
APPLICATION_CERTIFICATE_AUTHORITY_ID	ID associated with the application certificate authority	575ec76c7ae143cd83dc4a96

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

{
  "status": "active",
  "description": "An example updated authority description"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"status":"active","description":"An example updated authority description"}' \
    https://api.losant.com/applications/APPLICATION_ID/certificate-authorities/APPLICATION_CERTIFICATE_AUTHORITY_ID

Successful Responses

Code	Type	Description
200	Application Certificate Authority	Updated application certificate authority information

Error Responses

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

Schemas

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 Patch

Schema for the body of an Application Certificate Authority modification request

Application Certificate Authority Patch Schema

▶
(root){} 4 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
additionalProperties:false

Application Certificate Authority Patch Example

▶
(root){} 2 keys
status:"active"
description:"An example updated authority description"

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