Sign in
User Account

Revoke a user's Cognito sessions as admin

Changed on

Invalidates the explicit target user's Cognito sessions with Cognito global sign-out. No request body is accepted.

Cognito JWTs and Aura Historia access tokens are accepted. The caller's persisted user role must be ADMIN; delegated Aura Historia access tokens must also have users:write. Authorization and the target-user check are enforced in the User service, not only at the HTTP route. The PostgreSQL authorization check completes before the external Cognito call.

userId must be a valid User ID and the target user must exist. Cognito global sign-out is safe to retry: it succeeds when there are no active sessions. The operation does not change the Aura user's profile, tier, role, suspension state, Aura access tokens, or partnerships. Every response sends Cache-Control: no-store.

post/api/v1/admin/users/{userId}/sessions/revoke

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/users/{userId}/sessions/revoke
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

userIdstring required

Unique User ID for the user whose Cognito sessions are revoked.

Response

Cognito sessions were invalidated, including after a retry with no active sessions.

Changes

  • 999eda3fdd63Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      for the path request parameter userId, the format was generalized from uuid to no format

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • a0daf61b554aRevision changes
    • info

      endpoint added