Class: Aws::CognitoIdentityProvider::Types::AdminRevokeUserSessionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#revoke_associated_sessions ⇒ String

Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.

Returns:

  • (String) 


2355
2356
2357
2358
2359
2360
2361
2362
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2355

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

#session_id ⇒ String

The ID of the session to revoke. This is a 28-character string of lowercase letters and digits, prefixed with tkn for a token session or sso for an SSO session.

Returns:

  • (String) 


2355
2356
2357
2358
2359
2360
2361
2362
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2355

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

#user_pool_id ⇒ String

The ID of the user pool that contains the session.

Returns:

  • (String) 


2355
2356
2357
2358
2359
2360
2361
2362
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2355

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

#username ⇒ String

The username of the user who owns the session. The username must match the user associated with the SessionId, to confirm they are the intended target user.

Returns:

  • (String) 


2355
2356
2357
2358
2359
2360
2361
2362
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2355

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