@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.226.0 (2022-12-07)

Bug Fixes

• codegen: remove unused import (#4260) (d65ca1b)
• types: add missing tslib dependency to types (#4128) (5dab646)

Features

• client-cloudfront: Introducing UpdateDistributionWithStagingConfig that can be used to promote the staging configuration to the production. (ce728a2)
• client-cost-explorer: This release adds the LinkedAccountName field to the GetAnomalies API response under RootCause (cef502f)
• client-eks: Adds support for EKS add-ons configurationValues fields and DescribeAddonConfiguration function (47f65dd)
• clients: update client endpoints as of 2022-12-07 (eea62b4)