List your credentials

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

This operation lists your API client's credentials.

Response

Response body

array of objects

object

actions

object

Specifies activities available for the credential.

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/self/credentials \
# Add Authorization header to this snippet
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
[
2
  {
3
    "clientToken": "0000-0000000000000000-000000000000000",
4
    "createdOn": "2019-11-01T23:06:59.000Z",
5
    "credentialId": 99999,
6
    "description": "John's access to Property Manager",
7
    "expiresOn": "2020-11-01T23:06:59.000Z",
8
    "maxAllowedExpiry": "2020-11-01T23:06:59.000Z",
9
    "status": "ACTIVE"
10
  },
11
  {
12
    "clientToken": "0000-0000000000000000-000000000000000",
13
    "createdOn": "2019-11-01T23:06:59.000Z",
14
    "credentialId": 88888,
15
    "description": "John's access to Event Center",
16
    "expiresOn": "2020-11-01T23:06:59.000Z",
17
    "maxAllowedExpiry": "2020-11-01T23:06:59.000Z",
18
    "status": "INACTIVE"
19
  }
20
]

200The response provides the credentials.