Account Management API
Endpoints
AccountAPIKeys
Add API key to groups.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group or API key with that ID does not exist. | ErrorResponse |
409 | The API key is a member of the group already. | ErrorResponse |
Add API key to groups.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
409 | The API key is a member of the group already. | ErrorResponse |
Create a new API key.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys -d '{"name": "MyKey1"}' \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | ApiKeyInfoResp |
400 | Error in input data, for example, missing display name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Delete the API key.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | The API key with the specified ID does not exist. | ErrorResponse |
Retrieve API keys in an array, optionally filtered by the owner.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/api-keys \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"data" : [ {
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve API key details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | API key with the specified ID does not exist. | ErrorResponse |
Retrieve groups associated with the API key.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id}/groups \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An API key with the given ID does not exist. | ErrorResponse |
Retrieve groups associated with the API key.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve API key details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/api-keys/me \
-H 'Authorization: Bearer <api_key>'
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Remove API key from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An API key with that ID does not exist. | ErrorResponse |
Remove API key from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Reset the secret key of the API key.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id}/reset-secret \
-H 'Authorization: Bearer <api_key>'
Path parameters
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An API key with the specified ID does not exist. | ErrorResponse |
Update API key details.
Example:
`curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey_id}
-H 'Authorization: Bearer <api_key>'
-H 'content-type: application/json'
-d '{"name": "TestApiKey25"}'
Path parameters
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
400 | Error in input data, for example, missing display name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | The API key with the specified ID does not exist. | ErrorResponse |
Update API key details.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/me \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"name": "TestApiKey25"}'
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
400 | Error in input data, for example, missing display name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
AccountEmailNotificationLogs
Query parameters
Return type
Example data
{
"data" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"error_msg" : "Connection error.",
"receiver" : "example@email-receiver.test",
"subject" : "Account locked.",
"success" : true,
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"message" : "User limit has been reached.",
"type" : "email",
"object" : "notification-entry"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | NotificationEntryList |
400 | Error in input data, or missing or invalid parameters. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden | ErrorResponse |
AccountIdentityProviders
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | IdentityProviderInfo |
400 | Error in input data, for example, name is too long. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, or identity provider is in use. | ErrorResponse |
404 | Identity provider not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Identity provider not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
400 | Error in input data, for example, invalid certificate validity value. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Identity provider not found. | ErrorResponse |
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Query parameters
Return type
Example data
{
"data" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Path parameters
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Identity provider not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
400 | Error in input data, for example, missing name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Identity provider not found. | ErrorResponse |
AccountPolicyGroups
Add users and API keys to a group.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"users": ["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the user or API key does not exist. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
409 | The user of this API key is a member of the group already. | ErrorResponse |
Create a new group.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' -d '{"name": "MyGroup1"}'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | GroupSummary |
400 | Error in input data, for example, invalid group name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
409 | A group with that name already exists. | ErrorResponse |
Delete a group.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, or Administrators group cannot be removed. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
Retrieve all group information.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/policy-groups \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Manage policy groups.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id}/api-keys \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
Retrieve general information about a group.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummary |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
Retrieve users of a group with details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id}/users \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
Remove API keys from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id}/api-keys \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the array of API keys is missing. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
Manage policy groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id}/users \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the user removing themselves from the Administrators group. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
Update a group name.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"name": "TestGroup2"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the group name is too long. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
AccountProfile
Retrieve detailed information about the account.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/me?include=policies \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"country" : "United Kingdom",
"reason" : "Subscription paid.",
"aliases" : [ "aeiou" ],
"city" : "Cambridge",
"customer_number" : "1NC25_0001",
"policies" : [ {
"allow" : true,
"feature" : "update-campaigns",
"resource" : "/v3/update-campaign",
"inherited" : false,
"action" : "GET"
} ],
"sales_contact" : "sales@arm.com",
"created_at" : "2018-02-13T09:35:20Z",
"admin_email" : "admin@arm.com",
"expiration_warning_threshold" : 180,
"updated_at" : "2018-02-14T15:24:14Z",
"address_line2" : " ",
"tier" : "1",
"address_line1" : "110 Fulbourn Rd",
"contract_number" : "1NX25_0001",
"contact" : "J. Doe",
"reference_note" : "ARM-INT-0001",
"company" : "ARM Holdings Plc",
"id" : "01619571e2e90242ac12000600000000",
"state" : " ",
"idle_timeout" : 30,
"email" : "info@arm.com",
"limits" : {
"key" : "aeiou"
},
"upgraded_at" : "2018-02-14T15:24:14Z",
"custom_fields" : {
"key" : "aeiou"
},
"display_name" : "ARM",
"notification_emails" : [ "aeiou" ],
"admin_password" : "PZf9eEUH43DAPE9ULINFeuj",
"password_recovery_expiration" : 4,
"parent_account" : {
"id" : "01619571dad80242ac12000600000000",
"admin_name" : "J. Doe",
"admin_email" : "info@arm.com"
},
"mfa_status" : "enforced",
"admin_full_name" : "Admin Doe",
"password_policy" : {
"minimum_length" : 8
},
"end_market" : "IT",
"parent_id" : "01619571dad80242ac12000600000000",
"sub_accounts" : [ "" ],
"admin_id" : "01619571e2e89242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"template_id" : "01619571e7160242ac12000600000000",
"expiration" : "2000-01-23T04:56:07.000+00:00",
"admin_name" : "admin",
"postal_code" : "CB1 9NJ",
"admin_key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT",
"object" : "account",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | AccountInfo |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Update the account.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/me \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"phone_number": "12345678"}'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"country" : "United Kingdom",
"reason" : "Subscription paid.",
"aliases" : [ "aeiou" ],
"city" : "Cambridge",
"customer_number" : "1NC25_0001",
"policies" : [ {
"allow" : true,
"feature" : "update-campaigns",
"resource" : "/v3/update-campaign",
"inherited" : false,
"action" : "GET"
} ],
"sales_contact" : "sales@arm.com",
"created_at" : "2018-02-13T09:35:20Z",
"admin_email" : "admin@arm.com",
"expiration_warning_threshold" : 180,
"updated_at" : "2018-02-14T15:24:14Z",
"address_line2" : " ",
"tier" : "1",
"address_line1" : "110 Fulbourn Rd",
"contract_number" : "1NX25_0001",
"contact" : "J. Doe",
"reference_note" : "ARM-INT-0001",
"company" : "ARM Holdings Plc",
"id" : "01619571e2e90242ac12000600000000",
"state" : " ",
"idle_timeout" : 30,
"email" : "info@arm.com",
"limits" : {
"key" : "aeiou"
},
"upgraded_at" : "2018-02-14T15:24:14Z",
"custom_fields" : {
"key" : "aeiou"
},
"display_name" : "ARM",
"notification_emails" : [ "aeiou" ],
"admin_password" : "PZf9eEUH43DAPE9ULINFeuj",
"password_recovery_expiration" : 4,
"parent_account" : {
"id" : "01619571dad80242ac12000600000000",
"admin_name" : "J. Doe",
"admin_email" : "info@arm.com"
},
"mfa_status" : "enforced",
"admin_full_name" : "Admin Doe",
"password_policy" : {
"minimum_length" : 8
},
"end_market" : "IT",
"parent_id" : "01619571dad80242ac12000600000000",
"sub_accounts" : [ "" ],
"admin_id" : "01619571e2e89242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"template_id" : "01619571e7160242ac12000600000000",
"expiration" : "2000-01-23T04:56:07.000+00:00",
"admin_name" : "admin",
"postal_code" : "CB1 9NJ",
"admin_key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT",
"object" : "account",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | AccountInfo |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
AccountUserInvitations
Invite a new or existing user.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/user-invitations \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"email": "myemail@company.com"}
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_id" : "01619571e2e90242ac12000600000000",
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"etag" : "1",
"expiration" : "2018-02-14T15:24:14Z",
"id" : "01619571e2e89242ac12000600000000",
"email" : "friend@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"object" : "user-invitation"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | UserInvitationResp |
400 | Error in input data, for example, an invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Delete an active user invitation sent to a new or existing user.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An invitation with the specified ID does not exist. | ErrorResponse |
Retrieve details for all the active user invitations.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/user-invitations \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"data" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_id" : "01619571e2e90242ac12000600000000",
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"etag" : "1",
"expiration" : "2018-02-14T15:24:14Z",
"id" : "01619571e2e89242ac12000600000000",
"email" : "friend@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"object" : "user-invitation"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInvitationRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve the details of an active user invitation.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_id" : "01619571e2e90242ac12000600000000",
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"etag" : "1",
"expiration" : "2018-02-14T15:24:14Z",
"id" : "01619571e2e89242ac12000600000000",
"email" : "friend@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"object" : "user-invitation"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInvitationResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An invitation with the specified ID does not exist. | ErrorResponse |
AccountUsers
Add user to groups.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/users/{user_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user or group with that ID does not exist. | ErrorResponse |
409 | The user is a member of the group already. | ErrorResponse |
Create or invite a new user to the account. Only email address is used; other attributes are set in the second step.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/users?action=invite \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"email": "myemail@company.com"}
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Query parameters
create
or invite
.
default: create
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | UserInfoResp |
400 | Error in input data, for example, an invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
409 | A user with the given username or email already exists. | ErrorResponse |
Delete a user.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
400 | Bad request, for example, trying to delete active user. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user with the specified ID does not exist. | ErrorResponse |
Retrieve the details of all users.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/users \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"data" : [ {
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve groups of the user.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/users/{user_id}/groups \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user with the given ID does not exist. | ErrorResponse |
Query parameters
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve the details of a user.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/users/{user_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user with the specified ID does not exist. | ErrorResponse |
Remove user from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user with that ID does not exist. | ErrorResponse |
Update user details.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/users/me \
-H 'Authorization: Bearer <token>' \
-H 'content-type: application/json' \
-d '{"full_name": "fullname"}'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoResp |
400 | Error in input data, for example, an invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user with the given ID does not exist. | ErrorResponse |
409 | A user with the given username or email already exists. | ErrorResponse |
Update user details
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/users/{user_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"username": "myusername"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoResp |
400 | Error in input data, for example, an invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A user with the given ID does not exist. | ErrorResponse |
409 | A user with the given username or email already exists. | ErrorResponse |
DeviceSecurityCertificates
Upload new trusted certificates.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/trusted-certificates \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"name": "myCert1", "description": "very important cert", "certificate": "certificate_data", "service": "lwm2m"}
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | TrustedCertificateResp |
400 | Invalid certificate data, or missing or invalid parameters. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, only available for admins of commercial accounts. | ErrorResponse |
409 | Certificate with the given name or subject already exists. | ErrorResponse |
Delete a trusted certificate.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Certificate not found. | ErrorResponse |
Retrieve trusted certificates in an array.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/trusted-certificates \
-H 'Authorization: Bearer <api_key>'
Query parameters
not_equals
filter.
Return type
Example data
{
"data" : [ {
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | TrustedCertificateRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve a trusted certificate by ID.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | TrustedCertificateResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Certificate not found. | ErrorResponse |
Update existing trusted certificates.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"description": "very important cert"}
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | TrustedCertificateResp |
400 | Invalid certificate data, or missing or invalid parameters. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Certificate not found. | ErrorResponse |
409 | Certificate with the given name or subject already exists. | ErrorResponse |
SecurityAndIdentityDeveloperClassCertificates
This REST API is intended to be used by customers to get a developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server).
Note: The number of developer certificates allowed per account is limited. Please see Using your own certificate authority.
Example usage: curl -X POST "http://api.us-east-1.mbedcloud.com/v3/developer-certificates" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" -H "content-type: application/json" -d "{ "name": "THE_CERTIFICATE_NAME", "description": "THE_CERTIFICATE_DESCRIPTION"}"
Request body
Return type
Example data
{
"object" : "trusted-cert",
"id" : "015fee4431fd38c98640fbfb00000000",
"etag" : "1",
"created_at" : "2017-12-11T14:22:20.009Z",
"account_id" : "015fee5d9b3538c98640fbfb00000000",
"name" : "DeveloperCertificate",
"description" : "This certificate will be used with multiple developer devices",
"developer_certificate" : "-----BEGIN CERTIFICATE-----\\nMIICcDCCAhWgAwIBAgIRAPSBbBtLUE/ekQcWE4GzPJEwCgYIKoZIzj0EAwIwgaIx\\nCzAJBgNVBAYTAkdCMRcwFQYDVQQIDA5DYW1icmlkZ2VzaGlyZTESMBAGA1UEBwwJ\\nQ2FtYnJpZGdlMRAwDgYDVQQKDAdBUk0gTHRkMSkwJwYDVQQLDCAwMTU4NDNlMzJl\\nYzkwMjQyMGEwMTVlMDcwMDAwMDAwMDEpMCcGA1UEAwwgMDE2MWRiYmNkZDY2MGE1\\nODBhMDEwYzM0MDNjMDAwMDAwHhcNMTgwMjI4MDkyNzIzWhcNMjgwMjI4MDkyNzIz\\nWjCBojELMAkGA1UEBhMCR0IxFzAVBgNVBAgMDkNhbWJyaWRnZXNoaXJlMRIwEAYD\\nVQQHDAlDYW1icmlkZ2UxEDAOBgNVBAoMB0FSTSBMdGQxKTAnBgNVBAsMIDAxNTg0\\nM2UzMmVjOTAyNDIwYTAxNWUwNzAwMDAwMDAwMSkwJwYDVQQDDCAwMTYxZGJiY2Rk\\nNjYwYTU4MGEwMTBjMzQwM2MwMDAwMDBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IA\\nBEScLDbOXvOb903AYlI9ow8E4hbLSHJPt5E2BO4Q4bHOpuWH2Oh6P+CDPte9pAv3\\nE6g90Xk/ZcZpQ+xBO6qci/ajKjAoMBIGCSsGAQQBoCCBSQQFAgNAAJEwEgYDVR0T\\nAQH/BAgwBgEB/wIBADAKBggqhkjOPQQDAgNJADBGAiEAsi9zSK8Njl22GoEHrsg8\\nQlwFnrkkP9d6FyLFtmqndt4CIQCmVHwisYNcCkqD2SWctG1xQHo0HZePAQW8PstM\\nzhNupQ==\\n-----END CERTIFICATE-----\\n",
"developer_private_key" : "-----BEGIN PRIVATE KEY-----\\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgeKc97aC1Z4aniXVG\\njNSvvXw2hl6zwACYIs88OKQx61GgCgYIKoZIzj0DAQehRANCAAREnCw2zl7zm/dN\\nwGJSPaMPBOIWy0hyT7eRNgTuEOGxzqblh9joej/ggz7XvaQL9xOoPdF5P2XGaUPs\\nQTuqnIv2\\n-----END PRIVATE KEY-----\\n",
"security_file_content" : "/*\\n * Copyright (c) 2017 ARM Limited. All rights reserved.\\n * SPDX-License-Identifier: Apache-2.0\\n * Licensed under the Apache License, Version 2.0 (the License); you may\\n * not use this file except in compliance with the License.\\n * You may obtain a copy of the License at\\n *\\n * http://www.apache.org/licenses/LICENSE-2.0\\n *\\n * Unless required by applicable law or agreed to in writing, software\\n * distributed under the License is distributed on an AS IS BASIS, WITHOUT\\n * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n * See the License for the specific language governing permissions and\\n * limitations under the License.\\n */\\n#ifndef __MBED_CLOUD_DEV_CREDENTIALS_H__\\n#define __MBED_CLOUD_DEV_CREDENTIALS_H__\\n\\n#include \\n\\nconst char MBED_CLOUD_DEV_BOOTSTRAP_ENDPOINT_NAME[] = \\\"0161dbbcdd660a580a010c3403c00000\\\";\\nconst char MBED_CLOUD_DEV_ACCOUNT_ID[] = \\\"015843e32ec902420a015e0700000000\\\";\\nconst char MBED_CLOUD_DEV_BOOTSTRAP_SERVER_URI[] = \\\"coaps://coap-integration-lab.dev.mbed.com:5684?aid=015843e32ec902420a015e0700000000\\\";\\n\\nconst uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE[] = \\n{ 0x30, 0x82, 0x02, 0x70, 0x30, 0x82, 0x02, 0x15,\\n 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x11, 0x00,\\n 0xf4, 0x81, 0x6c, 0x1b, 0x4b, 0x50, 0x4f, 0xde,\\n 0x91, 0x07, 0x16, 0x13, 0x81, 0xb3, 0x3c, 0x91,\\n 0x30, 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce,\\n 0x3d, 0x04, 0x03, 0x02, 0x30, 0x81, 0xa2, 0x31,\\n 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x06,\\n 0x13, 0x02, 0x47, 0x42, 0x31, 0x17, 0x30, 0x15,\\n 0x06, 0x03, 0x55, 0x04, 0x08, 0x0c, 0x0e, 0x43,\\n 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67, 0x65,\\n 0x73, 0x68, 0x69, 0x72, 0x65, 0x31, 0x12, 0x30,\\n 0x10, 0x06, 0x03, 0x55, 0x04, 0x07, 0x0c, 0x09,\\n 0x43, 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67,\\n 0x65, 0x31, 0x10, 0x30, 0x0e, 0x06, 0x03, 0x55,\\n 0x04, 0x0a, 0x0c, 0x07, 0x41, 0x52, 0x4d, 0x20,\\n 0x4c, 0x74, 0x64, 0x31, 0x29, 0x30, 0x27, 0x06,\\n 0x03, 0x55, 0x04, 0x0b, 0x0c, 0x20, 0x30, 0x31,\\n 0x35, 0x38, 0x34, 0x33, 0x65, 0x33, 0x32, 0x65,\\n 0x63, 0x39, 0x30, 0x32, 0x34, 0x32, 0x30, 0x61,\\n 0x30, 0x31, 0x35, 0x65, 0x30, 0x37, 0x30, 0x30,\\n 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x31, 0x29,\\n 0x30, 0x27, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c,\\n 0x20, 0x30, 0x31, 0x36, 0x31, 0x64, 0x62, 0x62,\\n 0x63, 0x64, 0x64, 0x36, 0x36, 0x30, 0x61, 0x35,\\n 0x38, 0x30, 0x61, 0x30, 0x31, 0x30, 0x63, 0x33,\\n 0x34, 0x30, 0x33, 0x63, 0x30, 0x30, 0x30, 0x30,\\n 0x30, 0x30, 0x1e, 0x17, 0x0d, 0x31, 0x38, 0x30,\\n 0x32, 0x32, 0x38, 0x30, 0x39, 0x32, 0x37, 0x32,\\n 0x33, 0x5a, 0x17, 0x0d, 0x32, 0x38, 0x30, 0x32,\\n 0x32, 0x38, 0x30, 0x39, 0x32, 0x37, 0x32, 0x33,\\n 0x5a, 0x30, 0x81, 0xa2, 0x31, 0x0b, 0x30, 0x09,\\n 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02, 0x47,\\n 0x42, 0x31, 0x17, 0x30, 0x15, 0x06, 0x03, 0x55,\\n 0x04, 0x08, 0x0c, 0x0e, 0x43, 0x61, 0x6d, 0x62,\\n 0x72, 0x69, 0x64, 0x67, 0x65, 0x73, 0x68, 0x69,\\n 0x72, 0x65, 0x31, 0x12, 0x30, 0x10, 0x06, 0x03,\\n 0x55, 0x04, 0x07, 0x0c, 0x09, 0x43, 0x61, 0x6d,\\n 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x31, 0x10,\\n 0x30, 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c,\\n 0x07, 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74, 0x64,\\n 0x31, 0x29, 0x30, 0x27, 0x06, 0x03, 0x55, 0x04,\\n 0x0b, 0x0c, 0x20, 0x30, 0x31, 0x35, 0x38, 0x34,\\n 0x33, 0x65, 0x33, 0x32, 0x65, 0x63, 0x39, 0x30,\\n 0x32, 0x34, 0x32, 0x30, 0x61, 0x30, 0x31, 0x35,\\n 0x65, 0x30, 0x37, 0x30, 0x30, 0x30, 0x30, 0x30,\\n 0x30, 0x30, 0x30, 0x31, 0x29, 0x30, 0x27, 0x06,\\n 0x03, 0x55, 0x04, 0x03, 0x0c, 0x20, 0x30, 0x31,\\n 0x36, 0x31, 0x64, 0x62, 0x62, 0x63, 0x64, 0x64,\\n 0x36, 0x36, 0x30, 0x61, 0x35, 0x38, 0x30, 0x61,\\n 0x30, 0x31, 0x30, 0x63, 0x33, 0x34, 0x30, 0x33,\\n 0x63, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x59,\\n 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce,\\n 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48,\\n 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00,\\n 0x04, 0x44, 0x9c, 0x2c, 0x36, 0xce, 0x5e, 0xf3,\\n 0x9b, 0xf7, 0x4d, 0xc0, 0x62, 0x52, 0x3d, 0xa3,\\n 0x0f, 0x04, 0xe2, 0x16, 0xcb, 0x48, 0x72, 0x4f,\\n 0xb7, 0x91, 0x36, 0x04, 0xee, 0x10, 0xe1, 0xb1,\\n 0xce, 0xa6, 0xe5, 0x87, 0xd8, 0xe8, 0x7a, 0x3f,\\n 0xe0, 0x83, 0x3e, 0xd7, 0xbd, 0xa4, 0x0b, 0xf7,\\n 0x13, 0xa8, 0x3d, 0xd1, 0x79, 0x3f, 0x65, 0xc6,\\n 0x69, 0x43, 0xec, 0x41, 0x3b, 0xaa, 0x9c, 0x8b,\\n 0xf6, 0xa3, 0x2a, 0x30, 0x28, 0x30, 0x12, 0x06,\\n 0x09, 0x2b, 0x06, 0x01, 0x04, 0x01, 0xa0, 0x20,\\n 0x81, 0x49, 0x04, 0x05, 0x02, 0x03, 0x40, 0x00,\\n 0x91, 0x30, 0x12, 0x06, 0x03, 0x55, 0x1d, 0x13,\\n 0x01, 0x01, 0xff, 0x04, 0x08, 0x30, 0x06, 0x01,\\n 0x01, 0xff, 0x02, 0x01, 0x00, 0x30, 0x0a, 0x06,\\n 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03,\\n 0x02, 0x03, 0x49, 0x00, 0x30, 0x46, 0x02, 0x21,\\n 0x00, 0xb2, 0x2f, 0x73, 0x48, 0xaf, 0x0d, 0x8e,\\n 0x5d, 0xb6, 0x1a, 0x81, 0x07, 0xae, 0xc8, 0x3c,\\n 0x42, 0x5c, 0x05, 0x9e, 0xb9, 0x24, 0x3f, 0xd7,\\n 0x7a, 0x17, 0x22, 0xc5, 0xb6, 0x6a, 0xa7, 0x76,\\n 0xde, 0x02, 0x21, 0x00, 0xa6, 0x54, 0x7c, 0x22,\\n 0xb1, 0x83, 0x5c, 0x0a, 0x4a, 0x83, 0xd9, 0x25,\\n 0x9c, 0xb4, 0x6d, 0x71, 0x40, 0x7a, 0x34, 0x1d,\\n 0x97, 0x8f, 0x01, 0x05, 0xbc, 0x3e, 0xcb, 0x4c,\\n 0xce, 0x13, 0x6e, 0xa5 };\\n\\nconst uint8_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE[] = \\n{ 0x30, 0x82, 0x02, 0x35, 0x30, 0x82, 0x01, 0xdb,\\n 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x10, 0x5c,\\n 0x27, 0xa5, 0x76, 0x7d, 0x58, 0x85, 0x8a, 0x43,\\n 0x91, 0xa0, 0x61, 0xab, 0xcf, 0xa6, 0x59, 0x30,\\n 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x04, 0x03, 0x02, 0x30, 0x72, 0x31, 0x0b, 0x30,\\n 0x09, 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02,\\n 0x47, 0x42, 0x31, 0x17, 0x30, 0x15, 0x06, 0x03,\\n 0x55, 0x04, 0x08, 0x13, 0x0e, 0x43, 0x61, 0x6d,\\n 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x73, 0x68,\\n 0x69, 0x72, 0x65, 0x31, 0x12, 0x30, 0x10, 0x06,\\n 0x03, 0x55, 0x04, 0x07, 0x13, 0x09, 0x43, 0x61,\\n 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x31,\\n 0x10, 0x30, 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a,\\n 0x13, 0x07, 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74,\\n 0x64, 0x31, 0x24, 0x30, 0x22, 0x06, 0x03, 0x55,\\n 0x04, 0x03, 0x13, 0x1b, 0x41, 0x52, 0x4d, 0x20,\\n 0x49, 0x6e, 0x74, 0x65, 0x67, 0x72, 0x61, 0x74,\\n 0x69, 0x6f, 0x6e, 0x20, 0x42, 0x6f, 0x6f, 0x74,\\n 0x73, 0x74, 0x72, 0x61, 0x70, 0x43, 0x41, 0x30,\\n 0x20, 0x17, 0x0d, 0x31, 0x37, 0x30, 0x35, 0x31,\\n 0x35, 0x31, 0x39, 0x34, 0x39, 0x31, 0x31, 0x5a,\\n 0x18, 0x0f, 0x32, 0x30, 0x35, 0x32, 0x30, 0x35,\\n 0x31, 0x35, 0x31, 0x39, 0x35, 0x39, 0x31, 0x30,\\n 0x5a, 0x30, 0x72, 0x31, 0x0b, 0x30, 0x09, 0x06,\\n 0x03, 0x55, 0x04, 0x06, 0x13, 0x02, 0x47, 0x42,\\n 0x31, 0x17, 0x30, 0x15, 0x06, 0x03, 0x55, 0x04,\\n 0x08, 0x13, 0x0e, 0x43, 0x61, 0x6d, 0x62, 0x72,\\n 0x69, 0x64, 0x67, 0x65, 0x73, 0x68, 0x69, 0x72,\\n 0x65, 0x31, 0x12, 0x30, 0x10, 0x06, 0x03, 0x55,\\n 0x04, 0x07, 0x13, 0x09, 0x43, 0x61, 0x6d, 0x62,\\n 0x72, 0x69, 0x64, 0x67, 0x65, 0x31, 0x10, 0x30,\\n 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x13, 0x07,\\n 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74, 0x64, 0x31,\\n 0x24, 0x30, 0x22, 0x06, 0x03, 0x55, 0x04, 0x03,\\n 0x13, 0x1b, 0x41, 0x52, 0x4d, 0x20, 0x49, 0x6e,\\n 0x74, 0x65, 0x67, 0x72, 0x61, 0x74, 0x69, 0x6f,\\n 0x6e, 0x20, 0x42, 0x6f, 0x6f, 0x74, 0x73, 0x74,\\n 0x72, 0x61, 0x70, 0x43, 0x41, 0x30, 0x59, 0x30,\\n 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce,\\n 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00, 0x04,\\n 0x8b, 0x7c, 0x86, 0xc3, 0x88, 0x54, 0xe6, 0x5f,\\n 0xe0, 0x57, 0x4e, 0x1b, 0xac, 0x29, 0x82, 0xea,\\n 0x7d, 0x91, 0x00, 0x63, 0xa7, 0x4a, 0x05, 0xbc,\\n 0x54, 0xc5, 0x71, 0x27, 0x33, 0x19, 0x1b, 0x2e,\\n 0xfa, 0x41, 0xf8, 0x7a, 0x9a, 0x0c, 0x5d, 0xfc,\\n 0xb3, 0x37, 0x01, 0x99, 0xc5, 0xc9, 0xbe, 0x78,\\n 0x5b, 0x1d, 0xec, 0xb0, 0x1a, 0x1d, 0xdc, 0xe4,\\n 0x6f, 0x57, 0x04, 0xf4, 0x3a, 0xca, 0xa8, 0xd2,\\n 0xa3, 0x51, 0x30, 0x4f, 0x30, 0x0b, 0x06, 0x03,\\n 0x55, 0x1d, 0x0f, 0x04, 0x04, 0x03, 0x02, 0x01,\\n 0x86, 0x30, 0x0f, 0x06, 0x03, 0x55, 0x1d, 0x13,\\n 0x01, 0x01, 0xff, 0x04, 0x05, 0x30, 0x03, 0x01,\\n 0x01, 0xff, 0x30, 0x1d, 0x06, 0x03, 0x55, 0x1d,\\n 0x0e, 0x04, 0x16, 0x04, 0x14, 0x13, 0xef, 0x69,\\n 0xfa, 0x62, 0x3f, 0x00, 0x86, 0xf4, 0x05, 0xb8,\\n 0xb6, 0xe6, 0xb2, 0xf1, 0xdb, 0x69, 0x10, 0xb4,\\n 0x39, 0x30, 0x10, 0x06, 0x09, 0x2b, 0x06, 0x01,\\n 0x04, 0x01, 0x82, 0x37, 0x15, 0x01, 0x04, 0x03,\\n 0x02, 0x01, 0x00, 0x30, 0x0a, 0x06, 0x08, 0x2a,\\n 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03, 0x02, 0x03,\\n 0x48, 0x00, 0x30, 0x45, 0x02, 0x21, 0x00, 0xa2,\\n 0x50, 0x88, 0x0f, 0x55, 0xe8, 0x26, 0x49, 0xe6,\\n 0xf5, 0x71, 0x86, 0x33, 0x29, 0x05, 0x4c, 0xf9,\\n 0xfd, 0x1f, 0x14, 0x98, 0x92, 0x85, 0xd9, 0x5c,\\n 0x48, 0x02, 0x9e, 0xc2, 0x79, 0xa8, 0x59, 0x02,\\n 0x20, 0x3e, 0xfe, 0x3c, 0xa0, 0xbf, 0xd3, 0x0f,\\n 0x15, 0x83, 0x56, 0xbc, 0xf2, 0xfa, 0x16, 0x26,\\n 0x7a, 0xc1, 0x68, 0xaa, 0xbc, 0x91, 0x3c, 0x69,\\n 0x44, 0x36, 0xf9, 0x74, 0xa1, 0x82, 0x76, 0x7a,\\n 0x6e };\\n\\nconst uint8_t MBED_CLOUD_DEV_LWM2M_SERVER_ROOT_CA_CERTIFICATE[] = \\n{ 0x30, 0x82, 0x02, 0x30, 0x30, 0x82, 0x01, 0xd5,\\n 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x10, 0x26,\\n 0xf9, 0x08, 0xfc, 0xf1, 0xc0, 0x46, 0xa4, 0x4a,\\n 0x4d, 0x2c, 0xf1, 0x94, 0x27, 0xf9, 0x1f, 0x30,\\n 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x04, 0x03, 0x02, 0x30, 0x6f, 0x31, 0x0b, 0x30,\\n 0x09, 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02,\\n 0x47, 0x42, 0x31, 0x17, 0x30, 0x15, 0x06, 0x03,\\n 0x55, 0x04, 0x08, 0x13, 0x0e, 0x43, 0x61, 0x6d,\\n 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x73, 0x68,\\n 0x69, 0x72, 0x65, 0x31, 0x12, 0x30, 0x10, 0x06,\\n 0x03, 0x55, 0x04, 0x07, 0x13, 0x09, 0x43, 0x61,\\n 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x31,\\n 0x10, 0x30, 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a,\\n 0x13, 0x07, 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74,\\n 0x64, 0x31, 0x21, 0x30, 0x1f, 0x06, 0x03, 0x55,\\n 0x04, 0x03, 0x13, 0x18, 0x41, 0x52, 0x4d, 0x20,\\n 0x49, 0x6e, 0x74, 0x65, 0x67, 0x72, 0x61, 0x74,\\n 0x69, 0x6f, 0x6e, 0x20, 0x4c, 0x57, 0x4d, 0x32,\\n 0x4d, 0x20, 0x43, 0x41, 0x30, 0x20, 0x17, 0x0d,\\n 0x31, 0x37, 0x30, 0x32, 0x31, 0x32, 0x31, 0x30,\\n 0x33, 0x37, 0x35, 0x32, 0x5a, 0x18, 0x0f, 0x32,\\n 0x30, 0x35, 0x32, 0x30, 0x32, 0x31, 0x32, 0x31,\\n 0x30, 0x34, 0x37, 0x35, 0x32, 0x5a, 0x30, 0x6f,\\n 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04,\\n 0x06, 0x13, 0x02, 0x47, 0x42, 0x31, 0x17, 0x30,\\n 0x15, 0x06, 0x03, 0x55, 0x04, 0x08, 0x13, 0x0e,\\n 0x43, 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67,\\n 0x65, 0x73, 0x68, 0x69, 0x72, 0x65, 0x31, 0x12,\\n 0x30, 0x10, 0x06, 0x03, 0x55, 0x04, 0x07, 0x13,\\n 0x09, 0x43, 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64,\\n 0x67, 0x65, 0x31, 0x10, 0x30, 0x0e, 0x06, 0x03,\\n 0x55, 0x04, 0x0a, 0x13, 0x07, 0x41, 0x52, 0x4d,\\n 0x20, 0x4c, 0x74, 0x64, 0x31, 0x21, 0x30, 0x1f,\\n 0x06, 0x03, 0x55, 0x04, 0x03, 0x13, 0x18, 0x41,\\n 0x52, 0x4d, 0x20, 0x49, 0x6e, 0x74, 0x65, 0x67,\\n 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x20, 0x4c,\\n 0x57, 0x4d, 0x32, 0x4d, 0x20, 0x43, 0x41, 0x30,\\n 0x59, 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48,\\n 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86,\\n 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42,\\n 0x00, 0x04, 0xba, 0xea, 0x80, 0x01, 0x2d, 0xf0,\\n 0xe1, 0xb6, 0xc5, 0x5f, 0xf9, 0x76, 0x84, 0x31,\\n 0xa9, 0x29, 0xa1, 0xc7, 0xa8, 0xfd, 0xa0, 0xad,\\n 0xd9, 0x94, 0xe7, 0xec, 0x5a, 0x33, 0xa1, 0x2c,\\n 0x8e, 0x36, 0x43, 0x9b, 0x18, 0xdf, 0xce, 0x71,\\n 0x14, 0x24, 0xb1, 0xfb, 0x16, 0x34, 0x0e, 0x43,\\n 0xfc, 0x23, 0x77, 0xd4, 0x13, 0xd7, 0x11, 0xaa,\\n 0x39, 0x60, 0xab, 0xa2, 0xdf, 0x24, 0xb3, 0xeb,\\n 0xa0, 0xc5, 0xa3, 0x51, 0x30, 0x4f, 0x30, 0x0b,\\n 0x06, 0x03, 0x55, 0x1d, 0x0f, 0x04, 0x04, 0x03,\\n 0x02, 0x01, 0x86, 0x30, 0x0f, 0x06, 0x03, 0x55,\\n 0x1d, 0x13, 0x01, 0x01, 0xff, 0x04, 0x05, 0x30,\\n 0x03, 0x01, 0x01, 0xff, 0x30, 0x1d, 0x06, 0x03,\\n 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0x7b,\\n 0xa1, 0xa5, 0x94, 0xa5, 0xe5, 0x8f, 0x95, 0x5d,\\n 0xd4, 0xce, 0xdc, 0x0f, 0x8a, 0xbe, 0xad, 0x9a,\\n 0x6b, 0x66, 0x3e, 0x30, 0x10, 0x06, 0x09, 0x2b,\\n 0x06, 0x01, 0x04, 0x01, 0x82, 0x37, 0x15, 0x01,\\n 0x04, 0x03, 0x02, 0x01, 0x00, 0x30, 0x0a, 0x06,\\n 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03,\\n 0x02, 0x03, 0x49, 0x00, 0x30, 0x46, 0x02, 0x21,\\n 0x00, 0xd2, 0x06, 0x28, 0xc5, 0x31, 0x3a, 0x11,\\n 0x8d, 0xb6, 0xcb, 0x2b, 0x3f, 0xdd, 0x2a, 0x9a,\\n 0x13, 0x30, 0x52, 0x77, 0xaa, 0xda, 0xda, 0xcb,\\n 0xce, 0xb9, 0x5c, 0xe4, 0x32, 0x1c, 0x02, 0xfa,\\n 0x30, 0x02, 0x21, 0x00, 0xb3, 0x82, 0x24, 0xa2,\\n 0xb1, 0x67, 0x6b, 0x69, 0x07, 0x0e, 0xcd, 0x77,\\n 0x74, 0x99, 0x06, 0x9c, 0x59, 0xb2, 0x00, 0xc0,\\n 0xb3, 0xbb, 0x37, 0x5b, 0xc0, 0x1b, 0xfb, 0xd9,\\n 0x70, 0x98, 0xb9, 0x1e };\\n\\nconst uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY[] = \\n{ 0x30, 0x81, 0x93, 0x02, 0x01, 0x00, 0x30, 0x13,\\n 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02,\\n 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x03, 0x01, 0x07, 0x04, 0x79, 0x30, 0x77, 0x02,\\n 0x01, 0x01, 0x04, 0x20, 0x78, 0xa7, 0x3d, 0xed,\\n 0xa0, 0xb5, 0x67, 0x86, 0xa7, 0x89, 0x75, 0x46,\\n 0x8c, 0xd4, 0xaf, 0xbd, 0x7c, 0x36, 0x86, 0x5e,\\n 0xb3, 0xc0, 0x00, 0x98, 0x22, 0xcf, 0x3c, 0x38,\\n 0xa4, 0x31, 0xeb, 0x51, 0xa0, 0x0a, 0x06, 0x08,\\n 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07,\\n 0xa1, 0x44, 0x03, 0x42, 0x00, 0x04, 0x44, 0x9c,\\n 0x2c, 0x36, 0xce, 0x5e, 0xf3, 0x9b, 0xf7, 0x4d,\\n 0xc0, 0x62, 0x52, 0x3d, 0xa3, 0x0f, 0x04, 0xe2,\\n 0x16, 0xcb, 0x48, 0x72, 0x4f, 0xb7, 0x91, 0x36,\\n 0x04, 0xee, 0x10, 0xe1, 0xb1, 0xce, 0xa6, 0xe5,\\n 0x87, 0xd8, 0xe8, 0x7a, 0x3f, 0xe0, 0x83, 0x3e,\\n 0xd7, 0xbd, 0xa4, 0x0b, 0xf7, 0x13, 0xa8, 0x3d,\\n 0xd1, 0x79, 0x3f, 0x65, 0xc6, 0x69, 0x43, 0xec,\\n 0x41, 0x3b, 0xaa, 0x9c, 0x8b, 0xf6 };\\n\\nconst char MBED_CLOUD_DEV_MANUFACTURER[] = \\\"dev_manufacturer\\\";\\n\\nconst char MBED_CLOUD_DEV_MODEL_NUMBER[] = \\\"dev_model_num\\\";\\n\\nconst char MBED_CLOUD_DEV_SERIAL_NUMBER[] = \\\"0\\\";\\n\\nconst char MBED_CLOUD_DEV_DEVICE_TYPE[] = \\\"dev_device_type\\\";\\n\\nconst char MBED_CLOUD_DEV_HARDWARE_VERSION[] = \\\"dev_hardware_version\\\";\\n\\nconst uint32_t MBED_CLOUD_DEV_MEMORY_TOTAL_KB = 0;\\n\\nconst uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE);\\nconst uint32_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE);\\nconst uint32_t MBED_CLOUD_DEV_LWM2M_SERVER_ROOT_CA_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_LWM2M_SERVER_ROOT_CA_CERTIFICATE);\\nconst uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY);\\n\\n#endif //__MBED_CLOUD_DEV_CREDENTIALS_H__\\n"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Developer certificate created successfully. | DeveloperCertificateResponseData |
400 | Bad request. | ErrorResponse |
401 | The provided access token is not valid. | ErrorResponse |
403 | The maximum number of developer certificates for the given account has already been reached. | ErrorResponse |
409 | Certificate with the given name already exists. | ErrorResponse |
This REST API is intended to be used by customers to fetch an existing developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server).
Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/developer-certificates/THE_CERTIFICATE_ID" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"
Path parameters
Return type
Example data
{
"object" : "trusted-cert",
"id" : "015fee4431fd38c98640fbfb00000000",
"etag" : "1",
"created_at" : "2017-12-11T14:22:20.009Z",
"account_id" : "015fee5d9b3538c98640fbfb00000000",
"name" : "DeveloperCertificate",
"description" : "This certificate will be used with multiple developer devices",
"developer_certificate" : "-----BEGIN CERTIFICATE-----\\nMIICcDCCAhWgAwIBAgIRAPSBbBtLUE/ekQcWE4GzPJEwCgYIKoZIzj0EAwIwgaIx\\nCzAJBgNVBAYTAkdCMRcwFQYDVQQIDA5DYW1icmlkZ2VzaGlyZTESMBAGA1UEBwwJ\\nQ2FtYnJpZGdlMRAwDgYDVQQKDAdBUk0gTHRkMSkwJwYDVQQLDCAwMTU4NDNlMzJl\\nYzkwMjQyMGEwMTVlMDcwMDAwMDAwMDEpMCcGA1UEAwwgMDE2MWRiYmNkZDY2MGE1\\nODBhMDEwYzM0MDNjMDAwMDAwHhcNMTgwMjI4MDkyNzIzWhcNMjgwMjI4MDkyNzIz\\nWjCBojELMAkGA1UEBhMCR0IxFzAVBgNVBAgMDkNhbWJyaWRnZXNoaXJlMRIwEAYD\\nVQQHDAlDYW1icmlkZ2UxEDAOBgNVBAoMB0FSTSBMdGQxKTAnBgNVBAsMIDAxNTg0\\nM2UzMmVjOTAyNDIwYTAxNWUwNzAwMDAwMDAwMSkwJwYDVQQDDCAwMTYxZGJiY2Rk\\nNjYwYTU4MGEwMTBjMzQwM2MwMDAwMDBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IA\\nBEScLDbOXvOb903AYlI9ow8E4hbLSHJPt5E2BO4Q4bHOpuWH2Oh6P+CDPte9pAv3\\nE6g90Xk/ZcZpQ+xBO6qci/ajKjAoMBIGCSsGAQQBoCCBSQQFAgNAAJEwEgYDVR0T\\nAQH/BAgwBgEB/wIBADAKBggqhkjOPQQDAgNJADBGAiEAsi9zSK8Njl22GoEHrsg8\\nQlwFnrkkP9d6FyLFtmqndt4CIQCmVHwisYNcCkqD2SWctG1xQHo0HZePAQW8PstM\\nzhNupQ==\\n-----END CERTIFICATE-----\\n",
"developer_private_key" : "-----BEGIN PRIVATE KEY-----\\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgeKc97aC1Z4aniXVG\\njNSvvXw2hl6zwACYIs88OKQx61GgCgYIKoZIzj0DAQehRANCAAREnCw2zl7zm/dN\\nwGJSPaMPBOIWy0hyT7eRNgTuEOGxzqblh9joej/ggz7XvaQL9xOoPdF5P2XGaUPs\\nQTuqnIv2\\n-----END PRIVATE KEY-----\\n",
"security_file_content" : "/*\\n * Copyright (c) 2017 ARM Limited. All rights reserved.\\n * SPDX-License-Identifier: Apache-2.0\\n * Licensed under the Apache License, Version 2.0 (the License); you may\\n * not use this file except in compliance with the License.\\n * You may obtain a copy of the License at\\n *\\n * http://www.apache.org/licenses/LICENSE-2.0\\n *\\n * Unless required by applicable law or agreed to in writing, software\\n * distributed under the License is distributed on an AS IS BASIS, WITHOUT\\n * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n * See the License for the specific language governing permissions and\\n * limitations under the License.\\n */\\n#ifndef __MBED_CLOUD_DEV_CREDENTIALS_H__\\n#define __MBED_CLOUD_DEV_CREDENTIALS_H__\\n\\n#include \\n\\nconst char MBED_CLOUD_DEV_BOOTSTRAP_ENDPOINT_NAME[] = \\\"0161dbbcdd660a580a010c3403c00000\\\";\\nconst char MBED_CLOUD_DEV_ACCOUNT_ID[] = \\\"015843e32ec902420a015e0700000000\\\";\\nconst char MBED_CLOUD_DEV_BOOTSTRAP_SERVER_URI[] = \\\"coaps://coap.us-east-1.mbedcloud.com:5684?aid=015843e32ec902420a015e0700000000\\\";\\n\\nconst uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE[] = \\n{ 0x30, 0x82, 0x02, 0x70, 0x30, 0x82, 0x02, 0x15,\\n 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x11, 0x00,\\n 0xf4, 0x81, 0x6c, 0x1b, 0x4b, 0x50, 0x4f, 0xde,\\n 0x91, 0x07, 0x16, 0x13, 0x81, 0xb3, 0x3c, 0x91,\\n 0x30, 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce,\\n 0x3d, 0x04, 0x03, 0x02, 0x30, 0x81, 0xa2, 0x31,\\n 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x06,\\n 0x13, 0x02, 0x47, 0x42, 0x31, 0x17, 0x30, 0x15,\\n 0x06, 0x03, 0x55, 0x04, 0x08, 0x0c, 0x0e, 0x43,\\n 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67, 0x65,\\n 0x73, 0x68, 0x69, 0x72, 0x65, 0x31, 0x12, 0x30,\\n 0x10, 0x06, 0x03, 0x55, 0x04, 0x07, 0x0c, 0x09,\\n 0x43, 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67,\\n 0x65, 0x31, 0x10, 0x30, 0x0e, 0x06, 0x03, 0x55,\\n 0x04, 0x0a, 0x0c, 0x07, 0x41, 0x52, 0x4d, 0x20,\\n 0x4c, 0x74, 0x64, 0x31, 0x29, 0x30, 0x27, 0x06,\\n 0x03, 0x55, 0x04, 0x0b, 0x0c, 0x20, 0x30, 0x31,\\n 0x35, 0x38, 0x34, 0x33, 0x65, 0x33, 0x32, 0x65,\\n 0x63, 0x39, 0x30, 0x32, 0x34, 0x32, 0x30, 0x61,\\n 0x30, 0x31, 0x35, 0x65, 0x30, 0x37, 0x30, 0x30,\\n 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x31, 0x29,\\n 0x30, 0x27, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c,\\n 0x20, 0x30, 0x31, 0x36, 0x31, 0x64, 0x62, 0x62,\\n 0x63, 0x64, 0x64, 0x36, 0x36, 0x30, 0x61, 0x35,\\n 0x38, 0x30, 0x61, 0x30, 0x31, 0x30, 0x63, 0x33,\\n 0x34, 0x30, 0x33, 0x63, 0x30, 0x30, 0x30, 0x30,\\n 0x30, 0x30, 0x1e, 0x17, 0x0d, 0x31, 0x38, 0x30,\\n 0x32, 0x32, 0x38, 0x30, 0x39, 0x32, 0x37, 0x32,\\n 0x33, 0x5a, 0x17, 0x0d, 0x32, 0x38, 0x30, 0x32,\\n 0x32, 0x38, 0x30, 0x39, 0x32, 0x37, 0x32, 0x33,\\n 0x5a, 0x30, 0x81, 0xa2, 0x31, 0x0b, 0x30, 0x09,\\n 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02, 0x47,\\n 0x42, 0x31, 0x17, 0x30, 0x15, 0x06, 0x03, 0x55,\\n 0x04, 0x08, 0x0c, 0x0e, 0x43, 0x61, 0x6d, 0x62,\\n 0x72, 0x69, 0x64, 0x67, 0x65, 0x73, 0x68, 0x69,\\n 0x72, 0x65, 0x31, 0x12, 0x30, 0x10, 0x06, 0x03,\\n 0x55, 0x04, 0x07, 0x0c, 0x09, 0x43, 0x61, 0x6d,\\n 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x31, 0x10,\\n 0x30, 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c,\\n 0x07, 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74, 0x64,\\n 0x31, 0x29, 0x30, 0x27, 0x06, 0x03, 0x55, 0x04,\\n 0x0b, 0x0c, 0x20, 0x30, 0x31, 0x35, 0x38, 0x34,\\n 0x33, 0x65, 0x33, 0x32, 0x65, 0x63, 0x39, 0x30,\\n 0x32, 0x34, 0x32, 0x30, 0x61, 0x30, 0x31, 0x35,\\n 0x65, 0x30, 0x37, 0x30, 0x30, 0x30, 0x30, 0x30,\\n 0x30, 0x30, 0x30, 0x31, 0x29, 0x30, 0x27, 0x06,\\n 0x03, 0x55, 0x04, 0x03, 0x0c, 0x20, 0x30, 0x31,\\n 0x36, 0x31, 0x64, 0x62, 0x62, 0x63, 0x64, 0x64,\\n 0x36, 0x36, 0x30, 0x61, 0x35, 0x38, 0x30, 0x61,\\n 0x30, 0x31, 0x30, 0x63, 0x33, 0x34, 0x30, 0x33,\\n 0x63, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x59,\\n 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce,\\n 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48,\\n 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00,\\n 0x04, 0x44, 0x9c, 0x2c, 0x36, 0xce, 0x5e, 0xf3,\\n 0x9b, 0xf7, 0x4d, 0xc0, 0x62, 0x52, 0x3d, 0xa3,\\n 0x0f, 0x04, 0xe2, 0x16, 0xcb, 0x48, 0x72, 0x4f,\\n 0xb7, 0x91, 0x36, 0x04, 0xee, 0x10, 0xe1, 0xb1,\\n 0xce, 0xa6, 0xe5, 0x87, 0xd8, 0xe8, 0x7a, 0x3f,\\n 0xe0, 0x83, 0x3e, 0xd7, 0xbd, 0xa4, 0x0b, 0xf7,\\n 0x13, 0xa8, 0x3d, 0xd1, 0x79, 0x3f, 0x65, 0xc6,\\n 0x69, 0x43, 0xec, 0x41, 0x3b, 0xaa, 0x9c, 0x8b,\\n 0xf6, 0xa3, 0x2a, 0x30, 0x28, 0x30, 0x12, 0x06,\\n 0x09, 0x2b, 0x06, 0x01, 0x04, 0x01, 0xa0, 0x20,\\n 0x81, 0x49, 0x04, 0x05, 0x02, 0x03, 0x40, 0x00,\\n 0x91, 0x30, 0x12, 0x06, 0x03, 0x55, 0x1d, 0x13,\\n 0x01, 0x01, 0xff, 0x04, 0x08, 0x30, 0x06, 0x01,\\n 0x01, 0xff, 0x02, 0x01, 0x00, 0x30, 0x0a, 0x06,\\n 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03,\\n 0x02, 0x03, 0x49, 0x00, 0x30, 0x46, 0x02, 0x21,\\n 0x00, 0xb2, 0x2f, 0x73, 0x48, 0xaf, 0x0d, 0x8e,\\n 0x5d, 0xb6, 0x1a, 0x81, 0x07, 0xae, 0xc8, 0x3c,\\n 0x42, 0x5c, 0x05, 0x9e, 0xb9, 0x24, 0x3f, 0xd7,\\n 0x7a, 0x17, 0x22, 0xc5, 0xb6, 0x6a, 0xa7, 0x76,\\n 0xde, 0x02, 0x21, 0x00, 0xa6, 0x54, 0x7c, 0x22,\\n 0xb1, 0x83, 0x5c, 0x0a, 0x4a, 0x83, 0xd9, 0x25,\\n 0x9c, 0xb4, 0x6d, 0x71, 0x40, 0x7a, 0x34, 0x1d,\\n 0x97, 0x8f, 0x01, 0x05, 0xbc, 0x3e, 0xcb, 0x4c,\\n 0xce, 0x13, 0x6e, 0xa5 };\\n\\nconst uint8_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE[] = \\n{ 0x30, 0x82, 0x02, 0x35, 0x30, 0x82, 0x01, 0xdb,\\n 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x10, 0x5c,\\n 0x27, 0xa5, 0x76, 0x7d, 0x58, 0x85, 0x8a, 0x43,\\n 0x91, 0xa0, 0x61, 0xab, 0xcf, 0xa6, 0x59, 0x30,\\n 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x04, 0x03, 0x02, 0x30, 0x72, 0x31, 0x0b, 0x30,\\n 0x09, 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02,\\n 0x47, 0x42, 0x31, 0x17, 0x30, 0x15, 0x06, 0x03,\\n 0x55, 0x04, 0x08, 0x13, 0x0e, 0x43, 0x61, 0x6d,\\n 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x73, 0x68,\\n 0x69, 0x72, 0x65, 0x31, 0x12, 0x30, 0x10, 0x06,\\n 0x03, 0x55, 0x04, 0x07, 0x13, 0x09, 0x43, 0x61,\\n 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x31,\\n 0x10, 0x30, 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a,\\n 0x13, 0x07, 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74,\\n 0x64, 0x31, 0x24, 0x30, 0x22, 0x06, 0x03, 0x55,\\n 0x04, 0x03, 0x13, 0x1b, 0x41, 0x52, 0x4d, 0x20,\\n 0x49, 0x6e, 0x74, 0x65, 0x67, 0x72, 0x61, 0x74,\\n 0x69, 0x6f, 0x6e, 0x20, 0x42, 0x6f, 0x6f, 0x74,\\n 0x73, 0x74, 0x72, 0x61, 0x70, 0x43, 0x41, 0x30,\\n 0x20, 0x17, 0x0d, 0x31, 0x37, 0x30, 0x35, 0x31,\\n 0x35, 0x31, 0x39, 0x34, 0x39, 0x31, 0x31, 0x5a,\\n 0x18, 0x0f, 0x32, 0x30, 0x35, 0x32, 0x30, 0x35,\\n 0x31, 0x35, 0x31, 0x39, 0x35, 0x39, 0x31, 0x30,\\n 0x5a, 0x30, 0x72, 0x31, 0x0b, 0x30, 0x09, 0x06,\\n 0x03, 0x55, 0x04, 0x06, 0x13, 0x02, 0x47, 0x42,\\n 0x31, 0x17, 0x30, 0x15, 0x06, 0x03, 0x55, 0x04,\\n 0x08, 0x13, 0x0e, 0x43, 0x61, 0x6d, 0x62, 0x72,\\n 0x69, 0x64, 0x67, 0x65, 0x73, 0x68, 0x69, 0x72,\\n 0x65, 0x31, 0x12, 0x30, 0x10, 0x06, 0x03, 0x55,\\n 0x04, 0x07, 0x13, 0x09, 0x43, 0x61, 0x6d, 0x62,\\n 0x72, 0x69, 0x64, 0x67, 0x65, 0x31, 0x10, 0x30,\\n 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x13, 0x07,\\n 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74, 0x64, 0x31,\\n 0x24, 0x30, 0x22, 0x06, 0x03, 0x55, 0x04, 0x03,\\n 0x13, 0x1b, 0x41, 0x52, 0x4d, 0x20, 0x49, 0x6e,\\n 0x74, 0x65, 0x67, 0x72, 0x61, 0x74, 0x69, 0x6f,\\n 0x6e, 0x20, 0x42, 0x6f, 0x6f, 0x74, 0x73, 0x74,\\n 0x72, 0x61, 0x70, 0x43, 0x41, 0x30, 0x59, 0x30,\\n 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce,\\n 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00, 0x04,\\n 0x8b, 0x7c, 0x86, 0xc3, 0x88, 0x54, 0xe6, 0x5f,\\n 0xe0, 0x57, 0x4e, 0x1b, 0xac, 0x29, 0x82, 0xea,\\n 0x7d, 0x91, 0x00, 0x63, 0xa7, 0x4a, 0x05, 0xbc,\\n 0x54, 0xc5, 0x71, 0x27, 0x33, 0x19, 0x1b, 0x2e,\\n 0xfa, 0x41, 0xf8, 0x7a, 0x9a, 0x0c, 0x5d, 0xfc,\\n 0xb3, 0x37, 0x01, 0x99, 0xc5, 0xc9, 0xbe, 0x78,\\n 0x5b, 0x1d, 0xec, 0xb0, 0x1a, 0x1d, 0xdc, 0xe4,\\n 0x6f, 0x57, 0x04, 0xf4, 0x3a, 0xca, 0xa8, 0xd2,\\n 0xa3, 0x51, 0x30, 0x4f, 0x30, 0x0b, 0x06, 0x03,\\n 0x55, 0x1d, 0x0f, 0x04, 0x04, 0x03, 0x02, 0x01,\\n 0x86, 0x30, 0x0f, 0x06, 0x03, 0x55, 0x1d, 0x13,\\n 0x01, 0x01, 0xff, 0x04, 0x05, 0x30, 0x03, 0x01,\\n 0x01, 0xff, 0x30, 0x1d, 0x06, 0x03, 0x55, 0x1d,\\n 0x0e, 0x04, 0x16, 0x04, 0x14, 0x13, 0xef, 0x69,\\n 0xfa, 0x62, 0x3f, 0x00, 0x86, 0xf4, 0x05, 0xb8,\\n 0xb6, 0xe6, 0xb2, 0xf1, 0xdb, 0x69, 0x10, 0xb4,\\n 0x39, 0x30, 0x10, 0x06, 0x09, 0x2b, 0x06, 0x01,\\n 0x04, 0x01, 0x82, 0x37, 0x15, 0x01, 0x04, 0x03,\\n 0x02, 0x01, 0x00, 0x30, 0x0a, 0x06, 0x08, 0x2a,\\n 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03, 0x02, 0x03,\\n 0x48, 0x00, 0x30, 0x45, 0x02, 0x21, 0x00, 0xa2,\\n 0x50, 0x88, 0x0f, 0x55, 0xe8, 0x26, 0x49, 0xe6,\\n 0xf5, 0x71, 0x86, 0x33, 0x29, 0x05, 0x4c, 0xf9,\\n 0xfd, 0x1f, 0x14, 0x98, 0x92, 0x85, 0xd9, 0x5c,\\n 0x48, 0x02, 0x9e, 0xc2, 0x79, 0xa8, 0x59, 0x02,\\n 0x20, 0x3e, 0xfe, 0x3c, 0xa0, 0xbf, 0xd3, 0x0f,\\n 0x15, 0x83, 0x56, 0xbc, 0xf2, 0xfa, 0x16, 0x26,\\n 0x7a, 0xc1, 0x68, 0xaa, 0xbc, 0x91, 0x3c, 0x69,\\n 0x44, 0x36, 0xf9, 0x74, 0xa1, 0x82, 0x76, 0x7a,\\n 0x6e };\\n\\nconst uint8_t MBED_CLOUD_DEV_LWM2M_SERVER_ROOT_CA_CERTIFICATE[] = \\n{ 0x30, 0x82, 0x02, 0x30, 0x30, 0x82, 0x01, 0xd5,\\n 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x10, 0x26,\\n 0xf9, 0x08, 0xfc, 0xf1, 0xc0, 0x46, 0xa4, 0x4a,\\n 0x4d, 0x2c, 0xf1, 0x94, 0x27, 0xf9, 0x1f, 0x30,\\n 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x04, 0x03, 0x02, 0x30, 0x6f, 0x31, 0x0b, 0x30,\\n 0x09, 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02,\\n 0x47, 0x42, 0x31, 0x17, 0x30, 0x15, 0x06, 0x03,\\n 0x55, 0x04, 0x08, 0x13, 0x0e, 0x43, 0x61, 0x6d,\\n 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x73, 0x68,\\n 0x69, 0x72, 0x65, 0x31, 0x12, 0x30, 0x10, 0x06,\\n 0x03, 0x55, 0x04, 0x07, 0x13, 0x09, 0x43, 0x61,\\n 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67, 0x65, 0x31,\\n 0x10, 0x30, 0x0e, 0x06, 0x03, 0x55, 0x04, 0x0a,\\n 0x13, 0x07, 0x41, 0x52, 0x4d, 0x20, 0x4c, 0x74,\\n 0x64, 0x31, 0x21, 0x30, 0x1f, 0x06, 0x03, 0x55,\\n 0x04, 0x03, 0x13, 0x18, 0x41, 0x52, 0x4d, 0x20,\\n 0x49, 0x6e, 0x74, 0x65, 0x67, 0x72, 0x61, 0x74,\\n 0x69, 0x6f, 0x6e, 0x20, 0x4c, 0x57, 0x4d, 0x32,\\n 0x4d, 0x20, 0x43, 0x41, 0x30, 0x20, 0x17, 0x0d,\\n 0x31, 0x37, 0x30, 0x32, 0x31, 0x32, 0x31, 0x30,\\n 0x33, 0x37, 0x35, 0x32, 0x5a, 0x18, 0x0f, 0x32,\\n 0x30, 0x35, 0x32, 0x30, 0x32, 0x31, 0x32, 0x31,\\n 0x30, 0x34, 0x37, 0x35, 0x32, 0x5a, 0x30, 0x6f,\\n 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04,\\n 0x06, 0x13, 0x02, 0x47, 0x42, 0x31, 0x17, 0x30,\\n 0x15, 0x06, 0x03, 0x55, 0x04, 0x08, 0x13, 0x0e,\\n 0x43, 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64, 0x67,\\n 0x65, 0x73, 0x68, 0x69, 0x72, 0x65, 0x31, 0x12,\\n 0x30, 0x10, 0x06, 0x03, 0x55, 0x04, 0x07, 0x13,\\n 0x09, 0x43, 0x61, 0x6d, 0x62, 0x72, 0x69, 0x64,\\n 0x67, 0x65, 0x31, 0x10, 0x30, 0x0e, 0x06, 0x03,\\n 0x55, 0x04, 0x0a, 0x13, 0x07, 0x41, 0x52, 0x4d,\\n 0x20, 0x4c, 0x74, 0x64, 0x31, 0x21, 0x30, 0x1f,\\n 0x06, 0x03, 0x55, 0x04, 0x03, 0x13, 0x18, 0x41,\\n 0x52, 0x4d, 0x20, 0x49, 0x6e, 0x74, 0x65, 0x67,\\n 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x20, 0x4c,\\n 0x57, 0x4d, 0x32, 0x4d, 0x20, 0x43, 0x41, 0x30,\\n 0x59, 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48,\\n 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86,\\n 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42,\\n 0x00, 0x04, 0xba, 0xea, 0x80, 0x01, 0x2d, 0xf0,\\n 0xe1, 0xb6, 0xc5, 0x5f, 0xf9, 0x76, 0x84, 0x31,\\n 0xa9, 0x29, 0xa1, 0xc7, 0xa8, 0xfd, 0xa0, 0xad,\\n 0xd9, 0x94, 0xe7, 0xec, 0x5a, 0x33, 0xa1, 0x2c,\\n 0x8e, 0x36, 0x43, 0x9b, 0x18, 0xdf, 0xce, 0x71,\\n 0x14, 0x24, 0xb1, 0xfb, 0x16, 0x34, 0x0e, 0x43,\\n 0xfc, 0x23, 0x77, 0xd4, 0x13, 0xd7, 0x11, 0xaa,\\n 0x39, 0x60, 0xab, 0xa2, 0xdf, 0x24, 0xb3, 0xeb,\\n 0xa0, 0xc5, 0xa3, 0x51, 0x30, 0x4f, 0x30, 0x0b,\\n 0x06, 0x03, 0x55, 0x1d, 0x0f, 0x04, 0x04, 0x03,\\n 0x02, 0x01, 0x86, 0x30, 0x0f, 0x06, 0x03, 0x55,\\n 0x1d, 0x13, 0x01, 0x01, 0xff, 0x04, 0x05, 0x30,\\n 0x03, 0x01, 0x01, 0xff, 0x30, 0x1d, 0x06, 0x03,\\n 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0x7b,\\n 0xa1, 0xa5, 0x94, 0xa5, 0xe5, 0x8f, 0x95, 0x5d,\\n 0xd4, 0xce, 0xdc, 0x0f, 0x8a, 0xbe, 0xad, 0x9a,\\n 0x6b, 0x66, 0x3e, 0x30, 0x10, 0x06, 0x09, 0x2b,\\n 0x06, 0x01, 0x04, 0x01, 0x82, 0x37, 0x15, 0x01,\\n 0x04, 0x03, 0x02, 0x01, 0x00, 0x30, 0x0a, 0x06,\\n 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03,\\n 0x02, 0x03, 0x49, 0x00, 0x30, 0x46, 0x02, 0x21,\\n 0x00, 0xd2, 0x06, 0x28, 0xc5, 0x31, 0x3a, 0x11,\\n 0x8d, 0xb6, 0xcb, 0x2b, 0x3f, 0xdd, 0x2a, 0x9a,\\n 0x13, 0x30, 0x52, 0x77, 0xaa, 0xda, 0xda, 0xcb,\\n 0xce, 0xb9, 0x5c, 0xe4, 0x32, 0x1c, 0x02, 0xfa,\\n 0x30, 0x02, 0x21, 0x00, 0xb3, 0x82, 0x24, 0xa2,\\n 0xb1, 0x67, 0x6b, 0x69, 0x07, 0x0e, 0xcd, 0x77,\\n 0x74, 0x99, 0x06, 0x9c, 0x59, 0xb2, 0x00, 0xc0,\\n 0xb3, 0xbb, 0x37, 0x5b, 0xc0, 0x1b, 0xfb, 0xd9,\\n 0x70, 0x98, 0xb9, 0x1e };\\n\\nconst uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY[] = \\n{ 0x30, 0x81, 0x93, 0x02, 0x01, 0x00, 0x30, 0x13,\\n 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02,\\n 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,\\n 0x03, 0x01, 0x07, 0x04, 0x79, 0x30, 0x77, 0x02,\\n 0x01, 0x01, 0x04, 0x20, 0x78, 0xa7, 0x3d, 0xed,\\n 0xa0, 0xb5, 0x67, 0x86, 0xa7, 0x89, 0x75, 0x46,\\n 0x8c, 0xd4, 0xaf, 0xbd, 0x7c, 0x36, 0x86, 0x5e,\\n 0xb3, 0xc0, 0x00, 0x98, 0x22, 0xcf, 0x3c, 0x38,\\n 0xa4, 0x31, 0xeb, 0x51, 0xa0, 0x0a, 0x06, 0x08,\\n 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07,\\n 0xa1, 0x44, 0x03, 0x42, 0x00, 0x04, 0x44, 0x9c,\\n 0x2c, 0x36, 0xce, 0x5e, 0xf3, 0x9b, 0xf7, 0x4d,\\n 0xc0, 0x62, 0x52, 0x3d, 0xa3, 0x0f, 0x04, 0xe2,\\n 0x16, 0xcb, 0x48, 0x72, 0x4f, 0xb7, 0x91, 0x36,\\n 0x04, 0xee, 0x10, 0xe1, 0xb1, 0xce, 0xa6, 0xe5,\\n 0x87, 0xd8, 0xe8, 0x7a, 0x3f, 0xe0, 0x83, 0x3e,\\n 0xd7, 0xbd, 0xa4, 0x0b, 0xf7, 0x13, 0xa8, 0x3d,\\n 0xd1, 0x79, 0x3f, 0x65, 0xc6, 0x69, 0x43, 0xec,\\n 0x41, 0x3b, 0xaa, 0x9c, 0x8b, 0xf6 };\\n\\nconst char MBED_CLOUD_DEV_MANUFACTURER[] = \\\"dev_manufacturer\\\";\\n\\nconst char MBED_CLOUD_DEV_MODEL_NUMBER[] = \\\"dev_model_num\\\";\\n\\nconst char MBED_CLOUD_DEV_SERIAL_NUMBER[] = \\\"0\\\";\\n\\nconst char MBED_CLOUD_DEV_DEVICE_TYPE[] = \\\"dev_device_type\\\";\\n\\nconst char MBED_CLOUD_DEV_HARDWARE_VERSION[] = \\\"dev_hardware_version\\\";\\n\\nconst uint32_t MBED_CLOUD_DEV_MEMORY_TOTAL_KB = 0;\\n\\nconst uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE);\\nconst uint32_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE);\\nconst uint32_t MBED_CLOUD_DEV_LWM2M_SERVER_ROOT_CA_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_LWM2M_SERVER_ROOT_CA_CERTIFICATE);\\nconst uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY);\\n\\n#endif //__MBED_CLOUD_DEV_CREDENTIALS_H__\\n"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Developer certificate fetched successfully. | DeveloperCertificateResponseData |
400 | Bad request. | ErrorResponse |
401 | The provided access token is not valid. | ErrorResponse |
404 | Developer certificate not found with given id. | ErrorResponse |
SecurityAndIdentityServerCredentials
This REST API is intended to be used by customers to fetch all (Bootstrap and LwM2M) server credentials that they will need to use with their clients to connect to bootstrap or LwM2M server.
Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"
Return type
Example data
{
"lwm2m" : {
"certificate" : "-----BEGIN CERTIFICATE-----\\nMIICMDCCAdWgAwIBAgIQJvkI/PHARqRKTSzxlCf5HzAKBggqhkjOPQQDAjBvMQsw\\nCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNVBAcTCUNh\\nbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEhMB8GA1UEAxMYQVJNIEludGVncmF0\\naW9uIExXTTJNIENBMCAXDTE3MDIxMjEwMzc1MloYDzIwNTIwMjEyMTA0NzUyWjBv\\nMQswCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNVBAcT\\nCUNhbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEhMB8GA1UEAxMYQVJNIEludGVn\\ncmF0aW9uIExXTTJNIENBMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEuuqAAS3w\\n4bbFX/l2hDGpKaHHqP2grdmU5+xaM6EsjjZDmxjfznEUJLH7FjQOQ/wjd9QT1xGq\\nOWCrot8ks+ugxaNRME8wCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHQYD\\nVR0OBBYEFHuhpZSl5Y+VXdTO3A+Kvq2aa2Y+MBAGCSsGAQQBgjcVAQQDAgEAMAoG\\nCCqGSM49BAMCA0kAMEYCIQDSBijFMToRjbbLKz/dKpoTMFJ3qtray865XOQyHAL6\\nMAIhALOCJKKxZ2tpBw7Nd3SZBpxZsgDAs7s3W8Ab+9lwmLke\\n-----END CERTIFICATE-----",
"url" : "coaps://mds.us-east-1.mbedcloud.com:5684?aid=015843e32ec902420a015e0700000000"
},
"bootstrap" : {
"certificate" : "-----BEGIN CERTIFICATE-----\\nMIICNTCCAdugAwIBAgIQXCeldn1YhYpDkaBhq8+mWTAKBggqhkjOPQQDAjByMQsw\\nCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNVBAcTCUNh\\nbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEkMCIGA1UEAxMbQVJNIEludGVncmF0\\naW9uIEJvb3RzdHJhcENBMCAXDTE3MDUxNTE5NDkxMVoYDzIwNTIwNTE1MTk1OTEw\\nWjByMQswCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNV\\nBAcTCUNhbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEkMCIGA1UEAxMbQVJNIElu\\ndGVncmF0aW9uIEJvb3RzdHJhcENBMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE\\ni3yGw4hU5l/gV04brCmC6n2RAGOnSgW8VMVxJzMZGy76Qfh6mgxd/LM3AZnFyb54\\nWx3ssBod3ORvVwT0Osqo0qNRME8wCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMB\\nAf8wHQYDVR0OBBYEFBPvafpiPwCG9AW4tuay8dtpELQ5MBAGCSsGAQQBgjcVAQQD\\nAgEAMAoGCCqGSM49BAMCA0gAMEUCIQCiUIgPVegmSeb1cYYzKQVM+f0fFJiShdlc\\nSAKewnmoWQIgPv48oL/TDxWDVrzy+hYmesFoqryRPGlENvl0oYJ2em4=\\n-----END CERTIFICATE-----",
"url" : "coaps://coap.us-east-1.mbedcloud.com:5684?aid=015843e32ec902420a015e0700000000"
}
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | all server credentials fetched successfully. | AllServerCredentialsResponseData |
400 | Bad request. | ErrorResponse |
401 | The provided access token is not valid. | ErrorResponse |
This REST API is intended to be used by customers to fetch bootstrap server credentials that they will need to use with their clients to connect to bootstrap server.
Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/bootstrap" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"
Return type
Example data
{
"object" : "server-credentials",
"id" : "015fee4431fd38c98640fbfb00000000",
"etag" : "1",
"created_at" : "2017-12-11T14:22:20.009Z",
"server_certificate" : "-----BEGIN CERTIFICATE-----\\nMIICNTCCAdugAwIBAgIQXCeldn1YhYpDkaBhq8+mWTAKBggqhkjOPQQDAjByMQsw\\nCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNVBAcTCUNh\\nbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEkMCIGA1UEAxMbQVJNIEludGVncmF0\\naW9uIEJvb3RzdHJhcENBMCAXDTE3MDUxNTE5NDkxMVoYDzIwNTIwNTE1MTk1OTEw\\nWjByMQswCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNV\\nBAcTCUNhbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEkMCIGA1UEAxMbQVJNIElu\\ndGVncmF0aW9uIEJvb3RzdHJhcENBMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE\\ni3yGw4hU5l/gV04brCmC6n2RAGOnSgW8VMVxJzMZGy76Qfh6mgxd/LM3AZnFyb54\\nWx3ssBod3ORvVwT0Osqo0qNRME8wCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMB\\nAf8wHQYDVR0OBBYEFBPvafpiPwCG9AW4tuay8dtpELQ5MBAGCSsGAQQBgjcVAQQD\\nAgEAMAoGCCqGSM49BAMCA0gAMEUCIQCiUIgPVegmSeb1cYYzKQVM+f0fFJiShdlc\\nSAKewnmoWQIgPv48oL/TDxWDVrzy+hYmesFoqryRPGlENvl0oYJ2em4=\\n-----END CERTIFICATE-----",
"server_uri" : "coaps://coap.us-east-1.mbedcloud.com:5684?aid=015843e32ec902420a015e0700000000"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Bootstrap server credentials fetched successfully. | ServerCredentialsResponseData |
400 | Bad request. | ErrorResponse |
401 | The provided access token is not valid. | ErrorResponse |
This REST API is intended to be used by customers to fetch LwM2M server credentials that they will need to use with their clients to connect to LwM2M server.
Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/lwm2m" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"
Return type
Example data
{
"object" : "server-credentials",
"id" : "015fee4431fd38c98640fbfb00000000",
"etag" : "1",
"created_at" : "2017-12-11T14:22:20.009Z",
"server_certificate" : "-----BEGIN CERTIFICATE-----\\nMIICNTCCAdugAwIBAgIQXCeldn1YhYpDkaBhq8+mWTAKBggqhkjOPQQDAjByMQsw\\nCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNVBAcTCUNh\\nbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEkMCIGA1UEAxMbQVJNIEludGVncmF0\\naW9uIEJvb3RzdHJhcENBMCAXDTE3MDUxNTE5NDkxMVoYDzIwNTIwNTE1MTk1OTEw\\nWjByMQswCQYDVQQGEwJHQjEXMBUGA1UECBMOQ2FtYnJpZGdlc2hpcmUxEjAQBgNV\\nBAcTCUNhbWJyaWRnZTEQMA4GA1UEChMHQVJNIEx0ZDEkMCIGA1UEAxMbQVJNIElu\\ndGVncmF0aW9uIEJvb3RzdHJhcENBMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE\\ni3yGw4hU5l/gV04brCmC6n2RAGOnSgW8VMVxJzMZGy76Qfh6mgxd/LM3AZnFyb54\\nWx3ssBod3ORvVwT0Osqo0qNRME8wCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMB\\nAf8wHQYDVR0OBBYEFBPvafpiPwCG9AW4tuay8dtpELQ5MBAGCSsGAQQBgjcVAQQD\\nAgEAMAoGCCqGSM49BAMCA0gAMEUCIQCiUIgPVegmSeb1cYYzKQVM+f0fFJiShdlc\\nSAKewnmoWQIgPv48oL/TDxWDVrzy+hYmesFoqryRPGlENvl0oYJ2em4=\\n-----END CERTIFICATE-----",
"server_uri" : "coaps://mds.us-east-1.mbedcloud.com:5684?aid=015843e32ec902420a015e0700000000"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | LwM2M server credentials fetched successfully. | ServerCredentialsResponseData |
400 | Bad request. | ErrorResponse |
401 | The provided access token is not valid. | ErrorResponse |
TenantAccountsAPIKeys
Add API key to groups.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or API key with the specified ID does not exist. | ErrorResponse |
409 | The API key is a member of the group already. | ErrorResponse |
Create a new API key. There is no default value for the owner ID, and it must be from the same account where the new API key is created.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"name": "MyKey1"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | ApiKeyInfoResp |
400 | Error in input data, for example, missing display name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the given ID does not exist. | ErrorResponse |
Delete an API key.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or API key with the specified ID does not exist. | ErrorResponse |
Retrieve API key details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or API key with the specified ID does not exist. | ErrorResponse |
Retrieve API keys in an array, optionally filtered by the owner.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the given ID does not exist. | ErrorResponse |
Retrieve groups associated with the API key.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id}/groups \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or API key with the specified ID does not exist. | ErrorResponse |
Remove API key from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or API key with the specified ID does not exist. | ErrorResponse |
Reset the secret key of the API key.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id}/reset-secret \
-H 'Authorization: Bearer <api_key>'
Path parameters
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or API key with the specified ID does not exist. | ErrorResponse |
Update API key details.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/api-keys/{apikey_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"name": "TestApiKey25"}'
Path parameters
Request body
Return type
Example data
{
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoResp |
400 | Error in input data, for example, missing display name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account ID or API key with the specified ID does not exist. | ErrorResponse |
TenantAccountsAccounts
Create a new account.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"display_name": "MyAccount1", "admin_name": "accountAdmin1", "email": "example_admin@myaccount.info", "country": "United Kingdom", "end_market": "Smart City", "address_line1": "110 Fulbourn Rd", "city": "Cambridge", "contact": "J. Doe", "company": "Arm"}'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Query parameters
Action, either create
or enroll
.
- `create` creates the account where its admin user has ACTIVE status if `admin_password` was defined in the request, or RESET status if no `admin_password` was defined. If the user already exists, its status is not modified.
- `enroll` creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish enrollment or notify the existing user about the new account is sent to the `admin_email` defined in the request.
Return type
Example data
{
"country" : "United Kingdom",
"reason" : "Subscription paid.",
"aliases" : [ "aeiou" ],
"city" : "Cambridge",
"customer_number" : "1NC25_0001",
"policies" : [ {
"allow" : true,
"feature" : "update-campaigns",
"resource" : "/v3/update-campaign",
"inherited" : false,
"action" : "GET"
} ],
"sales_contact" : "sales@arm.com",
"created_at" : "2018-02-13T09:35:20Z",
"admin_email" : "admin@arm.com",
"expiration_warning_threshold" : 180,
"updated_at" : "2018-02-14T15:24:14Z",
"address_line2" : " ",
"tier" : "1",
"address_line1" : "110 Fulbourn Rd",
"contract_number" : "1NX25_0001",
"contact" : "J. Doe",
"reference_note" : "ARM-INT-0001",
"company" : "ARM Holdings Plc",
"id" : "01619571e2e90242ac12000600000000",
"state" : " ",
"idle_timeout" : 30,
"email" : "info@arm.com",
"limits" : {
"key" : "aeiou"
},
"upgraded_at" : "2018-02-14T15:24:14Z",
"custom_fields" : {
"key" : "aeiou"
},
"display_name" : "ARM",
"notification_emails" : [ "aeiou" ],
"admin_password" : "PZf9eEUH43DAPE9ULINFeuj",
"password_recovery_expiration" : 4,
"parent_account" : {
"id" : "01619571dad80242ac12000600000000",
"admin_name" : "J. Doe",
"admin_email" : "info@arm.com"
},
"mfa_status" : "enforced",
"admin_full_name" : "Admin Doe",
"password_policy" : {
"minimum_length" : 8
},
"end_market" : "IT",
"parent_id" : "01619571dad80242ac12000600000000",
"sub_accounts" : [ "" ],
"admin_id" : "01619571e2e89242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"template_id" : "01619571e7160242ac12000600000000",
"expiration" : "2000-01-23T04:56:07.000+00:00",
"admin_name" : "admin",
"postal_code" : "CB1 9NJ",
"admin_key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT",
"object" : "account",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Successful operation. | AccountInfo |
400 | Error in input data, for example, invalid username. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve detailed information about an account.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"country" : "United Kingdom",
"reason" : "Subscription paid.",
"aliases" : [ "aeiou" ],
"city" : "Cambridge",
"customer_number" : "1NC25_0001",
"policies" : [ {
"allow" : true,
"feature" : "update-campaigns",
"resource" : "/v3/update-campaign",
"inherited" : false,
"action" : "GET"
} ],
"sales_contact" : "sales@arm.com",
"created_at" : "2018-02-13T09:35:20Z",
"admin_email" : "admin@arm.com",
"expiration_warning_threshold" : 180,
"updated_at" : "2018-02-14T15:24:14Z",
"address_line2" : " ",
"tier" : "1",
"address_line1" : "110 Fulbourn Rd",
"contract_number" : "1NX25_0001",
"contact" : "J. Doe",
"reference_note" : "ARM-INT-0001",
"company" : "ARM Holdings Plc",
"id" : "01619571e2e90242ac12000600000000",
"state" : " ",
"idle_timeout" : 30,
"email" : "info@arm.com",
"limits" : {
"key" : "aeiou"
},
"upgraded_at" : "2018-02-14T15:24:14Z",
"custom_fields" : {
"key" : "aeiou"
},
"display_name" : "ARM",
"notification_emails" : [ "aeiou" ],
"admin_password" : "PZf9eEUH43DAPE9ULINFeuj",
"password_recovery_expiration" : 4,
"parent_account" : {
"id" : "01619571dad80242ac12000600000000",
"admin_name" : "J. Doe",
"admin_email" : "info@arm.com"
},
"mfa_status" : "enforced",
"admin_full_name" : "Admin Doe",
"password_policy" : {
"minimum_length" : 8
},
"end_market" : "IT",
"parent_id" : "01619571dad80242ac12000600000000",
"sub_accounts" : [ "" ],
"admin_id" : "01619571e2e89242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"template_id" : "01619571e7160242ac12000600000000",
"expiration" : "2000-01-23T04:56:07.000+00:00",
"admin_name" : "admin",
"postal_code" : "CB1 9NJ",
"admin_key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT",
"object" : "account",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | AccountInfo |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account with the given ID not found. | ErrorResponse |
Returns an array of account objects, optionally filtered by status and tier level.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts \
-H 'Authorization: Bearer <api_key>'
Query parameters
Return type
Example data
{
"data" : [ {
"country" : "United Kingdom",
"reason" : "Subscription paid.",
"aliases" : [ "aeiou" ],
"city" : "Cambridge",
"customer_number" : "1NC25_0001",
"policies" : [ {
"allow" : true,
"feature" : "update-campaigns",
"resource" : "/v3/update-campaign",
"inherited" : false,
"action" : "GET"
} ],
"sales_contact" : "sales@arm.com",
"created_at" : "2018-02-13T09:35:20Z",
"admin_email" : "admin@arm.com",
"expiration_warning_threshold" : 180,
"updated_at" : "2018-02-14T15:24:14Z",
"address_line2" : " ",
"tier" : "1",
"address_line1" : "110 Fulbourn Rd",
"contract_number" : "1NX25_0001",
"contact" : "J. Doe",
"reference_note" : "ARM-INT-0001",
"company" : "ARM Holdings Plc",
"id" : "01619571e2e90242ac12000600000000",
"state" : " ",
"idle_timeout" : 30,
"email" : "info@arm.com",
"limits" : {
"key" : "aeiou"
},
"upgraded_at" : "2018-02-14T15:24:14Z",
"custom_fields" : {
"key" : "aeiou"
},
"display_name" : "ARM",
"notification_emails" : [ "aeiou" ],
"admin_password" : "PZf9eEUH43DAPE9ULINFeuj",
"password_recovery_expiration" : 4,
"parent_account" : {
"id" : "01619571dad80242ac12000600000000",
"admin_name" : "J. Doe",
"admin_email" : "info@arm.com"
},
"mfa_status" : "enforced",
"admin_full_name" : "Admin Doe",
"password_policy" : {
"minimum_length" : 8
},
"end_market" : "IT",
"parent_id" : "01619571dad80242ac12000600000000",
"sub_accounts" : [ "" ],
"admin_id" : "01619571e2e89242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"template_id" : "01619571e7160242ac12000600000000",
"expiration" : "2000-01-23T04:56:07.000+00:00",
"admin_name" : "admin",
"postal_code" : "CB1 9NJ",
"admin_key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT",
"object" : "account",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | AccountInfoList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Update an account.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"phone_number": "12345678"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"country" : "United Kingdom",
"reason" : "Subscription paid.",
"aliases" : [ "aeiou" ],
"city" : "Cambridge",
"customer_number" : "1NC25_0001",
"policies" : [ {
"allow" : true,
"feature" : "update-campaigns",
"resource" : "/v3/update-campaign",
"inherited" : false,
"action" : "GET"
} ],
"sales_contact" : "sales@arm.com",
"created_at" : "2018-02-13T09:35:20Z",
"admin_email" : "admin@arm.com",
"expiration_warning_threshold" : 180,
"updated_at" : "2018-02-14T15:24:14Z",
"address_line2" : " ",
"tier" : "1",
"address_line1" : "110 Fulbourn Rd",
"contract_number" : "1NX25_0001",
"contact" : "J. Doe",
"reference_note" : "ARM-INT-0001",
"company" : "ARM Holdings Plc",
"id" : "01619571e2e90242ac12000600000000",
"state" : " ",
"idle_timeout" : 30,
"email" : "info@arm.com",
"limits" : {
"key" : "aeiou"
},
"upgraded_at" : "2018-02-14T15:24:14Z",
"custom_fields" : {
"key" : "aeiou"
},
"display_name" : "ARM",
"notification_emails" : [ "aeiou" ],
"admin_password" : "PZf9eEUH43DAPE9ULINFeuj",
"password_recovery_expiration" : 4,
"parent_account" : {
"id" : "01619571dad80242ac12000600000000",
"admin_name" : "J. Doe",
"admin_email" : "info@arm.com"
},
"mfa_status" : "enforced",
"admin_full_name" : "Admin Doe",
"password_policy" : {
"minimum_length" : 8
},
"end_market" : "IT",
"parent_id" : "01619571dad80242ac12000600000000",
"sub_accounts" : [ "" ],
"admin_id" : "01619571e2e89242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"template_id" : "01619571e7160242ac12000600000000",
"expiration" : "2000-01-23T04:56:07.000+00:00",
"admin_name" : "admin",
"postal_code" : "CB1 9NJ",
"admin_key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT",
"object" : "account",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | AccountInfo |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account with the given ID not found. | ErrorResponse |
TenantAccountsEmailNotificationLogs
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"error_msg" : "Connection error.",
"receiver" : "example@email-receiver.test",
"subject" : "Account locked.",
"success" : true,
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"message" : "User limit has been reached.",
"type" : "email",
"object" : "notification-entry"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | NotificationEntryList |
400 | Error in input data, or missing or invalid parameters. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden | ErrorResponse |
404 | Account with the given ID not found. | ErrorResponse |
TenantAccountsIdentityProviders
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | IdentityProviderInfo |
400 | Error in input data, for example, too long name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, or identity provider is in use. | ErrorResponse |
404 | Account or identity provider not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account or identity provider not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
400 | Error in input data, for example, invalid certificate validity value. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account or identity provider not found. | ErrorResponse |
Path parameters
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account or identity provider not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Query parameters
Return type
Example data
{
"data" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "aeiou",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "aeiou",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"type" : "NATIVE",
"saml2_attributes" : {
"idp_entity_id" : "aeiou",
"assertion_endpoint" : "aeiou",
"slo_endpoint" : "aeiou",
"sso_endpoint" : "aeiou",
"sp_x509_cert" : "aeiou",
"sp_entity_id" : "aeiou",
"idp_x509_certs" : [ "aeiou" ]
},
"object" : "identity-provider",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | IdentityProviderInfo |
400 | Error in input data, for example, missing name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account or identity provider not found. | ErrorResponse |
TenantAccountsPolicyGroups
Add users and API keys to groups.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"users": ["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the user or API key does not exist. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
409 | The user of this API key is a member of the group already. | ErrorResponse |
Create a new group.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"name": "MyGroup1"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | GroupSummary |
400 | Error in input data, for example, invalid group name. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the specified ID does not exist. | ErrorResponse |
409 | A group with that name already exists. | ErrorResponse |
Delete a group.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, or Administrators group cannot be removed. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
Retrieve general information about the group.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummary |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
Retrieve all group information.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the specified ID does not exist. | ErrorResponse |
List the API keys of the group with details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id}/api-keys \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"owner" : "01619571e2e89242ac12000600000000",
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"name" : "API key gorgon",
"etag" : "1",
"id" : "01619571f7020242ac12000600000000",
"key" : "ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000",
"object" : "api-key",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | ApiKeyInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
List users of the group with details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id}/users \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
Remove API keys from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id}/api-keys \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"apikeys": ["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the array of API keys is missing. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
Remove users from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id}/users \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"users": ["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the last user to remove from Administrators group. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or group with that ID does not exist. | ErrorResponse |
Update a group name.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/policy-groups/{group_id}/ \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"name": "TestGroup2"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data, for example, the group name is too long. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | A group with that ID does not exist. | ErrorResponse |
TenantAccountsUserInvitations
Invite a new or existing user.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accouns/{account_id}/user-invitations \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"email": "myemail@company.com"}
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_id" : "01619571e2e90242ac12000600000000",
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"etag" : "1",
"expiration" : "2018-02-14T15:24:14Z",
"id" : "01619571e2e89242ac12000600000000",
"email" : "friend@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"object" : "user-invitation"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | UserInvitationResp |
400 | Error in input data, for example, invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Delete an active user invitation sent to a new or existing user.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/user-invitations/{invitation_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or invitation with the specified ID does not exist. | ErrorResponse |
Retrieve details of an active user invitation sent for a new or existing user.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/user-invitations/{invitation_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_id" : "01619571e2e90242ac12000600000000",
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"etag" : "1",
"expiration" : "2018-02-14T15:24:14Z",
"id" : "01619571e2e89242ac12000600000000",
"email" : "friend@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"object" : "user-invitation"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInvitationResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or invitation with the specified ID does not exist. | ErrorResponse |
Retrieve details of all active user invitations sent for new or existing users.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/user-invitations \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_id" : "01619571e2e90242ac12000600000000",
"created_at" : "2018-02-13T09:35:20Z",
"groups" : [ "aeiou" ],
"etag" : "1",
"expiration" : "2018-02-14T15:24:14Z",
"id" : "01619571e2e89242ac12000600000000",
"email" : "friend@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"object" : "user-invitation"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInvitationRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the specified ID does not exist. | ErrorResponse |
TenantAccountsUsers
Add user to groups.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account, user, or group with that ID does not exist. | ErrorResponse |
409 | The user is a member of the group already. | ErrorResponse |
Create or invite a new user to the account. Only email address is used; other attributes are set in the second step.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"email": "myemail@company.com"}
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Query parameters
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | UserInfoResp |
400 | Error in input data, for example, an invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the specified ID does not exist. | ErrorResponse |
409 | A user with the given username or email already exists. | ErrorResponse |
Delete a user.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
400 | Bad request, for example, trying to delete an active user. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or user with the specified ID does not exist. | ErrorResponse |
Retrieve user details.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or user with the specified ID does not exist. | ErrorResponse |
Retrieve details of all users.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account with the given ID does not exist. | ErrorResponse |
Retrieve user's groups.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id}/groups \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"apikey_count" : 0,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"user_count" : 1,
"name" : "Administrators",
"created_at" : "2018-02-13T09:35:20Z",
"etag" : "1",
"id" : "01619571dec00242ac12000600000000",
"object" : "group"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | GroupSummaryList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or user with the specified ID does not exist. | ErrorResponse |
Remove user from groups.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id}/groups \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '["0162056a9a1586f30242590700000000","0117056a9a1586f30242590700000000"]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"code" : 200,
"id" : "01619571dad80242ac12000600000000",
"type" : "success",
"message" : "success",
"request_id" : "0161991d63150242ac12000600000000",
"object" : "user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UpdatedResponse |
400 | Error in input data. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account, user, or group with that ID does not exist. | ErrorResponse |
Update user details.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{"username": "myusername"}'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"creation_time" : 1518630727683,
"last_login_time" : 1518630727688,
"password_changed_time" : 1518630727688,
"is_marketing_accepted" : true,
"created_at" : "2018-02-13T09:35:20Z",
"is_gtc_accepted" : true,
"is_totp_enabled" : true,
"password" : "PZf9eEUH43DAPE9ULINFeuj",
"updated_at" : "2018-02-14T15:24:14Z",
"login_history" : [ {
"date" : "2018-02-14T17:52:07Z",
"success" : true,
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36"
} ],
"totp_scratch_codes" : [ "aeiou" ],
"id" : "01619571e2e89242ac12000600000000",
"active_sessions" : [ {
"account_id" : "01619571e2e90242ac12000600000000",
"reference_token" : "rt_CI6+5hS8p9DrCmkRyS6u4doUdiXr71dX7MqD+g0327hYQthEkYTxMMnCwHyf1rDdk",
"login_time" : "2018-02-14T17:52:07Z",
"ip_address" : "127.0.0.1",
"user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
"object" : "user-session"
} ],
"email" : "user@arm.com",
"login_profiles" : [ {
"name" : "aeiou",
"id" : "aeiou",
"type" : "NATIVE"
} ],
"address" : "110 Fulbourn Rd, Cambridge, United Kingdom",
"email_verified" : true,
"custom_fields" : {
"key" : "aeiou"
},
"groups" : [ "aeiou" ],
"full_name" : "User Doe",
"account_id" : "01619571e2e90242ac12000600000000",
"etag" : "1",
"phone_number" : "+44 (1223) 400 400",
"object" : "user",
"status" : "ACTIVE",
"username" : "admin"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | UserInfoResp |
400 | Error in input data, for example, an invalid email address. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or user with the given ID does not exist. | ErrorResponse |
409 | A user with the given username or email already exists. | ErrorResponse |
Validate user email.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/users/{user_id}/validate-email \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Email validation successfully requested. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | An account or user with the specified ID does not exist. | ErrorResponse |
TenantDeviceSecurityCertificates
Upload new trusted certificates.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/trusted-certificates \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"name": "myCert1", "description": "very important cert", "certificate": "certificate_data", "service": "lwm2m"}
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | New entity created. | TrustedCertificateResp |
400 | Invalid certificate data, certificate validation failed, certificate already expired or certificate uses unsupported, or weak cipher. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, only available for admins of commercial accounts. | ErrorResponse |
404 | An account with the given ID does not exist. | ErrorResponse |
Delete the trusted certificate.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/trusted-certificates/{cert_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Deleted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, only available for admins of commercial accounts. | ErrorResponse |
404 | Account or certificate with the given ID not found. | ErrorResponse |
Retrieve a trusted certificate by ID.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/trusted-certificates/{cert_id} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | TrustedCertificateResp |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, only available for admins of commercial accounts. | ErrorResponse |
404 | Account or certificate with the given ID not found. | ErrorResponse |
Retrieve trusted certificates in an array.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/trusted-certificates \
-H 'Authorization: Bearer <api_key>'
Path parameters
Query parameters
Return type
Example data
{
"data" : [ {
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | TrustedCertificateRespList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, only available for admins of commercial accounts. | ErrorResponse |
404 | An account with the given ID does not exist. | ErrorResponse |
Update existing trusted certificates.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/trusted-certificates/{cert_id} \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d {"description": "very important cert"}
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"enrollment_mode" : false,
"owner_id" : "01619571dad80242ac12000600000000",
"subject" : "CN=subject",
"certificate" : "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
"created_at" : "2018-02-13T09:35:20Z",
"description" : "Certificate created by me.",
"device_execution_mode" : 1,
"certificate_fingerprint" : "a10fb2c8ba90e6de927bd0ae391dcc38f6115685de2d7024712af37ead0608f1",
"issuer" : "CN=issuer",
"valid" : true,
"account_id" : "01619571e2e90242ac12000600000000",
"updated_at" : "2018-02-14T15:24:14Z",
"service" : "lwm2m",
"name" : "My certificate",
"etag" : "1",
"id" : "01619571d01d0242ac12000600000000",
"validity" : "2038-02-14T15:24:14Z",
"object" : "trusted-cert",
"status" : "ACTIVE"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | TrustedCertificateResp |
400 | Invalid certificate data, certificate validation failed, certificate already expired or certificate uses unsupported, or weak cipher. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden, only available for admins of commercial accounts. | ErrorResponse |
404 | An account or certificate with the given ID does not exist. | ErrorResponse |
TenantUserInterfaceConfigurationColors
Update an array of dark theme branding colors of a tenant account.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id)/branding-colors/dark \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
'[{ "reference": "primary",
"color": "#f3f93e" }]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Colors have been set successfully. | |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Update an array of light theme branding colors of a tenant account.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id)/branding-colors/light \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
'[{ "reference": "primary",
"color": "purple" }]'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Colors have been set successfully. | |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Retrieve the requested dark theme branding color.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-colors/dark/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color or account not found. | ErrorResponse |
Retrieve dark theme branding colors for an account.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-colors/dark \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"data" : [ {
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColorList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Retrieve the requested light theme branding color.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-colors/light/{reference}
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color or account not found. | ErrorResponse |
Retrieve light theme branding colors for an account.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-colors/light \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"data" : [ {
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColorList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Resets the branding color of a tenant account to its dark theme default.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-colors/dark/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color or account not found. | ErrorResponse |
Resets the branding color of a tenant account to its light theme default.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-colors/light/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color or account not found. | ErrorResponse |
Update a dark theme branding color of a tenant account.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id)/branding-colors/dark/primary \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{ "color": "#f3f93e" }'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Color has been set successfully. | BrandingColor |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color or account not found. | ErrorResponse |
Update a light theme branding color of a tenant account.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id)/branding-colors/light/primary \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{ "color": "purple" }'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Color set successfully. | BrandingColor |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color or account not found. | ErrorResponse |
TenantUserInterfaceConfigurationImages
Revert an account branding image to dark theme default.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/dark/{reference}/clear \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Image reverted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference, or account not found. | ErrorResponse |
Revert an account branding image to light theme default.
Example:
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Image reverted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference, or account not found. | ErrorResponse |
Retrieve metadata of one account dark theme branding image.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/dark/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImage |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference, or account not found. | ErrorResponse |
Retrieve metadata for one account light theme branding image.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/light/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImage |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference, or account not found. | ErrorResponse |
Retrieve the metadata of all dark theme branding images.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/dark \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"data" : [ {
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImageList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Retrieve the metadata of all light theme branding images.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/light \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"data" : [ {
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImageList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Account not found. | ErrorResponse |
Upload a new account dark theme branding image in PNG or JPEG format.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/dark/{reference}/upload \
-H 'Authorization: Bearer <api_key>'
-H 'content-type: image/png' --data-binary '@myimage.png'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:image/png
image/jpeg
Request body
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference, or account not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Form parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Upload a new account light theme branding image in PNG or JPEG format.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{account_id}/branding-images/light/{reference}/upload \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: image/png' --data-binary '@myimage.png'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:image/png
image/jpeg
Request body
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference, or account not found. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Form parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
UserInterfaceConfigurationColors
Update an array of dark theme branding colors.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/branding-colors/dark \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
'[{ "reference": "primary",
"color": "#f3f93e" }]'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Colors have been set successfully. | |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Update an array of light theme branding colors.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/branding-colors/light \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
'[{ "reference": "primary",
"color": "purple" }]'
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Colors have been set successfully. | |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve the requested dark theme branding color.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-colors/dark/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color not found. | ErrorResponse |
Retrieve the dark theme branding colors.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-colors/dark \
-H 'Authorization: Bearer <api_key>'
Return type
Example data
{
"data" : [ {
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColorList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve the requested light theme branding color.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-colors/light/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color not found. | ErrorResponse |
Retrieve the light theme branding colors.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-colors/light \
-H 'Authorization: Bearer <api_key>'
Return type
Example data
{
"data" : [ {
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColorList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Resets the branding color to its dark theme default.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/branding-colors/light/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color not found. | ErrorResponse |
Resets the branding color to its light theme default.
Example:
curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/branding-colors/light/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingColor |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color not found. | ErrorResponse |
Update a dark theme branding color.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/branding-colors/dark/primary \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{ "color": "#f3f93e" }'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Color has been set successfully. | BrandingColor |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color not found. | ErrorResponse |
Update light theme branding color.
Example:
curl -X PUT https://api.us-east-1.mbedcloud.com/v3/branding-colors/light/primary \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
-d '{ "color": "purple" }'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"reference" : "error_color",
"color" : "#f3f93e",
"updated_at" : "2018-02-14T15:24:14Z",
"object" : "branding_color"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Color has been set successfully. | BrandingColor |
400 | Error in input data format. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Color not found. | ErrorResponse |
UserInterfaceConfigurationImages
Revert an account branding image to dark theme default.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/branding-images/dark/{reference}/clear \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Image reverted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Revert an account branding image to light theme default.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/branding-images/light/{reference}/clear \
-H 'Authorization: Bearer <api_key>'
Path parameters
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
204 | Image reverted successfully. | |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Retrieve metadata for all dark theme branding images.
Example:
`curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-images/dark
-H 'Authorization: Bearer <api_key>'
Return type
Example data
{
"data" : [ {
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImageList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve the metadata of all light theme branding images.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-images/light \
-H 'Authorization: Bearer <api_key>'
Return type
Example data
{
"data" : [ {
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
} ],
"total_count" : 20,
"limit" : 50,
"after" : "01619571f3c00242ac12000600000000",
"has_more" : false,
"object" : "list",
"order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImageList |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
Retrieve metadata for one account dark theme branding image.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-images/dark/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImage |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Retrieve metadata for one account light theme branding image.
Example:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/branding-images/light/{reference} \
-H 'Authorization: Bearer <api_key>'
Path parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
200 | Successful operation. | BrandingImage |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Upload a new account branding image in the dark theme in PNG or JPEG format.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/branding-images/dark/{reference}/upload \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: image/png' --data-binary '@myimage.png'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:image/png
image/jpeg
Request body
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Form parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Upload a new account light theme branding image in PNG or JPEG format.
Example:
curl -X POST https://api.us-east-1.mbedcloud.com/v3/branding-images/light/{reference}/upload \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: image/png' --data-binary '@myimage.png'
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:image/png
image/jpeg
Request body
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Form parameters
Return type
Example data
{
"reference" : "brand_logo_portrait",
"updated_at" : "2018-02-14T15:24:14Z",
"static_uri" : "https://static.mbed.com/123456789.jpg",
"object" : "branding_image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
status | description | schema |
---|---|---|
201 | Image uploaded successfully. | BrandingImage |
400 | Error in input data format, for example, image is too large. | ErrorResponse |
401 | Authentication failure. | ErrorResponse |
403 | Forbidden. | ErrorResponse |
404 | Unknown image reference. | ErrorResponse |
Models
AccountCreationReq
maxLength: 100
The country part of the postal address. Required for commercial accounts only.
maxLength: 100
The name of the contact person for this account. Required for commercial accounts only.
AccountInfo
The tier level of the account; 0
: free tier, 1
: commercial account, 2
: partner tier. Other values are reserved for the future.
maxLength: 100
The username of the admin user created for this account. Present only in the response for account creation.
The email address of the admin user created for this account. Present only in the response for account creation.
The admin API key created for this account. Present only in the response for account creation.
The password of the admin user created for this account. Present only in the response for account creation.
maxLength: 100
The full name of the admin user created for this account. Present only in the response for account creation.
AccountInfoList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
AccountUpdateReq
maxLength: 100
The country part of the postal address. Required for commercial accounts only.
maxLength: 100
The name of the contact person for this account. Required for commercial accounts only.
AccountUpdateRootReq
maxLength: 100
The country part of the postal address. Required for commercial accounts only.
maxLength: 100
The name of the contact person for this account. Required for commercial accounts only.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
ActiveSession
AllServerCredentialsResponseData
ApiKeyInfoReq
ApiKeyInfoResp
ApiKeyInfoRespList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
ApiKeyUpdateReq
BrandingColor
BrandingColorList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
BrandingImage
BrandingImageList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
CertificateGenerationReq
CredentialsResponseData
DeveloperCertificateRequestData
Name of the developer certificate, must be unique. There is a limit on the length of the name. Please see TrustedCertificateReq
Description for the developer certificate. There is a limit on the length of the description. Please see TrustedCertificateReq
DeveloperCertificateResponseData
Content of the security.c file that will be flashed into the device to provide the security credentials
ErrorResponse
FeaturePolicy
Field
GroupCreationInfo
GroupSummary
GroupSummaryList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
GroupUpdateInfo
IdentityProviderCreationReq
IdentityProviderInfo
IdentityProviderList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
IdentityProviderUpdateReq
Image
LoginHistory
LoginProfile
NotificationEntry
A flag indiciating whether the sending of this account notification entry was successful, true or false.
NotificationEntryList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
ParentAccountInfo
PasswordPolicy
SAML2Info
Public X509 certificate of the service provider in PEM format. This is a read-only attribute, see API documentation about how to generate a new one or how to delete it.
SAML2Req
List of public X509 certificates of the identity provider. Certificates must be in PEM format.
Base64 encoded string representation of an XML file. Contains an entity descriptor document for the identity provider. Can be used as an alternative method to provide the identity provider's attributes.
Entity ID of the service provider. We recommend that you leave it empty and let the system generate it.
ServerCredentialsResponseData
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
SubjectList
TrustedCertificateReq
A chain of X509.v3 trusted certificates in PEM format. The chain must contain all certificates from root to leaf. Otherwise, the signature parameter is required.
DEPRECATED: Base64 encoded signature of the account ID signed by the certificate to upload. The signature must be hashed with SHA256.
TrustedCertificateResp
TrustedCertificateRespList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
TrustedCertificateUpdateReq
A chain of X509.v3 trusted certificates in PEM format. The chain must contain all certificates from root to leaf. Otherwise, the signature parameter is required.
DEPRECATED: Base64 encoded signature of the account ID signed by the certificate to be uploaded. The signature must be hashed with SHA256.
UpdatedResponse
UserInfoReq
A list of login profiles for the user. Specified as the identity providers the user should be associated with. Only the ID attribute of the login profile should be set in the request object.
UserInfoResp
The status of the user. ENROLLING state indicates that the user is in the middle of the enrollment process. INVITED means that the user has not accepted the invitation request. RESET means that the password must be changed immediately. INACTIVE users are locked out and not permitted to use the system.
Timestamps, succeedings, IP addresses and user agent information of the last five logins of the user, with timestamps in RFC3339 format.
A list of login profiles for the user. Specified as the identity providers the user is associated with.
A list of scratch codes for the two-factor authentication. Visible only when 2FA is requested to be enabled or the codes regenerated.
UserInfoRespList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
UserInvitationReq
A list of login profiles for the user. Specified as the identity providers the user should be associated with. Only the ID attribute of the login profile should be set in the request object.
UserInvitationResp
A list of login profiles for the user. Specified as the identity providers the user is associated with.
UserInvitationRespList
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
UserUpdateReq
The status of the user. ENROLLING indicates that the user is in the middle of the enrollment process. INVITED means that the user has not accepted the invitation request. RESET means that the password must be changed immediately. INACTIVE users are locked out and not permitted to use the system. Can be changed by the Aggregator Admin only.
'A list of login profiles for the user, specified as identity providers associated with the user. Only the ID attribute of the login profile should be set in the request object. The list cannot be empty. Only an account admin may update login profiles.'