Sso Oidc
This page documents function available when using the Sso_Oidc
module, created with @service Sso_Oidc
.
Index
Documentation
Main.Sso_Oidc.create_token
— Methodcreate_token(client_id, client_secret, grant_type)
create_token(client_id, client_secret, grant_type, params::Dict{String,<:Any})
Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.
Arguments
client_id
: The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.client_secret
: A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.grant_type
: 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"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."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."redirectUri"
: The location of the application that will receive the authorization code. Users authorize the service to send the request to this location."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."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.
Main.Sso_Oidc.register_client
— Methodregister_client(client_name, client_type)
register_client(client_name, client_type, params::Dict{String,<:Any})
Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
Arguments
client_name
: The friendly name of the client.client_type
: The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"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.
Main.Sso_Oidc.start_device_authorization
— Methodstart_device_authorization(client_id, client_secret, start_url)
start_device_authorization(client_id, client_secret, start_url, params::Dict{String,<:Any})
Initiates device authorization by requesting a pair of verification codes from the authorization service.
Arguments
client_id
: 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.client_secret
: A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.start_url
: The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide.