@aws-sdk/client-sso

What is @aws-sdk/client-sso?

The @aws-sdk/client-sso package is a client library for AWS Single Sign-On (SSO) that allows developers to interact with the AWS SSO service programmatically. It provides methods to manage SSO access to AWS accounts and applications, retrieve user credentials, and manage SSO sessions.

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

GetRoleCredentials

This feature allows you to retrieve the temporary credentials for an AWS role that the user has access to through AWS SSO.

const { SSOClient, GetRoleCredentialsCommand } = require('@aws-sdk/client-sso');
const client = new SSOClient({ region: 'us-west-2' });
const command = new GetRoleCredentialsCommand({
  accountId: '123456789012',
  roleName: 'MyRoleName',
  accessToken: 'myAccessToken'
});
client.send(command).then((data) => {
  console.log(data.roleCredentials);
});

ListAccounts

This feature lists all AWS accounts assigned to the user through AWS SSO.

const { SSOClient, ListAccountsCommand } = require('@aws-sdk/client-sso');
const client = new SSOClient({ region: 'us-west-2' });
const command = new ListAccountsCommand({
  accessToken: 'myAccessToken'
});
client.send(command).then((data) => {
  console.log(data.accountList);
});

Logout

This feature logs the user out of all AWS SSO sessions.

const { SSOClient, LogoutCommand } = require('@aws-sdk/client-sso');
const client = new SSOClient({ region: 'us-west-2' });
const command = new LogoutCommand({
  accessToken: 'myAccessToken'
});
client.send(command).then(() => {
  console.log('Successfully logged out');
});

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

aws-sdk

The 'aws-sdk' package is the older version of the AWS SDK for JavaScript. It provides a comprehensive feature set for interacting with AWS services, including AWS SSO. However, it is not as modular as the newer '@aws-sdk/client-sso' and might result in larger bundle sizes if only a subset of services is needed.

aws-amplify

The 'aws-amplify' package is a library designed to help build scalable full-stack applications on AWS. It includes authentication features through Amazon Cognito, which can be integrated with AWS SSO for user sign-in and access control. It is a higher-level abstraction compared to '@aws-sdk/client-sso' and includes a broader set of features beyond AWS service interaction.

README

@aws-sdk/client-sso

Description

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

AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

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.

This reference guide describes the IAM Identity Center Portal 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, or Android. The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Installing

To install the this package, simply type add or install @aws-sdk/client-sso using your favorite package manager:

• npm install @aws-sdk/client-sso
• yarn add @aws-sdk/client-sso
• pnpm add @aws-sdk/client-sso

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the SSOClient and the commands you need, for example ListAccountsCommand:

// ES5 example
const { SSOClient, ListAccountsCommand } = require("@aws-sdk/client-sso");

// ES6+ example
import { SSOClient, ListAccountsCommand } from "@aws-sdk/client-sso";

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 SSOClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListAccountsCommand(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";
const client = new AWS.SSO({ region: "REGION" });

// async/await.
try {
  const data = await client.listAccounts(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAccounts(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listAccounts(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 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)

GetRoleCredentials

Command API Reference / Input / Output

ListAccountRoles

Command API Reference / Input / Output

ListAccounts

Command API Reference / Input / Output

Logout

Command API Reference / Input / Output

Changelog

3.421.0 (2023-09-27)

Features

• client-cognito-identity-provider: The UserPoolType Status field is no longer used. (114788d)
• client-firehose: Features : Adding support for new data ingestion source to Kinesis Firehose - AWS Managed Services Kafka. (f392d88)
• client-iot: Added support for IoT Rules Engine Kafka Action Headers (607458d)
• client-textract: This release adds new feature - Layout to Analyze Document API which can automatically extract layout elements such as titles, paragraphs, headers, section headers, lists, page numbers, footers, table areas, key-value areas and figure areas and order the elements as a human would read. (10647e5)
• clients: update client endpoints as of 2023-09-27 (e7cded8)