Secrets

Secrets are used to authenticate both client credential clients and hybrid clients. A secret has an expiration date or can be created to never expire. We advise to avoid creating secrets that do not expire. After a secret expires, it can no longer be used to authenticate the client. While a secret is still valid, any access token issued will be active until the token itself expires. The same applies to refresh tokens, which are issued to hybrid clients. Safe storage of secrets is your responsibility. The platform does not store secret values, so once lost, there is no way to retrieve the value of a secret.

List Client Credential Client Secrets

Returns all secrets for a client credential client. Total number of secrets in the client set in the Total-Count header.

Request

GET /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets
?query={query}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

[optional] string query
(Not supported) Search string identifier.

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

Response

Example response body

200 Response (ClientSecret[])

[
  {
    "Expiration": "2019-08-24T14:15:22Z",
    "Expires": true,
    "Description": "string",
    "Id": 0
  }
]

Authorization

Allowed for these roles:

• Self
• Tenant Administrator

Get Total Count of Client Credential Client Secrets

Returns the total number of secrets in a client credential client. The value will be set in the Total-Count header. This method is identical to the GET method, but it does not return any objects in the body.

Request

HEAD /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Response

Authorization

Allowed for these roles:

• Self
• Tenant Administrator

Add Client Credential Client Secret

Adds a new secret to a client credential client. A client can have a maximum of 10 secrets. We advise against creating secrets that do not expire.

Request

POST /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Request Body

ClientSecretCreateOrUpdate object.

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string"
}

Response

Example response body

201 Response (ClientSecretResponse)

{
  "Id": 0,
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Secret": "string"
}

Authorization

Allowed for these roles:

• Self
• Tenant Administrator

Get Client Credential Client Secret

Returns a client credential client secret.

Request

GET /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Response

Example response body

200 Response (ClientSecret)

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Id": 0
}

Authorization

Allowed for these roles:

• Self
• Tenant Administrator

Get Header for Client Credential Client Secret

Validates that a secret with a given unique identifier exists in the client. This method is identical to the GET method, but it does not return any objects in the body.

Request

HEAD /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Response

Authorization

Allowed for these roles:

• Self
• Tenant Administrator

Update Client Credential Client Secret

Updates a client credential client secret. It can take up to one hour for the update to manifest in the authentication process.

Request

PUT /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Request Body

ClientSecretCreateOrUpdate object. Properties that are not set or are null will not be changed.

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string"
}

Response

Example response body

200 Response (ClientSecret)

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Id": 0
}

Authorization

Allowed for these roles:

• Tenant Administrator

Delete Client Credential Client Secret

Deletes a secret from a client credential client. It can take up to one hour for deletion to manifest in the authentication process. Access tokens issued using this secret will be valid until their expiration.

Request

DELETE /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Response

Authorization

Allowed for these roles:

• Self
• Tenant Administrator

List Hybrid Client Secrets

Returns all secrets for a hybrid client. Total number of secrets in the client set in the Total-Count header.

Request

GET /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets
?query={query}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

[optional] string query
(Not supported) Search string identifier.

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

Response

Example response body

200 Response (ClientSecret[])

[
  {
    "Expiration": "2019-08-24T14:15:22Z",
    "Expires": true,
    "Description": "string",
    "Id": 0
  }
]

Authorization

Allowed for these roles:

• Tenant Administrator

Get Total Count of Hybrid Client Secrets

Returns total number of secrets in a hybrid client. The value will be set in the Total-Count header. This method is identical to the GET method but it does not return any objects in the body.

Request

HEAD /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Response

Authorization

Allowed for these roles:

• Tenant Administrator

Add Hybrid Client Secret

Adds a new secret to a hybrid client. A client can have a maximum of 10 secrets. We advise against creating secrets that do not expire.

Request

POST /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Request Body

ClientSecretCreateOrUpdate object

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string"
}

Response

Example response body

201 Response (ClientSecretResponse)

{
  "Id": 0,
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Secret": "string"
}

Authorization

Allowed for these roles:

• Tenant Administrator

Get Hybrid Client Secret

Returns a hybrid client secret.

Request

GET /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Response

Example response body

200 Response (ClientSecret)

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Id": 0
}

Authorization

Allowed for these roles:

• Tenant Administrator

Get Header for Hybrid Client Secret

Validates that a secret unique identifier exists in the client. This method is identical to the GET method but it does not return any objects in the body.

Request

HEAD /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Response

Authorization

Allowed for these roles:

• Tenant Administrator

Update Hybrid Client Secret

Updates a hybrid client secret. It can take up to one hour for the update to manifest in the authentication process.

Request

PUT /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Request Body

ClientSecretCreateOrUpdate object. Properties that are not set or are null will not be changed.

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string"
}

Response

Example response body

200 Response (ClientSecret)

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Id": 0
}

Authorization

Allowed for these roles:

• Tenant Administrator

Delete Hybrid Client Secret

Deletes a secret from a hybrid client. It can take up to one hour for deletion to manifest in the authentication process. Access tokens issued using this secret will be valid until their expiration.

Request

DELETE /api/v1/Tenants/{tenantId}/HybridClients/{clientId}/Secrets/{secretId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

integer secretId
Secret identifier.

Response

Authorization

Allowed for these roles:

• Tenant Administrator

Definitions

ClientSecret

Client secret object

Properties

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Id": 0
}

ErrorResponse

Object returned whenever there is an error

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "DynamicProperties": {
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

ClientSecretResponse

Object returned after a client secret is created

Properties

{
  "Id": 0,
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string",
  "Secret": "string"
}

ClientSecretCreateOrUpdate

Object to write a client secret

Properties

{
  "Expiration": "2019-08-24T14:15:22Z",
  "Expires": true,
  "Description": "string"
}