Class: Aws::CognitoIdentityProvider::Types::AdminUserGlobalSignOutRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AdminUserGlobalSignOutRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #user_pool_id ⇒ String

  The user pool ID.

• #username ⇒ String

  The username of the user that you want to query or modify.

Instance Attribute Details

#user_pool_id ⇒ String

The user pool ID.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1981

class AdminUserGlobalSignOutRequest < Struct.new(
  :user_pool_id,
  :username)
  SENSITIVE = [:username]
  include Aws::Structure
end

#username ⇒ String

The username of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1981

class AdminUserGlobalSignOutRequest < Struct.new(
  :user_pool_id,
  :username)
  SENSITIVE = [:username]
  include Aws::Structure
end