Create Credential for Application

Allows a developer to create a credential for an application they own.

post
/api/v2/applications/{applicationId}/credentials

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Body

application/json

Create a credential

CreateCredentialRequest

* Additional properties are NOT allowed.
display_namestring

<= 255 characters

Response

application/json

Credential Creation success

CredentialCreationResponse

CredentialCreationResponseobject
One Of
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired
credentialstringrequired

The API key value (only returned on creation)

statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring | null(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

application/json

Update Credential

Updates a credential for an application owned by the current logged in developer.

put
/api/v2/applications/{applicationId}/credentials/{credentialId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

credentialIdstringrequired

Id of the targeted credential.
Use the list-credentials endpoint to obtain the id field for each credential.

Body

application/json

Update a credential

UpdateCredentialRequest

* Additional properties are NOT allowed.
display_namestringrequired

<= 255 characters

Response

Credential successfully updated.

Delete Credential

Deletes a credential for an application they own.

delete
/api/v2/applications/{applicationId}/credentials/{credentialId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

credentialIdstringrequired

Id of the targeted credential.
Use the list-credentials endpoint to obtain the id field for each credential.

Response

Credential successfully deleted.

PageMeta

object

Contains pagination query parameters and the total number of objects returned.

numbernumberrequired

Example:1

sizenumberrequired

Example:10

totalnumberrequired

Example:100

Example

PaginatedMeta

object

returns the pagination information

pageobjectrequired

Contains pagination query parameters and the total number of objects returned.

Show Child Parameters
Example