iam.users.end-cli-session

End one of a member's CLI sessions in this organization

DELETE /iam/api/users/{id}/cli/sessions/{sessionId}IAM iam:RevokeUserSessionsChanges stateDestructive

Request syntax

DELETE /iam/api/users/{id}/cli/sessions/{sessionId}

Path parameters

  • idRequired

    string

    Constraints: uuid

  • sessionIdRequired

    string

    Constraints: uuid

Response

200 with `data`: `id`, the session ended. 404 when the user is not a person of this organization or the session is not one of their live CLI sessions here (an ended one included).

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:RevokeUserSessions 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 end-cli-session id sessionId

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_users_end-cli-session.