@aws-sdk/credential-provider-sso

What is @aws-sdk/credential-provider-sso?

The @aws-sdk/credential-provider-sso package is designed to facilitate the retrieval of AWS credentials using AWS Single Sign-On (SSO). This is particularly useful for developers and applications that need to authenticate against AWS services using SSO. The package simplifies the process of obtaining temporary credentials for AWS SDK clients.

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

Obtaining AWS credentials from SSO

This feature allows developers to obtain AWS credentials by specifying the SSO start URL, account ID, region, and role name. The credentials can then be used to authenticate AWS SDK clients.

const { fromSSO } = require('@aws-sdk/credential-provider-sso');
const client = new SomeAwsClient({
  credentials: fromSSO({
    ssoStartUrl: 'https://my-sso-start-url.example.com',
    ssoAccountId: '123456789012',
    ssoRegion: 'us-west-2',
    ssoRoleName: 'MyRoleName'
  })
});

Other packages similar to @aws-sdk/credential-provider-sso

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript. While it supports various methods of authentication, including credentials from environment variables, shared credentials file, and IAM roles for EC2 instances, it does not specifically focus on SSO credential retrieval like @aws-sdk/credential-provider-sso. However, it provides a broader scope of AWS service interactions.

aws-amplify

AWS Amplify is a development platform for building secure, scalable mobile and web applications. It includes support for authentication via Amazon Cognito, which can be integrated with SSO, but it's more focused on application development rather than directly providing AWS credentials for SDK clients. Compared to @aws-sdk/credential-provider-sso, AWS Amplify offers a higher-level abstraction for authentication and authorization.

README

@aws-sdk/credential-provider-sso

An internal package

Usage

You probably shouldn't, at least directly. Please use @aws-sdk/credential-providers instead.

Changelog

3.181.0 (2022-09-29)

Bug Fixes

• clients: make parseErrorBody async (#3999) (2558c93)
• clients: populate message field when parsing errors (#3995) (02e47f1)
• clients: update message in Error key in case of XML protocol (#4000) (057f686)

Features

• client-acm: This update returns additional certificate details such as certificate SANs and allows sorting in the ListCertificates API. (0afc7d5)
• client-ec2: u-3tb1 instances are powered by Intel Xeon Platinum 8176M (Skylake) processors and are purpose-built to run large in-memory databases. (66a6a45)
• client-emr-serverless: This release adds API support to debug Amazon EMR Serverless jobs in real-time with live application UIs (9a3cc54)
• client-fsx: This release adds support for Amazon File Cache. (0c9782d)
• client-migrationhuborchestrator: Introducing AWS MigrationHubOrchestrator. This is the first public release of AWS MigrationHubOrchestrator. (0c9f5df)
• client-polly: Added support for the new Cantonese voice - Hiujin. Hiujin is available as a Neural voice only. (9f1d83e)
• client-proton: This release adds an option to delete pipeline provisioning repositories using the UpdateAccountSettings API (bedb9af)
• client-sagemaker: SageMaker Training Managed Warm Pools let you retain provisioned infrastructure to reduce latency for repetitive training workloads. (85fc637)
• client-translate: This release enables customers to access control rights on Translate resources like Parallel Data and Custom Terminology using Tag Based Authorization. (2426699)
• client-workspaces: This release includes diagnostic log uploading feature. If it is enabled, the log files of WorkSpaces Windows client will be sent to Amazon WorkSpaces automatically for troubleshooting. You can use modifyClientProperty api to enable/disable this feature. (252939d)
• clients: support awsQueryError trait (#3998) (384cbd7)
• clients: update client endpoints as of 2022-09-29 (86f34f3)