Wondering what’s next for npm?Check out our public roadmap! »

    @aws-sdk/credential-provider-sso
    TypeScript icon, indicating that this package has built-in type declarations

    3.15.0 • Public • Published

    @aws-sdk/credential-provider-sso

    NPM version NPM downloads

    AWS Credential Provider for Node.js - AWS Single Sign-On (SSO)

    This module provides a function, fromSSO that will create CredentialProvider functions that read from AWS SDKs and Tools shared configuration and credentials files(Profile appears in the credentials file will be given precedence over the profile found in the config file). This provider will load the resolved access token on local disk, and then request temporary AWS credentials. For the guidance over AWS Single Sign-On service, please refer to the service document.

    Supported configuration

    You may customize how credentials are resolved by providing an options hash to the fromSSO factory function. The following options are supported:

    • profile - The configuration profile to use. If not specified, the provider will use the value in the AWS_PROFILE environment variable or default by default.
    • filepath - The path to the shared credentials file. If not specified, the provider will use the value in the AWS_SHARED_CREDENTIALS_FILE environment variable or ~/.aws/credentials by default.
    • configFilepath - The path to the shared config file. If not specified, the provider will use the value in the AWS_CONFIG_FILE environment variable or ~/.aws/config by default.
    • ssoClient - The SSO Client that used to request AWS credentials with the SSO access token. If not specified, a default SSO client will be created with the region specified in the profile sso_region entry.

    SSO Login with AWS CLI

    This credential provider relies on AWS CLI to login to an AWS SSO session. Here's a brief walk-through:

    1. Create a new AWS SSO enabled profile using AWS CLI. It will ask you to login to your AWS SSO account and prompt for the name of the profile:
    $ aws configure sso
    ...
    ...
    CLI profile name [123456789011_ReadOnly]: my-sso-profile<ENTER>
    1. Configure you SDK client with the SSO credential provider:
    import { fromSSO } from "@aws-sdk/credential-provider-sso"; // ES6 example
    // const { fromSSO } = require(@aws-sdk/credential-provider-sso") // CommonJS example
    //...
    const client = new FooClient({ credentials: fromSSO({ profile: "my-sso-profile" });

    Alternatively, the SSO credential provider is supported in default Node.js credential provider:

    import { defaultProvider } from "@aws-sdk/credential-provider-node"; // ES6 example
    // const { defaultProvider } = require(@aws-sdk/credential-provider-node") // CommonJS example
    //...
    const client = new FooClient({ credentials: defaultProvider({ profile: "my-sso-profile" });
    1. To log out from the current SSO session, use AWS CLI:
    $ aws sso logout
    Successfully signed out of all SSO profiles.

    Sample files

    This credential provider is only applicable if the profile specified in shared configuration and credentials files contain ALL of the following entries:

    ~/.aws/credentials

    [sample-profile]
    sso_account_id = 012345678901
    sso_region = us-east-1
    sso_role_name = SampleRole
    sso_start_url = https://d-abc123.awsapps.com/start

    ~/.aws/config

    [profile sample-profile]
    sso_account_id = 012345678901
    sso_region = us-east-1
    sso_role_name = SampleRole
    sso_start_url = https://d-abc123.awsapps.com/start

    Install

    npm i @aws-sdk/credential-provider-sso

    DownloadsWeekly Downloads

    260,876

    Version

    3.15.0

    License

    Apache-2.0

    Unpacked Size

    283 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar