Class: Aws::SSOOIDC::Types::CreateTokenRequest

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

Overview

Note:

When making an API call, you may pass CreateTokenRequest data as a hash:

{
  client_id: "ClientId", # required
  client_secret: "ClientSecret", # required
  grant_type: "GrantType", # required
  device_code: "DeviceCode", # required
  code: "AuthCode",
  refresh_token: "RefreshToken",
  scope: ["Scope"],
  redirect_uri: "URI",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#client_secretString

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#codeString

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#device_codeString

Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#grant_typeString

Supports grant types for authorization code, refresh token, and device code request.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_uriString

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_tokenString

The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

Returns:

  • (String)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end

#scopeArray<String>

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Returns:

  • (Array<String>)


110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 110

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri)
  SENSITIVE = []
  include Aws::Structure
end