software.amazon.awssdk.services.ssooidc.model

Class CreateTokenRequest

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(value="software.amazon.awssdk:codegen")
public final class CreateTokenRequest
extends SsoOidcRequest
implements ToCopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTokenRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTokenRequest.Builder	builder()
String	clientId() The unique identifier string for each client.
String	clientSecret() A secret string generated for the client.
String	code() The authorization code received from the authorization service.
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 grant types for the authorization code, refresh token, and device code request.
int	hashCode()
boolean	hasScope() For responses, this returns true if the service returned a value for the Scope property.
String	redirectUri() The location of the application that will receive the authorization code.
String	refreshToken() Currently, refreshToken is not yet implemented and is not supported.
List<String>	scope() The list of scopes that is defined by the client.
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 each client. This value should come from the persisted result of the RegisterClient API.

Returns:

The unique identifier string for each client. This value should come from the persisted 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 grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

Returns:

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

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 authentication attempt. This should come from an in-memory reference to 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 authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

code

public final String code()

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:

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

refreshToken

public final String refreshToken()

Currently, refreshToken is not yet implemented and is not supported. 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.

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

Returns:

Currently, refreshToken is not yet implemented and is not supported. 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.

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

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 that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

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 that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

redirectUri

public final String redirectUri()

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

Returns:

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

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