java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssooidc.model.SsoOidcRequest
    - - software.amazon.awssdk.services.ssooidc.model.CreateTokenRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateTokenRequest
extends SsoOidcRequest
implements ToCopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateTokenRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateTokenRequest.Builder`	`builder()`
`String`	`clientId()`	The unique identifier string for the client or application.
`String`	`clientSecret()`	A secret string generated for the client.
`String`	`code()`	Used only when calling this API for the Authorization Code grant type.
`String`	`codeVerifier()`	Used only when calling this API for the Authorization Code grant type.
`String`	`deviceCode()`	Used only when calling this API for the Device Code grant type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`grantType()`	Supports the following OAuth grant types: Device Code and Refresh Token.
`int`	`hashCode()`
`boolean`	`hasScope()`	For responses, this returns true if the service returned a value for the Scope property.
`String`	`redirectUri()`	Used only when calling this API for the Authorization Code grant type.
`String`	`refreshToken()`	Used only when calling this API for the Refresh Token grant type.
`List<String>`	`scope()`	The list of scopes for which authorization is requested.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateTokenRequest.Builder>`	`serializableBuilderClass()`
`CreateTokenRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientId
```
public final String clientId()
```
    The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
    
    Returns:
    
    The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
  - clientSecret
```
public final String clientSecret()
```
    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
    
    Returns:
    
    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
  - grantType
```
public final String grantType()
```
    Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:
    
    * Device Code - urn:ietf:params:oauth:grant-type:device_code
    
    * Refresh Token - refresh_token
    
    For information about how to obtain the device code, see the StartDeviceAuthorization topic.
    
    Returns:
    
    Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:
    
    * Device Code - urn:ietf:params:oauth:grant-type:device_code
    
    * Refresh Token - refresh_token
    
    For information about how to obtain the device code, see the StartDeviceAuthorization topic.
  - deviceCode
```
public final String deviceCode()
```
    Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
    
    Returns:
    
    Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
  - code
```
public final String code()
```
    Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
    
    Returns:
    
    Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
  - refreshToken
```
public final String refreshToken()
```
    Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
    
    For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
    
    Returns:
    
    Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
    
    For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
  - hasScope
```
public final boolean hasScope()
```
    For responses, this returns true if the service returned a value for the Scope property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - scope
```
public final List<String> scope()
```
    The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScope() method.
    
    Returns:
    
    The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
  - redirectUri
```
public final String redirectUri()
```
    Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
    
    Returns:
    
    Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
  - codeVerifier
```
public final String codeVerifier()
```
    Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
    
    Returns:
    
    Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
  - toBuilder
```
public CreateTokenRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>
    
    Specified by:
    
    toBuilder in class SsoOidcRequest
  - builder
```
public static CreateTokenRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateTokenRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateTokenRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientId

clientSecret

grantType

deviceCode

code

refreshToken

hasScope

scope

redirectUri

codeVerifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields