Auth client

Gain permission to use the connect protocol as the requested clientId, or assign a new clientId. Each network can have at most 128 clientIds. Above that number, new clientId requests will error until one or more existing clientIds are removed.

POSThttps://api.bringyour.com/network/auth-client

Authorization

Body

client_idstring

udid. Optional. If this is given, it must currently exist in the network. Omit this to assign a new client id.

descriptionstring

If this is a new device, sets the device name to the description of the device.

device_specstring

If this is a new device, sets the device spec.

derived_client_idstring

udid. Optional. | The client that the new client is derived from. If this is called with a client jwt, the derived client id is inferred from the jwt.

Response

Body

by_client_jwtstring

errorobject

client_limit_exceededboolean

messagestring

Request

Response

POSThttps://api.bringyour.com/network/auth-client

Authorization

Body

client_idstring

udid. Optional. If this is given, it must currently exist in the network. Omit this to assign a new client id.

descriptionstring

If this is a new device, sets the device name to the description of the device.

device_specstring

If this is a new device, sets the device spec.

derived_client_idstring

udid. Optional. | The client that the new client is derived from. If this is called with a client jwt, the derived client id is inferred from the jwt.

Response

Body

by_client_jwtstring

errorobject

client_limit_exceededboolean

messagestring

Request

Response

const response = await fetch('https://api.bringyour.com/network/auth-client', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "by_client_jwt": "text",
  "error": {
    "client_limit_exceeded": false,
    "message": "text"
  }
}