logo

Retrieve a credential

Retrieve a credential with specified identifier string.

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

The resource identifier string.

Responses
200

Credential was retrieved successfully.

Response Schema: application/json
username
required
string

Credential's username.

customerId
required
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

id
string <= 50 characters

The credential identifier string.

expiredTime
string <date-time>

The credential's expired time.

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

The links related to resource.

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

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was 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": [
    ]
}
➔ Next to Create or update a credential with predefined ID