@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.258.0 (2023-01-25)

Bug Fixes

• clients: fix restXml protocol test for timestampFormat targets (#4364) (4beb93b)

Features

• client-cloudformation: Enabled FIPS aws-us-gov endpoints in SDK. (6eef788)
• client-ec2: This release adds new functionality that allows customers to provision IPv6 CIDR blocks through Amazon VPC IP Address Manager (IPAM) as well as allowing customers to utilize IPAM Resource Discovery APIs. (8973fbd)
• client-m2: Add returnCode, batchJobIdentifier in GetBatchJobExecution response, for user to view the batch job execution result & unique identifier from engine. Also removed unused headers from REST APIs (717df3e)
• client-polly: Add 5 new neural voices - Sergio (es-ES), Andres (es-MX), Remi (fr-FR), Adriano (it-IT) and Thiago (pt-BR). (dba9471)
• client-s3-control: Add additional endpoint tests for S3 Control. Fix missing endpoint parameters for PutBucketVersioning and GetBucketVersioning. Prior to this fix, those operations may have resulted in an invalid endpoint being resolved. (f699098)
• client-sagemaker: SageMaker Inference Recommender now decouples from Model Registry and could accept Model Name to invoke inference recommendations job; Inference Recommender now provides CPU/Memory Utilization metrics data in recommendation output. (bf7623f)
• clients: update client endpoints as of 2023-01-25 (98f956f)