sso_start_url - AWS SDKs and Tools

sso_start_url

Specifies the URL that points to the organization's AWS Single Sign-On (AWS SSO) user portal.

Details

When the AWS SSO settings are specified in a profile, the SDK or tool connects to the AWS SSO portal specified in sso_start_url and sso_region. After the user successfully authenticates with AWS SSO, the portal returns short-term credentials for the IAM role specified by the sso_account_id and sso_role_name.

Default value: None. You must set this value explicitly if you want to use AWS SSO.

Valid values: Must be a valid URL that points to your organization's AWS SSO portal.

If you set this value, you must also set sso_account_id, sso_region, and sso_role_name in the same profile.

Ways to set this value

Location Supported Example
config file Yes
sso_start_url = https://my-sso-portal.awsapps.com/start sso_role_name = SSOReadOnlyRole sso_region = us-east-1 sso_account_id = 123456789012
credentials file -
Environment variable -
AWS CLI parameter -

Compatibility with AWS SDKS and tools