API version 2019-06-10 of the Amazon SSO OIDC SDK configuration.

You do not have sufficient access to perform this action.

Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range.

Indicates that the scope provided in the request is invalid.

Indicates that the grant type in the request is not supported by the service.

Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret.

Indicates that the client information sent in the request during registration is invalid.

Indicates that the client is not currently authorized to make the request. This can happen when a clientId is not issued for a public client.

Indicates that the client is making the request too frequently and is more than the service can handle.

Indicates that an error from the service occurred while trying to process a request.

Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type.

Indicates that a request to authorize a client with an access user session token is pending.

Indicates that the token issued by the service is expired and is no longer valid.

See: newStartDeviceAuthorization smart constructor.

Create a value of StartDeviceAuthorization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientId:StartDeviceAuthorization', startDeviceAuthorization_clientId - The unique identifier string for the client that is registered with AWS SSO. This value should come from the persisted result of the RegisterClient API operation.

$sel:clientSecret:StartDeviceAuthorization', startDeviceAuthorization_clientSecret - A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.

$sel:startUrl:StartDeviceAuthorization', startDeviceAuthorization_startUrl - The URL for the AWS SSO user portal. For more information, see Using the User Portal in the AWS Single Sign-On User Guide.

See: newStartDeviceAuthorizationResponse smart constructor.

Create a value of StartDeviceAuthorizationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userCode:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_userCode - A one-time user verification code. This is needed to authorize an in-use device.

$sel:interval:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_interval - Indicates the number of seconds the client must wait between attempts when polling for a session.

$sel:expiresIn:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_expiresIn - Indicates the number of seconds in which the verification code will become invalid.

$sel:verificationUri:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_verificationUri - The URI of the verification page that takes the userCode to authorize the device.

$sel:deviceCode:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_deviceCode - The short-lived code that is used by the device when polling for a session token.

$sel:verificationUriComplete:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_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.

$sel:httpStatus:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_httpStatus - The response's http status code.

See: newCreateToken smart constructor.

Create a value of CreateToken with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:redirectUri:CreateToken', createToken_redirectUri - The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

$sel:refreshToken:CreateToken', createToken_refreshToken - 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.

$sel:scope:CreateToken', createToken_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.

$sel:code:CreateToken', createToken_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.

$sel:clientId:CreateToken', createToken_clientId - The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

$sel:clientSecret:CreateToken', createToken_clientSecret - A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

$sel:grantType:CreateToken', createToken_grantType - Supports grant types for authorization code, refresh token, and device code request.

$sel:deviceCode:CreateToken', createToken_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.

See: newCreateTokenResponse smart constructor.

Create a value of CreateTokenResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessToken:CreateTokenResponse', createTokenResponse_accessToken - An opaque token to access AWS SSO resources assigned to a user.

$sel:refreshToken:CreateToken', createTokenResponse_refreshToken - A token that, if present, can be used to refresh a previously issued access token that might have expired.

$sel:expiresIn:CreateTokenResponse', createTokenResponse_expiresIn - Indicates the time in seconds when an access token will expire.

$sel:tokenType:CreateTokenResponse', createTokenResponse_tokenType - Used to notify the client that the returned token is an access token. The supported type is BearerToken.

$sel:idToken:CreateTokenResponse', createTokenResponse_idToken - The identifier of the user that associated with the access token, if present.

$sel:httpStatus:CreateTokenResponse', createTokenResponse_httpStatus - The response's http status code.

See: newRegisterClient smart constructor.

Create a value of RegisterClient with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:scopes:RegisterClient', registerClient_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.

$sel:clientName:RegisterClient', registerClient_clientName - The friendly name of the client.

$sel:clientType:RegisterClient', registerClient_clientType - The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

See: newRegisterClientResponse smart constructor.

Create a value of RegisterClientResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientId:RegisterClientResponse', registerClientResponse_clientId - The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.

$sel:clientSecret:RegisterClientResponse', registerClientResponse_clientSecret - A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.

$sel:clientIdIssuedAt:RegisterClientResponse', registerClientResponse_clientIdIssuedAt - Indicates the time at which the clientId and clientSecret were issued.

$sel:clientSecretExpiresAt:RegisterClientResponse', registerClientResponse_clientSecretExpiresAt - Indicates the time at which the clientId and clientSecret will become invalid.

$sel:tokenEndpoint:RegisterClientResponse', registerClientResponse_tokenEndpoint - The endpoint where the client can get an access token.

$sel:authorizationEndpoint:RegisterClientResponse', registerClientResponse_authorizationEndpoint - The endpoint where the client can request authorization.

$sel:httpStatus:RegisterClientResponse', registerClientResponse_httpStatus - The response's http status code.