IACA

Create an IACA

POST/v2/credentials/mobile/iacas

Creates a new IACA that can be used to sign certificates for Document and Status List signers.

IACAs are always created as inactive. You must manually update the IACA to active: true before it can be used to sign mDocs.
A maximum of three IACAs can be created per tenant.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_CREATE_STARTMOBILE_CREDENTIAL_IACA_CREATE_SUCCESSMOBILE_CREDENTIAL_IACA_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/mobile/iacas" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "commonName": "{tenantDomain} IACA",    "stateOrProvinceName": "string"  },  "certificateFingerprint": "string",  "isManaged": true}

Retrieve all IACAs

GET/v2/credentials/mobile/iacas

Retrieves all existing IACAs from the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_SUCCESSMOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/iacas"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "active": true,      "certificatePem": "string",      "certificateData": {        "notAfter": "2019-08-24",        "notBefore": "2019-08-24",        "country": "string",        "commonName": "{tenantDomain} IACA",        "stateOrProvinceName": "string"      },      "certificateFingerprint": "string",      "isManaged": true    }  ],  "nextCursor": "string"}

Retrieve an IACA

GET/v2/credentials/mobile/iacas/{iacaId}

Retrieves an existing IACA by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_IACA_RETRIEVE_STARTMOBILE_CREDENTIAL_IACA_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_IACA_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/iacas/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "commonName": "{tenantDomain} IACA",    "stateOrProvinceName": "string"  },  "certificateFingerprint": "string",  "isManaged": true}

Update an IACA

PUT/v2/credentials/mobile/iacas/{iacaId}

Update the status of an IACA. Only active IACAs can be used for signing mDocs.

Creating an IACA with active set to false enables distributing the IACA's PEM to relying parties in advance, before it is being used to sign any mDocs.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_UPDATE_STARTMOBILE_CREDENTIAL_IACA_UPDATE_SUCCESSMOBILE_CREDENTIAL_IACA_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/mobile/iacas/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": false  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "commonName": "{tenantDomain} IACA",    "stateOrProvinceName": "string"  },  "certificateFingerprint": "string",  "isManaged": true}

Delete an IACA

DELETE/v2/credentials/mobile/iacas/{iacaId}

Deletes an existing IACA by providing its ID.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_DELETE_STARTMOBILE_CREDENTIAL_IACA_DELETE_LIST_SUCCESSMOBILE_CREDENTIAL_IACA_DELETE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Create an IACA

POST/v2/credentials/mobile/iacas

Creates a new IACA that can be used to sign certificates for Document and Status List signers.

IACAs are always created as inactive. You must manually update the IACA to active: true before it can be used to sign mDocs.
A maximum of three IACAs can be created per tenant.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_CREATE_STARTMOBILE_CREDENTIAL_IACA_CREATE_SUCCESSMOBILE_CREDENTIAL_IACA_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

commonName?string

This optional parameter indicates the common name of the IACA certificate. When specified, the value must be a valid PrintableString and cannot be an empty string. If not provided and a custom domain is configured and verified, the custom domain is used followed by the word IACA. If no custom domain is configured, the tenant subdomain is used instead.

Default"{tenantDomain} IACA"

country?string

This optional parameter indicates the issuer country. If not provided, a country is selected based on the region of the tenant subdomain cloud host. When specified, the value must be a valid Alpha 2 country code as per ISO 3166-1.

notBefore?string

This optional parameter is used to set the date and time when the IACA becomes valid and can be used to sign mDocs. This can be used alongside the active field to support IACA rotation by creating inactive IACAs and distributing them to relying parties in advance. * Must not be in the past. * Must be before notAfter.

notAfter?string

This optional parameter is used to set the date and time when the IACA expires. - If not provided, calculated as notBefore + 10 years. - If not provided and notBefore is not provided, calculated as time of creation + 10 years. - Maximum value is 20 years from creation. - Must be after notBefore, if provided.

stateOrProvinceName?string

This optional parameter indicates the issuer state or province. When specified, the value must be uppercase and a valid state/province code as per ISO 3166-2.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/mobile/iacas" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "commonName": "{tenantDomain} IACA",    "stateOrProvinceName": "string"  },  "certificateFingerprint": "string",  "isManaged": true}

Retrieve all IACAs

GET/v2/credentials/mobile/iacas

Retrieves all existing IACAs from the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_SUCCESSMOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/iacas"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "active": true,      "certificatePem": "string",      "certificateData": {        "notAfter": "2019-08-24",        "notBefore": "2019-08-24",        "country": "string",        "commonName": "{tenantDomain} IACA",        "stateOrProvinceName": "string"      },      "certificateFingerprint": "string",      "isManaged": true    }  ],  "nextCursor": "string"}

Retrieve an IACA

GET/v2/credentials/mobile/iacas/{iacaId}

Retrieves an existing IACA by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_IACA_RETRIEVE_STARTMOBILE_CREDENTIAL_IACA_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_IACA_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

iacaId*string

IACA ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/iacas/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "commonName": "{tenantDomain} IACA",    "stateOrProvinceName": "string"  },  "certificateFingerprint": "string",  "isManaged": true}

Update an IACA

PUT/v2/credentials/mobile/iacas/{iacaId}

Update the status of an IACA. Only active IACAs can be used for signing mDocs.

Creating an IACA with active set to false enables distributing the IACA's PEM to relying parties in advance, before it is being used to sign any mDocs.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_UPDATE_STARTMOBILE_CREDENTIAL_IACA_UPDATE_SUCCESSMOBILE_CREDENTIAL_IACA_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

iacaId*string

IACA ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active*boolean

Indicates whether the IACA is active or not. Only active IACAs can be used to sign mDocs.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/mobile/iacas/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": false  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "commonName": "{tenantDomain} IACA",    "stateOrProvinceName": "string"  },  "certificateFingerprint": "string",  "isManaged": true}

Delete an IACA

DELETE/v2/credentials/mobile/iacas/{iacaId}

Deletes an existing IACA by providing its ID.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_DELETE_STARTMOBILE_CREDENTIAL_IACA_DELETE_LIST_SUCCESSMOBILE_CREDENTIAL_IACA_DELETE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

iacaId*string

IACA ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/mobile/iacas/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Roles

Analytics Events

201application/json

400application/json

409application/json

Roles

Analytics Events

200application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

IACA

Roles

Analytics Events

201application/json

400application/json

409application/json

Roles

Analytics Events

200application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`