AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
show all
Defined in:
(unknown)

Overview

Note:

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

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)

    The unique identifier string for each client.

#client_secretString

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

Returns:

  • (String)

    A secret string generated for the client.

#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)

    The authorization code received from the authorization service.

#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)

    Used only when calling this API for the device code grant type.

#grant_typeString

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

Returns:

  • (String)

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

#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)

    The location of the application that will receive the authorization code.

#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)

    The token used to obtain an access token in the event that the access token is invalid or expired.

#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>)

    The list of scopes that is defined by the client.