Device Code Clients

Device code clients are used in browserless or input constrained devices. These clients are issued an identifier. Device code clients are not issued secrets.

List All Device Code Clients from Tenant

Returns all device code clients from a tenant. Optionally, get a list of requested clients. Total number of clients in the tenant set in the Total-Count header.

Request

GET /api/v1/Tenants/{tenantId}/DeviceCodeClients
?id={id}&tag={tag}&query={query}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

[optional] array id
Unordered list of identifiers for all clients to get. Empty or whitespace identifiers will be ignored.

[optional] array tag
Only return clients that have these tags.

[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 (DeviceCodeClient[])

[
  {
    "Id": "string",
    "Name": "string",
    "Enabled": true,
    "AccessTokenLifetime": 0,
    "Tags": [
      "string"
    ],
    "DeviceCodeLifetime": 0,
    "ClientUri": "string",
    "LogoUri": "string"
  }
]

Authorization

Allowed for these roles:

• Tenant Member

Get Total Count Device Code Clients from Tenant

Return total number of device dode clients in a tenant. Optionally, checks based on a list of requested clients. 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}/DeviceCodeClients
?id={id}&tag={tag}

Parameters

string tenantId
Tenant identifier.

[optional] array id
Unordered list of identifiers for all clients to get. Empty or whitespace identifiers will be ignored.

[optional] array tag
Only return clients that have these tags.

Response

Authorization

Allowed for these roles:

• Tenant Member

Create a Device Code Client

Create a device code flow client. No secret will be generated for this client.

Request

POST /api/v1/Tenants/{tenantId}/DeviceCodeClients

Parameters

string tenantId
Tenant identifier.

Request Body

New DeviceCodeClient object.

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "DeviceCodeLifetime": 0,
  "ClientUri": "string",
  "LogoUri": "string"
}

Response

Example response body

201 Response (DeviceCodeClient)

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "DeviceCodeLifetime": 0,
  "ClientUri": "string",
  "LogoUri": "string"
}

Authorization

Allowed for these roles:

• Tenant Administrator

Get a Device Code Client from Tenant

Returns a device code client from a tenant.

Request

GET /api/v1/Tenants/{tenantId}/DeviceCodeClients/{clientId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Response

Example response body

200 Response (DeviceCodeClient)

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "DeviceCodeLifetime": 0,
  "ClientUri": "string",
  "LogoUri": "string"
}

Authorization

Allowed for these roles:

• Self
• Tenant Member

Get Header for Device Code Client

Validates that a device code client exists in a tenant.

Request

HEAD /api/v1/Tenants/{tenantId}/DeviceCodeClients/{clientId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Response

Example response body

200 Response (ClientCredentialClient)

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "RoleIds": [
    "string"
  ]
}

Authorization

Allowed for these roles:

• Self
• Tenant Member

Update a Device Code Client

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

Request

PUT /api/v1/Tenants/{tenantId}/DeviceCodeClients/{clientId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Request Body

Updated device code client values. Properties that are not set or are null will not be changed.

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "DeviceCodeLifetime": 0,
  "ClientUri": "string",
  "LogoUri": "string"
}

Response

Example response body

200 Response (DeviceCodeClient)

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "DeviceCodeLifetime": 0,
  "ClientUri": "string",
  "LogoUri": "string"
}

Authorization

Allowed for these roles:

• Tenant Administrator

Delete a Device Code Client

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

Request

DELETE /api/v1/Tenants/{tenantId}/DeviceCodeClients/{clientId}

Parameters

string tenantId
Tenant identifier.

string clientId
Client identifier.

Response

Authorization

Allowed for these roles:

• Tenant Administrator

Definitions

DeviceCodeClient

Object used for device code clients

Properties

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "DeviceCodeLifetime": 0,
  "ClientUri": "string",
  "LogoUri": "string"
}

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
}

ClientCredentialClient

Object to return or update a ClientCredentialClient

Properties

{
  "Id": "string",
  "Name": "string",
  "Enabled": true,
  "AccessTokenLifetime": 0,
  "Tags": [
    "string"
  ],
  "RoleIds": [
    "string"
  ]
}