You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSOOIDC::Types::CreateTokenRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSOOIDC::Types::CreateTokenRequest
- Defined in:
- (unknown)
Overview
When passing CreateTokenRequest as input to an Aws::Client method, you can use a vanilla 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",
}
Instance Attribute Summary collapse
-
#client_id ⇒ String
The unique identifier string for each client.
-
#client_secret ⇒ String
A secret string generated for the client.
-
#code ⇒ String
The authorization code received from the authorization service.
-
#device_code ⇒ String
Used only when calling this API for the device code grant type.
-
#grant_type ⇒ String
Supports grant types for authorization code, refresh token, and device code request.
-
#redirect_uri ⇒ String
The location of the application that will receive the authorization code.
-
#refresh_token ⇒ String
The token used to obtain an access token in the event that the access token is invalid or expired.
-
#scope ⇒ Array<String>
The list of scopes that is defined by the client.
Instance Attribute Details
#client_id ⇒ String
The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.
#client_secret ⇒ String
A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
#code ⇒ String
The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.
#device_code ⇒ String
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.
#grant_type ⇒ String
Supports grant types for authorization code, refresh token, and device code request.
#redirect_uri ⇒ String
The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.
#refresh_token ⇒ String
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.
#scope ⇒ Array<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.