FIfireblocks
Console User

Request deletion of a console user

Requests deletion of a console user. The request is asynchronous: it goes through the workspace's configured "Delete users" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes.

  • The workspace must have a "Delete users" approval policy (admin quorum or approval group). If "Delete users" is Owner-only, which is the default, the request is refused with OWNER_ONLY (2760) and the Owner deletes users in the Console. With an admin quorum, the requesting API user's own approval counts toward the quorum.
  • Track progress by polling GET /management/users; deletion is complete when the user is disabled.
  • Please note that this endpoint is available only for API keys with Admin/Non Signing Admin/Security Admin permissions. Endpoint Permission: Admin, Non-Signing Admin, Security Admin. Note: This endpoint is in Early Availability (EA) and may change or break before it reaches GA.
delete/management/users/{id}

Request

Path parameters

idstring required

The ID of the console user to delete

Query parameters

forceboolean

Acknowledges the impact of removing this user and proceeds anyway. Overrides both USER_REFERENCED_IN_TAP and QUORUM_INTEGRITY, the same way the acknowledgement checkbox does in the console.

Response

Deletion request accepted. Returns the console user that will be removed once the workspace's configured approval completes.

idstring

The unique identifier of the user

firstNamestring

The first name of the user

lastNamestring

The last name of the user

emailstring

The email address of the user

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

The role of the user

enabledboolean

Whether the user is enabled

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

The status of the user

userType'API' | 'CONSOLE'

The type of the user

Changes

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