(constructor)

[configuration]

Constructs a new instance of the <code>SSOOIDCClient</code> class

config

The resolved configuration of SSOOIDCClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-sso-oidc!SSOOIDCClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

SSOOIDCClient

IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center. <note> IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. </note> Considerations for Using This Guide Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works. <ul> <li> The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single sign-on authentication with the CLI. </li> <li> With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </li> <li> The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application. </li> <li> The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the IAM Identity Center Portal API Reference Guide. </li> </ul> For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is IAM Identity Center?</a> in the IAM Identity Center User Guide.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateTokenCommand

Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs using <code>bearer</code> authentication.

CreateTokenWithIAMCommand

Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. The access token can be used to fetch short-term credentials for the assigned Amazon Web Services accounts or to access application APIs using <code>bearer</code> authentication.

RegisterClientCommand

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.

StartDeviceAuthorizationCommand

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