light-mode-image
Learn
API ReferenceIACA

Update an IACA

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_IACA_UPDATE_STARTMOBILE_CREDENTIAL_IACA_UPDATE_SUCCESSMOBILE_CREDENTIAL_IACA_UPDATE_FAIL
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.

Analytic events

  • MOBILE_CREDENTIAL_IACA_UPDATE_START
  • MOBILE_CREDENTIAL_IACA_UPDATE_SUCCESS
  • MOBILE_CREDENTIAL_IACA_UPDATE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

iacaId*string

IACA ID

Formatuuid

Request Body

application/json

active*boolean

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

Response Body

application/json

application/json

curl -X PUT "https://example.vii.au01.mattr.global/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": "-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n",
  "certificateData": {
    "notAfter": "2034-09-26",
    "notBefore": "2023-09-26",
    "country": "US",
    "commonName": "{tenant-subdomain}.vii.mattr.global IACA",
    "stateOrProvinceName": "US-AL"
  },
  "certificateFingerprint": "3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311",
  "isManaged": true
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Retrieve an IACA GET

Retrieves an existing IACA by providing its ID. ### **Analytic events** * MOBILE_CREDENTIAL_IACA_RETRIEVE_START * MOBILE_CREDENTIAL_IACA_RETRIEVE_SUCCESS * MOBILE_CREDENTIAL_IACA_RETRIEVE_FAIL

Delete an IACA DELETE

Deletes an existing IACA by providing its ID. ### **Analytic events** * MOBILE_CREDENTIAL_IACA_DELETE_START * MOBILE_CREDENTIAL_IACA_DELETE_LIST_SUCCESS * MOBILE_CREDENTIAL_IACA_DELETE_LIST_FAIL