You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@aws-sdk/client-sso

Package Overview
Dependencies
Maintainers
5
Versions
337
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aws-sdk/client-sso

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


Version published
Maintainers
5
Created

Package description

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

Changelog

Source

3.616.0 (2024-07-18)

Bug Fixes

  • lib-storage: location in upload result should include custom port (#6282) (9d3cbb6)
  • middleware-sdk-s3: set consistent dependency versions (#6287) (207cd84)

Features

  • client-acm-pca: Fix broken waiters for the acm-pca client. Waiters broke in version 1.13.144 of the Boto3 SDK. (a867f6e)
  • client-connect: Amazon Connect expands search API coverage for additional resources. Search for hierarchy groups by name, ID, tag, or other criteria (new endpoint). Search for agent statuses by name, ID, tag, or other criteria (new endpoint). Search for users by their assigned proficiencies (enhanced endpoint) (226e9c6)
  • client-ec2: Amazon VPC IP Address Manager (IPAM) now supports Bring-Your-Own-IP (BYOIP) for IP addresses registered with any Internet Registry. This feature uses DNS TXT records to validate ownership of a public IP address range. (337c43d)
  • client-firehose: This release 1) Add configurable buffering hints for Snowflake as destination. 2) Add ReadFromTimestamp for MSK As Source. Firehose will start reading data from MSK Cluster using offset associated with this timestamp. 3) Gated public beta release to add Apache Iceberg tables as destination. (9a36c7e)
  • client-medialive: AWS Elemental MediaLive now supports the SRT protocol via the new SRT Caller input type. (91134df)
  • client-sagemaker: SageMaker Training supports R5, T3 and R5D instances family. And SageMaker Processing supports G5 and R5D instances family. (709db60)
  • client-taxsettings: Set default endpoint for aws partition. Requests from all regions in aws partition will be forward to us-east-1 endpoint. (7927892)
  • clients: update client endpoints as of 2024-07-18 (ac3e31b)

Readme

Source

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

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

FAQs

Package last updated on 18 Jul 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc