String clientId
The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.
String clientSecret
A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
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.
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.
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.
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.
List<E> 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.
String redirectUri
The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.
String accessToken
An opaque token to access IAM Identity Center resources assigned to a user.
String tokenType
Used to notify the client that the returned token is an access token. The supported type is
BearerToken.
Integer expiresIn
Indicates the time in seconds when an access token will expire.
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.
A token that, if present, can be used to refresh a previously issued access token that might have expired.
String idToken
Currently, idToken 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 identifier of the user that associated with the access token, if present.
String clientName
The friendly name of the client.
String clientType
The type of client. The service supports only public as a client type. Anything other than public
will be rejected by the service.
List<E> scopes
The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
String clientId
The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.
String clientSecret
A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.
Long clientIdIssuedAt
Indicates the time at which the clientId and clientSecret were issued.
Long clientSecretExpiresAt
Indicates the time at which the clientId and clientSecret will become invalid.
String authorizationEndpoint
The endpoint where the client can request authorization.
String tokenEndpoint
The endpoint where the client can get an access token.
String clientId
The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.
String clientSecret
A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.
String startUrl
The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide.
String deviceCode
The short-lived code that is used by the device when polling for a session token.
String userCode
A one-time user verification code. This is needed to authorize an in-use device.
String verificationUri
The URI of the verification page that takes the userCode to authorize the device.
String verificationUriComplete
An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
Integer expiresIn
Indicates the number of seconds in which the verification code will become invalid.
Integer interval
Indicates the number of seconds the client must wait between attempts when polling for a session.
Copyright © 2023. All rights reserved.