Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mmurrell-r7 authored Jun 28, 2024
1 parent 33fb75f commit 048990e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In order to rotate credentials, Awsaml takes the following actions

1. Authenticates the user with their identity provider.
2. Reads the SAML authentication response returned from the identity provider.
3. Generates new temporary AWS keys by calling the [AssumeRoleWithSAML][] API.
3. Generates new temporary AWS keys by calling the [AssumeRoleWithSAML][] API.*
4. Writes the new temporary credentials to disk.

This flow repeats every hour so the user always has a valid set of AWS keys
Expand All @@ -20,6 +20,8 @@ identity provider, so the user doesn't need to reauthenticate every time.

You can grab prebuilt binaries for Mac, Linux, and Window from [the releases page][releases].

*This API is used to fetch credentials if the Okta SAML + AWS configuration is used. Alternatively, Awsaml also supports the Just In Time IAM tool in Rapid7's InsightCloudSec product.

## Configuration

Configuring Awsaml is a multi-step process that involves a bit of back and forth
Expand Down

0 comments on commit 048990e

Please sign in to comment.