Class: Aws::SSOOIDC::Types::StartDeviceAuthorizationResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#device_code ⇒ String

The short-lived code that is used by the device when polling for a session token.

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 698

class StartDeviceAuthorizationResponse < Struct.new(
  :device_code,
  :user_code,
  :verification_uri,
  :verification_uri_complete,
  :expires_in,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#expires_in ⇒ Integer

Indicates the number of seconds in which the verification code will become invalid.

Returns:

  • (Integer) 


698
699
700
701
702
703
704
705
706
707
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 698

class StartDeviceAuthorizationResponse < Struct.new(
  :device_code,
  :user_code,
  :verification_uri,
  :verification_uri_complete,
  :expires_in,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

Indicates the number of seconds the client must wait between attempts when polling for a session.

Returns:

  • (Integer) 


698
699
700
701
702
703
704
705
706
707
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 698

class StartDeviceAuthorizationResponse < Struct.new(
  :device_code,
  :user_code,
  :verification_uri,
  :verification_uri_complete,
  :expires_in,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#user_code ⇒ String

A one-time user verification code. This is needed to authorize an in-use device.

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 698

class StartDeviceAuthorizationResponse < Struct.new(
  :device_code,
  :user_code,
  :verification_uri,
  :verification_uri_complete,
  :expires_in,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#verification_uri ⇒ String

The URI of the verification page that takes the userCode to authorize the device.

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 698

class StartDeviceAuthorizationResponse < Struct.new(
  :device_code,
  :user_code,
  :verification_uri,
  :verification_uri_complete,
  :expires_in,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#verification_uri_complete ⇒ String

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 698

class StartDeviceAuthorizationResponse < Struct.new(
  :device_code,
  :user_code,
  :verification_uri,
  :verification_uri_complete,
  :expires_in,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end