CREATE Registration Token

POST 
/workspaces/:workspaceId/devices/registration-tokens/create

Manually create registration token

Request

Path Parameters

workspaceId uuidrequired

application/json-patch+json

Body

deviceId stringrequired
expirationTime date-timenullable
allowOnBehalfOfRegistration booleanrequired

application/json

Body

deviceId stringrequired
expirationTime date-timenullable
allowOnBehalfOfRegistration booleanrequired

text/json

Body

deviceId stringrequired
expirationTime date-timenullable
allowOnBehalfOfRegistration booleanrequired

application/*+json

Body

deviceId stringrequired
expirationTime date-timenullable
allowOnBehalfOfRegistration booleanrequired

Responses

200

Registration token created.

application/json

Schema

Schema

registrationTokenId uuidrequired
registrationToken stringrequired
expirationTime date-timenullable
issuedTime date-timerequired
deviceId stringrequired
allowOnBehalfOfRegistration booleanrequired

Example (from schema)

{
  "registrationTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "registrationToken": "string",
  "expirationTime": "2024-09-10T19:24:15.254Z",
  "issuedTime": "2024-09-10T19:24:15.254Z",
  "deviceId": "string",
  "allowOnBehalfOfRegistration": true
}

example-1

{
  "registrationTokenId": "9bbfcc09-c6d1-4a5b-825f-f709270c208a",
  "expirationTime": "2021-11-12T14:00:00+00:00",
  "registrationToken": "rrGhpc19pc19hbl9leGFtcGxlX3Rva2VuX3RoaXNfaXNfYW5fZXhhbXBsZV90b2tlbl90aGlzX2lzX2FuX2V4YW1wbGVfdG9rZW5fdGhpc19pc19hbl9leGFtcGxlX3Rva2VuX3RoaXNfaXNfYW5fZXhhbXBsZV90b2tlbl90aGlzX2lzX2FuX2V4YW1wbGVfdG9rZW4=",
  "issuedTime": "2021-11-11T14:00:00+00:00",
  "deviceId": "test-device-01",
  "allowOnBehalfOfRegistration": true
}

400

Invalid request.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Workspace not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

409

There is already an active token for the device.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

example-1

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.8",
  "title": "Registration token for the device already exists.",
  "status": 409,
  "activeRegistrationTokenId": "9bbfcc09-c6d1-4a5b-825f-f709270c208a"
}

423

Workspace is disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...