Skip to content

Commit

Permalink
Update Configuring the SDK's guide for SSO rebranding. (#1782)
Browse files Browse the repository at this point in the history
Updates the Configuring the AWS SDK for Go V2 page's single sign-on guide to use updated SSO branding. The AWS Single Sign-On Credentials section was updated to Single Sign-On Credentials. Along with updates to the section's wording for better clarity.
  • Loading branch information
Paul-B-AWS committed Aug 2, 2022
1 parent 232d833 commit 4801133
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions content/en/docs/configuring-sdk/_index.md
Expand Up @@ -362,16 +362,16 @@ Do not embed credentials inside an application. Use this
method only for testing purposes.
{{% /pageinfo %}}

#### {{% alias service=SSOlong %}} Credentials
#### Single Sign-on Credentials

The SDK provides a credential provider for retrieving temporary AWS credentials using {{% alias service=SSOlong %}}.
Using the {{% alias service=CLI %}} you authenticate with the {{% alias service=SSO %}} user portal and authorize access to temporary
AWS credentials. You then configure your application to load the {{% alias service=SSO %}} profile, and the SDK uses your
{{% alias service=SSO %}} credentials to retrieve temporary AWS credentials that will be automatically renewed if expired.
If your {{% alias service=SSO %}} credentials expire, you must explicitly renew them by logging in to your
{{% alias service=SSO %}} account again using the {{% alias CLI %}}.
Using the {{% alias service=CLI %}}, you authenticate with the AWS access portal and authorize access to temporary
AWS credentials. You then configure your application to load the single sign-on (SSO) profile, and the SDK uses your
SSO credentials to retrieve temporary AWS credentials that will be automatically renewed if expired.
If your SSO credentials expire, you must explicitly renew them by logging in to your
{{% alias service=SSO %}} account again using the {{% alias service=CLI %}}.

For example, you can create a profile `dev-profile`, authenticate and authorize that profile using the
For example, you can create a profile, `dev-profile`, authenticate and authorize that profile using the
{{% alias service=CLI %}}, and configure your application as shown below.

1. First create the `dev-profile`
Expand All @@ -383,7 +383,7 @@ sso_account_id = 012345678901
sso_role_name = Developer
region = us-east-1
```
2. Login using the {{% alias service=CLI %}} to authenticate and authorize the {{% alias service=SSO %}} profile.
2. Login using the {{% alias service=CLI %}} to authenticate and authorize the SSO profile.
```
$ aws sso login --profile dev-profile
Attempting to automatically open the SSO authorization page in your default browser.
Expand All @@ -396,7 +396,7 @@ Then enter the code:
ABCD-EFGH
Successully logged into Start URL: https://company-sso-portal.awsapps.com/start
```
3. Next configure your application to use the {{% alias service=SSO %}} profile.
3. Next configure your application to use the SSO profile.
```go
import "github.com/aws/aws-sdk-go-v2/config"

Expand All @@ -412,10 +412,10 @@ if err != nil {
```

For more information on configuring
{{% alias service=SSO %}} profiles and authenticating using the {{% alias service=CLI %}} see
[Configuring the {{% alias service=CLI %}} use {{% alias service=SSOlong %}}](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html)
SSO profiles and authenticating using the {{% alias service=CLI %}} see
[Configuring the {{% alias service=CLI %}} to use {{% alias service=SSOlong %}}](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html)
in the {{% alias service=CLI %}} User Guide. For more information on programmatically constructing the
{{% alias service=SSO %}} credential provider see the [ssocreds]({{< apiref "credentials/ssocreds" >}}) API reference
SSO credential provider see the [ssocreds]({{< apiref "credentials/ssocreds" >}}) API reference
documentation.

#### Other Credentials Providers
Expand Down
4 changes: 2 additions & 2 deletions data/aliases.toml
Expand Up @@ -340,8 +340,8 @@ SQSlong = "Amazon Simple Queue Service"
SQS = "Amazon SQS"
SSMlong = "Amazon EC2 Simple Systems Manager"
SSM = "SSM"
SSOlong = "AWS Single Sign-On"
SSO = "AWS SSO"
SSOlong = "AWS IAM Identity Center (successor to AWS Single Sign-On)"
SSO = "IAM Identity Center"
STSlong = "AWS Security Token Service"
STS = "AWS STS"
sumerianlong = "Amazon Sumerian"
Expand Down

0 comments on commit 4801133

Please sign in to comment.