iam.users.block-device-key

Block a member's CLI device in this organization

POST /iam/api/users/{id}/cli/device-keys/{keyId}/blockIAM iam:BlockUserDeviceKeyChanges stateDestructive

It signs in here no more and its CLI sessions here end now. The device keeps working in other organizations; only its owner removes it.

Request syntax

POST /iam/api/users/{id}/cli/device-keys/{keyId}/block

Path parameters

  • idRequired

    string

    Constraints: uuid

  • keyIdRequired

    string

    Constraints: uuid

Response

200 with `data`: `blocked: true` and `sessionsEnded`, how many of its CLI sessions here were ended; blocking a device already blocked answers the same (with 0 or the sessions opened since). 404 when the user is not a person of this organization or the device is not one of their live devices.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow iam:BlockUserDeviceKey on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud iam users block-device-key id keyId

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_users_block-device-key.