@aws-sdk/client-sso-oidc

What is @aws-sdk/client-sso-oidc?

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.

What are @aws-sdk/client-sso-oidc's main functionalities?

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);
});

Other packages similar to @aws-sdk/client-sso-oidc

openid-client

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.

passport-azure-ad

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.

amazon-cognito-identity-js

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.

README

@aws-sdk/client-sso-oidc

Description

AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.

AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a client (such as AWS 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.

Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.

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 AWS CLI. Support for other OIDC flows frequently needed for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in future releases.

• The service emits only OIDC access tokens, such that obtaining a new token (For example, token refresh) requires explicit user re-authentication.

• The access tokens provided by this service grant access to all AWS 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 AWS Auth (“sigv4”) credentials for use with IAM-protected AWS 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:

// ES5 example
const { SSOOIDCClient, CreateTokenCommand } = require("@aws-sdk/client-sso-oidc");

// ES6+ example
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.

// 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:

// 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.

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.
  });

Callbacks

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.
});

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" });

// 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.
});

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);
  // 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;
   * }
   */
}

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.

• 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.

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

RegisterClient

Command API Reference / Input / Output

StartDeviceAuthorization

Command API Reference / Input / Output

Changelog

3.297.0 (2023-03-22)

Features

• client-iottwinmaker: This release adds support of adding metadata when creating a new scene or updating an existing scene. (98c2508)
• client-pipes: This release improves validation on the ARNs in the API model (62c1580)
• client-resiliencehub: This release provides customers with the ability to import resources from within an EKS cluster and assess the resiliency of EKS cluster workloads. (bb17cb4)
• client-ssm: This Patch Manager release supports creating, updating, and deleting Patch Baselines for AmazonLinux2023, AlmaLinux. (3094ca5)
• clients: update client endpoints as of 2023-03-22 (86334b3)