Upsert a credential

Creates or updates (upserts) an authentication credential with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json

Credential resource.

username
required
string

Username associated with the credential.

password
required
string <password>

Password associated with the credential.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

expiredTime
string or null <date-time>

Date and time when the credential expires.

put
/credentials/{id}
Request samples
application/json
{ "username": "string", "password": "pa$$word", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "expiredTime": "2019-08-24T14:15:22Z" }
Responses

200

Credential updated.

Response Schema: application/json
id
string <= 50 characters

ID of the credential.

username
required
string

Username associated with the credential.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

expiredTime
string or null <date-time>

Date and time when the credential expires.

Array of objects

Related links.

201

Credential created.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

Response samples
application/json
{ "id": "cus_crd_0YV9Y706QGCB39FQD380G1ZHZH", "username": "string", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "expiredTime": "2019-08-24T14:15:22Z", "_links": [ ] }