Auth client

post

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.

Authorizations

Body

client_idstringOptional

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

descriptionstringOptional

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

device_specstringOptional

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

derived_client_idstringOptional

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.

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /network/auth-client HTTP/1.1
Host: api.bringyour.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "client_id": "text",
  "description": "text",
  "device_spec": "text",
  "derived_client_id": "text"
}

200Success

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