Skip to content

Commit 71e8b98

Browse files
authored
DEV-2606: Okta setup instructions (#699)
1 parent d6dd170 commit 71e8b98

File tree

1 file changed

+44
-4
lines changed

1 file changed

+44
-4
lines changed

docs/layers/identity/aws-saml.mdx

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,18 @@ identity. You can use this federated identity to connect directly to a given AWS
3232
<TabItem value="google" label="Google Workspace">
3333
Follow the [AWS documentation for Google Workspace](https://aws.amazon.com/blogs/desktop-and-application-streaming/setting-up-g-suite-saml-2-0-federation-with-amazon-appstream-2-0/). Once you have completed the setup, download the metadata file.
3434
</TabItem>
35-
3635
<TabItem value="okta" label="Okta">
37-
Follow the [Okta documentation](https://help.okta.com/en-us/Content/Topics/DeploymentGuides/AWS/aws-configure-identity-provider.htm). Once you have completed the setup, download the metadata file.
36+
37+
<Steps>
38+
1. Create an "Amazon Web Services Account Federation" application in Okta.
39+
1. Select "SAML 2.0" from the Sign-On Method.
40+
1. View and download the identity provider (IdP) metadata file.
41+
</Steps>
42+
43+
For details, please see the official [Okta documentation](https://help.okta.com/en-us/Content/Topics/DeploymentGuides/AWS/aws-configure-identity-provider.htm)
3844
</TabItem>
3945

40-
<TabItem value="jumpcloud" label="Jumpcloud">
46+
<TabItem value="jumpcloud" label="JumpCloud">
4147
Follow the [JumpCloud documentation](https://support.jumpcloud.com/support/s/article/getting-started-applications-saml-sso2). Once you have completed the setup, download the metadata file.
4248
</TabItem>
4349

@@ -51,18 +57,52 @@ identity. You can use this federated identity to connect directly to a given AWS
5157
<Step>
5258
## <StepNumber/> Import the metadata file from the chosen provider.
5359

60+
Download and save the metadata file with the `aws-saml` component directory.
61+
5462
<Steps>
5563
1. Place this file inside the `aws-saml` component directory (`components/terraform/aws-saml/`)
56-
2. Commit this to version control. The filename should match the variable configured in `stacks/catalog/aws-saml.yaml`.
64+
1. The filename should match the variable configured in the `aws-saml` stack catalog (`stacks/catalog/aws-saml.yaml`).
65+
1. Commit this to version control.
5766
</Steps>
67+
68+
<Tabs>
69+
<TabItem value="okta" label="Okta">
70+
71+
Make sure the `var.saml_providers` map key ends with `-okta`. We filter by this suffix to determine whether or not to set up a dedicated user for Okta. This is only necessary for Okta.
72+
73+
```yaml
74+
saml_providers:
75+
acme-okta: "OktaIDPMetadata-acme.com.xml"
76+
```
77+
</TabItem>
78+
</Tabs>
5879
</Step>
5980
6081
<Step>
6182
## <StepNumber/> Deploy the SAML Integration
6283
84+
Deploy the `aws-saml` component to your Identity account.
85+
6386
```bash
6487
atmos terraform apply aws-saml -s core-gbl-identity
6588
```
89+
90+
</Step>
91+
92+
<Step>
93+
## <StepNumber/> Complete the Identity Provider (IdP) setup
94+
95+
If necessary, complete the integration setup in your chosen IdP. This will vary depending on the provider.
96+
97+
<Tabs>
98+
<TabItem value="okta" label="Okta">
99+
100+
Follow the steps in the [official Okta documentation](https://help.okta.com/en-us/content/topics/deploymentguides/aws/aws-configure-aws-app.htm) to complete the setup. Please review the following tips, as we've encountered these issues in the past:
101+
102+
- Deploying the `aws-saml` component will create an AWS IAM User, which Okta will be used to discover roles in AWS. This user's access key and secret key are stored in AWS SSM Parameter Store in the same account and (default) region as the `aws-saml` component. This is unique for Okta.
103+
- In the "Provisioning" tab for the integration in Okta, you must check the **"Update User Attributes"** box. This does not appear in documentation but is necessary for the roles to populate in Okta.
104+
</TabItem>
105+
</Tabs>
66106
</Step>
67107

68108
<Step>

0 commit comments

Comments
 (0)