AWS.SSOOIDC (aws-elixir v0.8.0) View Source

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO.

The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628). For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Link to this section Summary

Functions

Creates and returns an access token for the authorized client.

Registers a client with AWS SSO.

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Link to this section Functions

Link to this function

create_token(client, input, options \\ [])

View Source

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.

Link to this function

register_client(client, input, options \\ [])

View Source

Registers a client with AWS SSO.

This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

Link to this function

start_device_authorization(client, input, options \\ [])

View Source

Initiates device authorization by requesting a pair of verification codes from the authorization service.