CREATE Provisioning Token

POST 
/workspaces/:workspaceId/provisioning-tokens/create

Create provisioning token - V2

Request

Path Parameters

workspaceId uuidrequired

application/json-patch+json

Body

displayName stringnullable
maxRegistrationTokenLifetime stringnullable
registrationTokenLifetimeOverrideMode stringrequired

Possible values: [Disabled, Allowed, Enforce]

Allowed values: Disabled, Allowed, Enforce

deviceIdOverrideMode stringrequired

Possible values: [DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow]

Allowed values: DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow

deviceId stringnullable
allowInfiniteRegistrationTokenLifetime boolean

application/json

Body

displayName stringnullable
maxRegistrationTokenLifetime stringnullable
registrationTokenLifetimeOverrideMode stringrequired

Possible values: [Disabled, Allowed, Enforce]

Allowed values: Disabled, Allowed, Enforce

deviceIdOverrideMode stringrequired

Possible values: [DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow]

Allowed values: DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow

deviceId stringnullable
allowInfiniteRegistrationTokenLifetime boolean

text/json

Body

displayName stringnullable
maxRegistrationTokenLifetime stringnullable
registrationTokenLifetimeOverrideMode stringrequired

Possible values: [Disabled, Allowed, Enforce]

Allowed values: Disabled, Allowed, Enforce

deviceIdOverrideMode stringrequired

Possible values: [DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow]

Allowed values: DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow

deviceId stringnullable
allowInfiniteRegistrationTokenLifetime boolean

application/*+json

Body

displayName stringnullable
maxRegistrationTokenLifetime stringnullable
registrationTokenLifetimeOverrideMode stringrequired

Possible values: [Disabled, Allowed, Enforce]

Allowed values: Disabled, Allowed, Enforce

deviceIdOverrideMode stringrequired

Possible values: [DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow]

Allowed values: DeviceEnforce, DeviceAndTechnicianAllow, TechnicianEnforce, TechnicianAllow, Disable, DeviceAllow

deviceId stringnullable
allowInfiniteRegistrationTokenLifetime boolean

Responses

200

Provisioning Token.

application/json

Schema

Schema

provisioningTokenId uuidrequired
provisioningToken stringrequired
issuedTime date-timerequired
maxRegistrationTokenLifetime stringnullable
registrationTokenLifetimeOverrideMode stringrequired
deviceIdOverrideMode stringrequired
allowInfiniteRegistrationTokenLifetime booleanrequired

Example (from schema)

{
  "provisioningTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provisioningToken": "string",
  "issuedTime": "2024-09-10T19:24:15.246Z",
  "maxRegistrationTokenLifetime": "string",
  "registrationTokenLifetimeOverrideMode": "string",
  "deviceIdOverrideMode": "string",
  "allowInfiniteRegistrationTokenLifetime": true
}

example-1

{
  "provisioningTokenId": "97fc7f82-c55d-4c51-889c-94ff4dc96b8b",
  "provisioningToken": "dGhpc19pc19hbl9leGFtcGxlX3Rva2VuX3RoaXNfaXNfYW5fZXhhbXBsZV90b2tlbl90aGlzX2lzX2FuX2V4YW1wbGVfdG9rZW5fdGhpc19pc19hbl9leGFtcGxlX3Rva2VuX3RoaXNfaXNfYW5fZXhhbXBsZV90b2tlbl90aGlzX2lzX2FuX2V4YW1wbGVfdG9rZW4=",
  "issuedTime": "2021-11-11T14:00:00+00:00",
  "maxRegistrationTokenLifetime": "24:00:00",
  "registrationTokenLifetimeOverrideMode": "Allowed",
  "deviceIdOverrideMode": "DeviceAndTechnicianAllow",
  "allowInfiniteRegistrationTokenLifetime": false
}

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"
}

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...