@aws-sdk/client-sso-oidc
Advanced tools
AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native
The @aws-sdk/client-sso-oidc package is a client library for AWS Single Sign-On OIDC (OpenID Connect) service. It allows developers to programmatically interact with the AWS SSO OIDC service to create and manage authentication tokens for federated users accessing AWS resources.
CreateToken
This feature allows you to create a new token for a registered client. This is typically used to get an access token using a refresh token.
const { SSOOIDCClient, CreateTokenCommand } = require('@aws-sdk/client-sso-oidc');
const client = new SSOOIDCClient({ region: 'us-west-2' });
const command = new CreateTokenCommand({
clientId: 'exampleClientId',
clientSecret: 'exampleClientSecret',
grantType: 'refresh_token',
refreshToken: 'exampleRefreshToken',
scope: ['aws.cognito.signin.user.admin']
});
client.send(command).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
});RegisterClient
This feature is used to register a new client with AWS SSO OIDC service. It is the first step in setting up the OIDC relationship.
const { SSOOIDCClient, RegisterClientCommand } = require('@aws-sdk/client-sso-oidc');
const client = new SSOOIDCClient({ region: 'us-west-2' });
const command = new RegisterClientCommand({
clientName: 'exampleClientName',
clientType: 'public',
scopes: ['aws.cognito.signin.user.admin']
});
client.send(command).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
});StartDeviceAuthorization
This feature initiates the device authorization flow by getting a device code that can be used by end-users to authorize their device.
const { SSOOIDCClient, StartDeviceAuthorizationCommand } = require('@aws-sdk/client-sso-oidc');
const client = new SSOOIDCClient({ region: 'us-west-2' });
const command = new StartDeviceAuthorizationCommand({
clientId: 'exampleClientId',
clientSecret: 'exampleClientSecret',
startUrl: 'https://my-sso-start-url.example.com'
});
client.send(command).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
});The openid-client package is a server-side library that allows you to interact with OpenID Connect (OIDC) providers. It is more generic than @aws-sdk/client-sso-oidc and can be used with any OIDC-compliant provider, not just AWS SSO.
This package is a collection of Passport strategies to help you integrate with Azure Active Directory. It is similar to @aws-sdk/client-sso-oidc in that it deals with OIDC, but it is specifically tailored for Azure AD rather than AWS SSO.
While not strictly for OIDC, amazon-cognito-identity-js is an AWS library that allows you to work with Amazon Cognito, which can act as an OIDC identity provider. It provides user authentication and access control features similar to what you might use @aws-sdk/client-sso-oidc for, but it is specific to Amazon Cognito.
AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
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.
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-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:
// ES5 example
const { SSOOIDCClient, CreateTokenCommand } = require("@aws-sdk/client-sso-oidc");
// ES6+ example
import { SSOOIDCClient, CreateTokenCommand } from "@aws-sdk/client-sso-oidc";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new SSOOIDCClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new CreateTokenCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// 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.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
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" });
// 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).
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.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.
3.161.0 (2022-08-30)
FAQs
AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-sso-oidc receives a total of 13,127,183 weekly downloads. As such, @aws-sdk/client-sso-oidc popularity was classified as popular.
We found that @aws-sdk/client-sso-oidc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.