AdminUserGlobalSignOutRequest

The request to sign out of all devices, as an administrator.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name	Type	Description
UserPoolId	object
Username	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-admin-user-global-sign-out-request-schema.json",
  "title": "AdminUserGlobalSignOutRequest",
  "description": "The request to sign out of all devices, as an administrator.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username"
  ]
}