From 048990e18980492c8895c50c1a7a5366ba6f84f4 Mon Sep 17 00:00:00 2001 From: Marguerite Martinez <84595842+mmurrell-r7@users.noreply.github.com> Date: Fri, 28 Jun 2024 14:23:29 -0400 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 66308c1..0ad0f9d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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