Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Basic docs for Identity Center Resource Access Requests #50977

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

tcsc
Copy link
Contributor

@tcsc tcsc commented Jan 13, 2025

No description provided.

@tcsc tcsc added no-changelog Indicates that a PR does not require a changelog entry aws-iam-identity-center labels Jan 13, 2025
Copy link

github-actions bot commented Jan 13, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
tcsc/idc-res-ar-docs bf7d45c 2 ✅SUCCEED tcsc-idc-res-ar-docs 2025-01-14 03:24:35

Copy link
Contributor

@smallinsky smallinsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have left few suggestions but mostly looks OK for me.

Comment on lines +176 to +191
## Background: Account Assignments

The main resource that the Teleport Identity Center integration manages is the
*Account Assignment*.

An Account Assignment is the combination of a specific Permission Set on a specific
AWS account - for example "*AdminAccess on Production*" (where *Production* is
an AWS account managed by Identity Center).

When a user has access to an Account Assignment in Teleport, that access is
mirrored in AWS Identity Center. When a teleport user loses access to an Account
Assignment in Teleport, that access is similarly deleted in AWS.

Access to Account Assignments can be granted via Teleport Roles, either directly
to Users or through Access Lists, or by Account Assignment resources included in
an approved Access Request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a bit hard to grasp the Account Assignments concept without introducing concept of yaml account assignment object that is mentioned later: https://github.com/gravitational/teleport/pull/50977/files#diff-fb2062905f79b4f115956784c5dff3435d4e742630bdca6acd0d2a68abc1e996L249

## Usage scenarios

Let's take a look at some common usage scenarios enabled by the Identity Center
integration.

### Just-In-Time Access with resource Access Requests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now the section ordering looks like below:

  • Just-In-Time Access with resource Access Requests
  • Managing access with Access Lists
  • Just-in-time access with role Access Requests
  • Long-term access with Access Requests

Can we group and sort based on the usage scenarios:

  • Just-In-Time Access with resource Access Requests
  • Access Request
    • Just-in-time access with role Access Requests
    • Long-term access with Access Requests
    • Long-term access with Access Requests

assigned to the corresponding AWS Identity Center group during the integration
setup.

These Teleport-generated roles each represent a single Account Assignment, and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we have replaced permission-set-name>-on--on--aws-coount-id to prevent collisions between account names

@@ -182,11 +173,60 @@ Clicking the "Log In" button for this app takes you to your Identity Center
SSO start page which you can use to pick a role and connect to your AWS account
as usual.

## Background: Account Assignments
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would make sense to incorporate this into "How it works", since it's architectural background that a reader can keep in mind while they continue through the setup steps.

Comment on lines +186 to +191
mirrored in AWS Identity Center. When a teleport user loses access to an Account
Assignment in Teleport, that access is similarly deleted in AWS.

Access to Account Assignments can be granted via Teleport Roles, either directly
to Users or through Access Lists, or by Account Assignment resources included in
an approved Access Request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mirrored in AWS Identity Center. When a teleport user loses access to an Account
Assignment in Teleport, that access is similarly deleted in AWS.
Access to Account Assignments can be granted via Teleport Roles, either directly
to Users or through Access Lists, or by Account Assignment resources included in
an approved Access Request.
mirrored in AWS Identity Center. When a Teleport user loses access to an Account
Assignment in Teleport, that access is similarly deleted in AWS.
Access to Account Assignments can be granted via Teleport roles, either directly
to users or through Access Lists, or by Account Assignment resources included in
an approved Access Request.

Capitalization tweaks

## Usage scenarios

Let's take a look at some common usage scenarios enabled by the Identity Center
integration.

### Just-In-Time Access with resource Access Requests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Just-In-Time Access with resource Access Requests
### Just-in-time access with resource Access Requests

Capitalization

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants