Retrieve a credential

Retrieves a credential with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Credential retrieved.

Response Schema: application/json
username
required
string

Username associated with the credential.

customerId
required
string (CustomerId) <= 50 characters

Customer resource ID. Defaults to UUID v4.

id
string <= 50 characters

Credential identifier string.

expiredTime
string <date-time>

Date and time at which the credential expires.

Array of Self (object) or CustomerLink (object) non-empty

Resource related links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/credentials/{id}
Request samples
$customerCredential = $client->customerCredentials()->load('credentialId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "username": "string",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "expiredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}