FIfireblocks
Api User

Issue API user pairing token

Issues a device pairing token for the given user and returns the user's info along with the token.

  • The API user must be in PENDING_ACTIVATION status. If the user is already set up (enabled), the request is rejected with a 409 Conflict.
  • Please note that this endpoint is available only for API keys with Owner/Admin/Non Signing Admin permissions.
  • This is the same pairing token that the API Co-signer requests during installation and when you pair an additional API user with an existing Co-signer. You can use this endpoint instead of copying the token from Pair API user in the Console. The token is valid for one hour.
post/management/api_users/{userId}/pairing_token

Request

Path parameters

userIdstring required

The ID of the api user

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Response

Pairing token issued

idstring required

The unique identifier of the user

namestring

The name of the user

role'OWNER' | 'ADMIN' | 'SIGNER' | 'COLLATERALS_SIGNER' | 'EDITOR' | 'APPROVER' | 'VIEWER' | 'NON_SIGNING_ADMIN' | 'AUDITOR' | 'NCW_ADMIN' | 'NCW_SIGNER' | 'SECURITY_ADMIN' | 'SECURITY_AUDITOR' required

The role of the user

enabledboolean required

Whether the user is enabled

userType'API' | 'CONSOLE'

The type of the user

status'PENDING_ACTIVATION' | 'PENDING_DEVICE_PAIRING' | 'PENDING_DEVICE_SETUP' | 'READY'

The status of the user

pairingTokenstring required

The device pairing token issued for the given user

Example response

{
  "name": "John Doe",
  "pairingToken": "access-token-for-pairing"
}

Changes

No recorded changes to this operation across all 1 revision of this API.