You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -232,69 +232,163 @@ For providers not included in the following section, please [follow the AWS docu
232
232
233
233
</TabItem>
234
234
235
-
<TabItemvalue="gsuite"label="GSuite and Other External IdPs">
235
+
<TabItemvalue="gsuite"label="Google Workspace">
236
236
<Intro>
237
-
For non-explicitly supported Identity Providers, such as GSuite, set up the app integration with a custom external
238
-
identity provider. The steps may be different for each IdP, but the goal is ultimately the same.
237
+
Google Workspace (formerly GSuite) can be used as an identity provider for AWS IAM Identity Center using SAML
238
+
authentication and SCIM provisioning. This setup requires a Google Workspace super administrator account.
239
239
</Intro>
240
240
241
-
:::tip aws-ssosync
241
+
:::caution Google Workspace SCIM Limitation
242
242
243
-
GSuite does not automatically sync _both_ Users and Groups with AWS Identity Center without additional configuration! If using
244
-
GSuite as an IdP, considering deploying the [ssosync](https://github.com/awslabs/ssosync) tool.
243
+
Google Workspace's SCIM automatic provisioning only syncs **users**, not groups. Groups must be created manually in
244
+
AWS Identity Center or synced using the [`ssosync`](https://github.com/awslabs/ssosync) tool.
245
245
246
-
Please see our [aws-ssosync component](/components/library/aws/aws-ssosync/) for details!
246
+
Please see our [aws-ssosync component](/components/library/aws/aws-ssosync/) for details.
247
247
248
248
:::
249
249
250
+
#### Setup Google Workspace SAML Application
251
+
250
252
<Steps>
251
253
<Step>
252
-
<StepNumber/> Open the Identity account in the AWS Console
254
+
#### <StepNumber/> Create the SAML Application in Google
255
+
256
+
Sign in to the [Google Admin console](https://admin.google.com) with super administrator privileges. Navigate
257
+
to **Apps** > **Web and Mobile Apps**, select **Add app** > **Search for apps**, and search for **Amazon Web
258
+
Services**. Select the SAML app.
259
+
260
+
On the **Google Identity Provider details** page, download the IdP metadata file. Keep this page open.
253
261
</Step>
254
262
<Step>
255
-
<StepNumber/> On the Dashboard page of the IAM Identity Center console, select Choose your identity source
263
+
#### <StepNumber/> Change the Identity Source in AWS
264
+
265
+
Sign in to the [IAM Identity Center console](https://console.aws.amazon.com/singlesignon) in the `core-root` account.
266
+
Go to **Settings** > **Actions** > **Change identity source**. Select **External identity provider** and click **Next**.
267
+
268
+
Upload the Google IdP metadata file you downloaded in the previous step.
269
+
270
+
Copy these two values from IAM Identity Center (you will need them in the next step):
271
+
- **Assertion Consumer Service (ACS) URL**
272
+
- **IAM Identity Center issuer URL**
256
273
</Step>
257
274
<Step>
258
-
<StepNumber/> In the Settings, choose the Identity source tab, select the Actions dropdown in the top right, and then select Change identity source
275
+
#### <StepNumber/> Configure Service Provider Details in Google
276
+
277
+
Return to the Google Admin console. On the **Service provider details** page, enter:
278
+
- **ACS URL**: Paste the IAM Identity Center ACS URL
279
+
- **Entity ID**: Paste the IAM Identity Center issuer URL
280
+
- **Start URL**: Leave empty
281
+
- **Name ID format**: Select `EMAIL`
282
+
- **Name ID**: Select `Basic Information > Primary email`
283
+
284
+
Click **Continue**.
259
285
</Step>
260
286
<Step>
261
-
<StepNumber/> By default, IAM Identity Center uses its own directory as the IdP. To use another IdP, you have to switch to an external identity provider. Select External identity provider from the available identity sources
287
+
#### <StepNumber/> Configure Attribute Mapping in Google
288
+
289
+
On the **Attribute Mapping** page, click **ADD MAPPING** and configure:
290
+
291
+
| Google Directory Attribute | App Attribute |
292
+
|---|---|
293
+
| Basic Information > Primary Email |`https://aws.amazon.com/SAML/Attributes/RoleSessionName`|
294
+
295
+
Click **Finish**. Then return to the IAM Identity Center console, review the configuration, type `ACCEPT`, and click **Change identity source**.
262
296
</Step>
263
297
<Step>
264
-
<StepNumber/> Configure the custom SAML application with the Service provider metadata generated from your IdP. Follow the next steps from your IdP, and then complete this AWS configuration afterwards
298
+
#### <StepNumber/> Enable the Application in Google Workspace
299
+
300
+
Return to the Google Admin Console. Navigate to **Apps** > **Web and Mobile Apps** and open the **AWS IAM
301
+
Identity Center** application. Expand **User access**, set the **Service status** to **ON for everyone**, and
302
+
click **Save**.
265
303
</Step>
304
+
</Steps>
305
+
306
+
#### Enable Automatic User Provisioning (SCIM)
307
+
308
+
<Steps>
266
309
<Step>
267
-
<StepNumber/> Open your chosen IdP
310
+
#### <StepNumber/> Generate SCIM Credentials in AWS
311
+
312
+
In IAM Identity Center, go to **Settings** and locate **Automatic provisioning**. Click **Enable**. Copy both the
313
+
**SCIM endpoint** URL and the **Access token**. These values are only shown once.
268
314
</Step>
269
315
<Step>
270
-
<StepNumber/> Create a new SSO application
316
+
#### <StepNumber/> Configure Auto Provisioning in Google
317
+
318
+
Return to the Google Admin Console and open the **AWS IAM Identity Center** application. In the **Auto
319
+
provisioning** section, click **Configure auto provisioning**.
320
+
321
+
Paste the **Access token** and **SCIM endpoint** URL from the previous step. Verify the attribute mappings, optionally
322
+
select a provisioning scope (Google Workspace group), and configure deprovisioning settings. Click **Finish**.
323
+
324
+
Toggle auto provisioning from **Inactive** to **Active**.
271
325
</Step>
272
326
<Step>
273
-
<StepNumber/> Download the new app's IdP metadata and use this to complete step 5 above
327
+
#### <StepNumber/> Verify User Sync
328
+
329
+
Return to IAM Identity Center and check the **Users** page. Users from Google Workspace should appear within a
330
+
few minutes, though provisioning can take up to 24 hours.
274
331
</Step>
332
+
</Steps>
333
+
334
+
:::info Additional References
335
+
336
+
-[AWS: Configure Google Workspace as an IdP](https://docs.aws.amazon.com/singlesignon/latest/userguide/gs-gwp.html)
337
+
— Official AWS guide including SAML setup ([Step 1](https://docs.aws.amazon.com/singlesignon/latest/userguide/gs-gwp.html#gs-gwp-step1)) and user provisioning ([Step 3](https://docs.aws.amazon.com/singlesignon/latest/userguide/gs-gwp.html#gs-gwp-step3))
338
+
-[AWS Blog: How to use Google Workspace as an external identity provider for AWS IAM Identity Center](https://aws.amazon.com/blogs/security/how-to-use-g-suite-as-external-identity-provider-aws-sso/)
339
+
340
+
:::
341
+
342
+
</TabItem>
343
+
344
+
<TabItemvalue="other"label="Other External IdPs">
345
+
<Intro>
346
+
For identity providers not explicitly listed above, set up the integration with a custom external
347
+
identity provider. The steps may differ for each IdP, but the goal is ultimately the same: configure SAML
348
+
authentication and user provisioning between your IdP and AWS IAM Identity Center.
349
+
</Intro>
350
+
351
+
For providers not included in this guide, refer to the [AWS documentation for supported IdP integrations](https://docs.aws.amazon.com/singlesignon/latest/userguide/supported-idps.html), which includes CyberArk, OneLogin, Ping Identity, and others.
352
+
353
+
<Steps>
275
354
<Step>
276
-
<StepNumber/> Fill in the Service provider details using the data from IAM Identity Center, and then choose Continue. The mapping for the data is as follows:
277
-
278
-
```
279
-
For ACS URL, enter the IAM Identity Center Assertion Consumer Service (ACS) URL.
280
-
For Entity ID, enter the IAM Identity Center issuer URL.
281
-
Leave the Start URL field empty.
282
-
For Name ID format, select EMAIL.
283
-
```
355
+
<StepNumber/> Open the Identity account (`core-root`) in the AWS Console
284
356
</Step>
285
357
<Step>
286
-
<StepNumber/> If required for the IdP, enable the application for all users
358
+
<StepNumber/> On the Dashboard page of the IAM Identity Center console, select **Choose your identity source**
287
359
</Step>
288
360
<Step>
289
-
<StepNumber/> Finally, define specific Groups to match the given Group names by the `aws-sso` component (`stacks/catalog/aws-sso.yaml`). In the default catalog, we define four Groups: `DevOps`, `Developers`, `BillingAdmin`, and `Everyone`
361
+
<StepNumber/> In the Settings, choose the **Identity source** tab, select the **Actions** dropdown, and then select **Change identity source**
290
362
</Step>
291
-
</Steps>
292
-
293
-
If set up properly, Users and Groups added to your IdP will automatically populate and update in AWS.
363
+
<Step>
364
+
<StepNumber/> Select **External identity provider** from the available identity sources. Download the **Service provider metadata** from AWS — you will need this for your IdP
365
+
</Step>
366
+
<Step>
367
+
<StepNumber/> Open your chosen IdP and create a new SAML/SSO application
368
+
</Step>
369
+
<Step>
370
+
<StepNumber/> Download the new app's IdP metadata and upload it to AWS IAM Identity Center
371
+
</Step>
372
+
<Step>
373
+
<StepNumber/> Fill in the Service provider details in your IdP using the data from IAM Identity Center:
294
374
295
-
Additional IdP specific setup reference can be found here:
375
+
-**ACS URL**: The IAM Identity Center Assertion Consumer Service (ACS) URL
376
+
- **Entity ID**: The IAM Identity Center issuer URL
377
+
- **Start URL**: Leave empty
378
+
- **Name ID format**: Select `EMAIL`
379
+
</Step>
380
+
<Step>
381
+
<StepNumber/> Enable the application for the appropriate users or groups in your IdP
382
+
</Step>
383
+
<Step>
384
+
<StepNumber/> Configure automatic provisioning (SCIM) if supported by your IdP, or manually create users and groups in AWS Identity Center
385
+
</Step>
386
+
<Step>
387
+
<StepNumber/> Create groups in your IdP (or AWS Identity Center) to match the groups expected by the `aws-sso` component. See the [Required Groups](#required-groups) section below
388
+
</Step>
389
+
</Steps>
296
390
297
-
-[How to use Google Workspace as an external identity provider for AWS IAM Identity Center](https://aws.amazon.com/blogs/security/how-to-use-g-suite-as-external-identity-provider-aws-sso/)
391
+
If set up properly, users added to your IdP will automatically populate in AWS Identity Center.
0 commit comments