AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native
npm install @aws-sdk/client-sso-oidcAWS 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.
API namespaces
IAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center
OpenID Connect uses the sso-oauth namespace.
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.
npm install @aws-sdk/client-sso-oidcyarn add @aws-sdk/client-sso-oidcpnpm add @aws-sdk/client-sso-oidcThe 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:
``js`
// ES5 example
const { SSOOIDCClient, CreateTokenCommand } = require("@aws-sdk/client-sso-oidc");
`ts`
// ES6+ example
import { SSOOIDCClient, CreateTokenCommand } from "@aws-sdk/client-sso-oidc";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new SSOOIDCClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new CreateTokenCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// 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.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and 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
`ts
import * as AWS from "@aws-sdk/client-sso-oidc";
const client = new AWS.SSOOIDC({ region: "REGION" });
// async/await.
try {
const data = await client.createToken(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.createToken(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.createToken(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
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.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
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.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
CreateToken
Command API Reference / Input / Output
CreateTokenWithIAM
Command API Reference / Input / Output
RegisterClient
Command API Reference / Input / Output
StartDeviceAuthorization