@aws-sdk/credential-provider-web-identity

What is @aws-sdk/credential-provider-web-identity?

The @aws-sdk/credential-provider-web-identity npm package is designed to provide AWS credentials to your application by leveraging web identity tokens. This is particularly useful for applications that authenticate users through federated identity providers such as Amazon Cognito, Facebook, Google, or any OpenID Connect (OIDC) compatible identity provider. It simplifies the process of assuming an AWS IAM role by using the web identity token, allowing your application to access AWS services securely.

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

Creating credentials from web identity tokens

This feature allows you to create AWS credentials by providing a web identity token, the ARN of the role to assume, and a session name. It's particularly useful for serverless applications that rely on federated authentication.

const { fromWebToken } = require('@aws-sdk/credential-provider-web-identity');

const credentials = fromWebToken({
  roleArn: 'arn:aws:iam::123456789012:role/WebIdentityRole',
  roleSessionName: 'web-identity-session',
  webIdentityToken: process.env.WEB_IDENTITY_TOKEN
});

Other packages similar to @aws-sdk/credential-provider-web-identity

aws-sdk

The AWS SDK for JavaScript is a comprehensive package that includes support for creating credentials from web identity tokens, among many other AWS services. Compared to @aws-sdk/credential-provider-web-identity, the aws-sdk package is more extensive, offering a wide range of AWS services and not just credential provision. However, it might be heavier for applications that only require credential management.

amazon-cognito-identity-js

This package provides authentication capabilities for Amazon Cognito User Pools. It's similar to @aws-sdk/credential-provider-web-identity in that it deals with web identity and federated identities but is specifically tailored for Amazon Cognito, whereas @aws-sdk/credential-provider-web-identity is more generic and can work with any OpenID Connect compatible identity provider.

README

@aws-sdk/credential-provider-web-identity

An internal package

Usage

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

Changelog

3.370.0 (2023-07-13)

Bug Fixes

• codegen: pkg.json merge behavior (#4954) (4fc0b7f)
• lib-storage: add @smithy/abort-controller to dependencies (#4953) (d001e81)

Features

• client-cognito-identity-provider: API model updated in Amazon Cognito (a6c3b78)
• client-connect: Add support for deleting Queues and Routing Profiles. (243007b)
• client-database-migration-service: Enhanced PostgreSQL target endpoint settings for providing Babelfish support. (082547a)
• client-datasync: Added LunCount to the response object of DescribeStorageSystemResourcesResponse, LunCount represents the number of LUNs on a storage system resource. (c2a2e69)
• client-ec2: This release adds support for the C7gn and Hpc7g instances. C7gn instances are powered by AWS Graviton3 processors and the fifth-generation AWS Nitro Cards. Hpc7g instances are powered by AWS Graviton 3E processors and provide up to 200 Gbps network bandwidth. (b3fabe8)
• client-fsx: Amazon FSx for NetApp ONTAP now supports SnapLock, an ONTAP feature that enables you to protect your files in a volume by transitioning them to a write once, read many (WORM) state. (0641ce5)
• client-mediatailor: Adds categories to MediaTailor channel assembly alerts (107bce6)
• client-personalize: This release provides ability to customers to change schema associated with their datasets in Amazon Personalize (537b4b3)
• client-proton: This release adds support for deployment history for Proton provisioned resources (d1ec971)
• client-s3: S3 Inventory now supports Object Access Control List and Object Owner as available object metadata fields in inventory reports. (53ac18c)
• client-sagemaker: Amazon SageMaker Canvas adds WorkspeceSettings support for CanvasAppSettings (4fd0ab0)
• clients: update client endpoints as of 2023-07-13 (fbde913)