@aws-sdk/client-sso-oidc
Description
AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
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.
IAM Identity Center uses the sso
and identitystore
API namespaces.
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.
-
The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device
Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single
sign-on authentication with the CLI.
-
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 Configure Amazon Web Services access portal session duration .
-
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.
-
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 GetRoleCredentials in the IAM Identity Center Portal API Reference
Guide.
For general information about IAM Identity Center, see What is
IAM Identity Center? in the IAM Identity Center User Guide.
Installing
To install the this package, simply type add or install @aws-sdk/client-sso-oidc
using your favorite package manager:
npm install @aws-sdk/client-sso-oidc
yarn add @aws-sdk/client-sso-oidc
pnpm add @aws-sdk/client-sso-oidc
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SSOOIDCClient
and
the commands you need, for example CreateTokenCommand
:
const { SSOOIDCClient, CreateTokenCommand } = require("@aws-sdk/client-sso-oidc");
import { SSOOIDCClient, CreateTokenCommand } from "@aws-sdk/client-sso-oidc";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new SSOOIDCClient({ region: "REGION" });
const params = {
};
const command = new CreateTokenCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-sso-oidc";
const client = new AWS.SSOOIDC({ region: "REGION" });
try {
const data = await client.createToken(params);
} catch (error) {
}
client
.createToken(params)
.then((data) => {
})
.catch((error) => {
});
client.createToken(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sso-oidc
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
CreateToken
Command API Reference / Input / Output
CreateTokenWithIAM
Command API Reference / Input / Output
RegisterClient
Command API Reference / Input / Output
StartDeviceAuthorization
Command API Reference / Input / Output