Get a credential

get https://{hostname}/identity-management/v3/api-clients/{clientId}/credentials/{credentialId}

This operation returns details about a specific credential for an API client. To change the credential's expiration date or toggle its activation status, run the Update credential for an API client operation.

Response

Response body

object

actions

object

Specifies activities available for the credential.

delete

boolean

required

Whether you can remove the credential.

activate

boolean

required

Whether you can activate the credential.

deactivate

boolean

required

Whether you can deactivate the credential.

editDescription

boolean

required

Whether you can modify the credential's description.

editExpiration

boolean

required

Whether you can modify the credential's expiration date.

clientToken

string

required

length ≥ 1

Part of the credential that identifies the API client.

createdOn

date-time

required

ISO 8601 timestamp indicating when the credential was created.

credentialId

integer

required

≥ 1

Unique identifier each credential.

description

string

required

length ≥ 0

Descriptive label for the credential.

expiresOn

date-time

required

ISO 8601 timestamp for when the credential expires. The default expiration date is two years from the creation date.

maxAllowedExpiry

date-time

required

An ISO 8601 timestamp limit for credentials expiring.

status

string

required

length ≥ 1

Whether a credential is ACTIVE, INACTIVE, or DELETED. Activating or deactivating the credential changes the value between ACTIVE and INACTIVE, but you can't reactivate any DELETED credentials.

ACTIVE INACTIVE DELETED

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/identity-management/v3/api-clients/clientId/credentials/credentialId \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "clientToken": "0000-0000000000000000-000000000000000",
3
  "createdOn": "2020-11-01T23:06:59.000Z",
4
  "credentialId": 99999,
5
  "description": "Credential with no secret",
6
  "expiresOn": "2021-11-01T23:06:59.000Z",
7
  "maxAllowedExpiry": "2021-11-01T23:06:59.000Z",
8
  "status": "ACTIVE"
9
}

200The response provides the credential.