Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
sso-ug-116	sso-ug.pdf	116	Identity Center. 4. The requesting application, or the AWS driver that it uses, passes the token to IAM Identity Center and requests that the token be exchanged for a token that is generated by IAM Identity Center. If you use an AWS driver, you might need to conﬁgure the driver for this use case. For more information, see the documentation for the relevant AWS managed application. 5. IAM Identity Center uses the OIDC Discovery endpoint to obtain the public key that it can use to verify the authenticity of the token. IAM Identity Center then does the following: Customer managed applications 286 AWS IAM Identity Center • Veriﬁes the token. User Guide • Searches the Identity Center directory. To do this, IAM Identity Center uses the mapped attribute speciﬁed in the token. • Veriﬁes that the user is authorized to access the receiving application. If the AWS managed application is conﬁgured to require assignments to users and groups, the user must have a direct or group-based assignment to the application; otherwise the request is denied. If the AWS managed application is conﬁgured to not require user and group assignments, processing continues. Note AWS services have a default setting conﬁguration that determines whether assignments are required for users and groups. We recommend that you do not modify the Require assignments setting for these applications if you plan to use them with trusted identity propagation. Even if you have conﬁgured ﬁne-grained permissions that allow user access to speciﬁc application resources, modifying the Require assignments setting might result in unexpected behavior, including disrupted user access to these resources. • Veriﬁes that the requesting application is conﬁgured to use valid scopes for the receiving AWS managed application. 6. If the previous veriﬁcation steps are successful, IAM Identity Center creates a new token. The new token is an opaque (encrypted) token that includes the identity of the corresponding user in IAM Identity Center, the audience (Aud) of the receiving AWS managed application, and the scopes that the requesting application can use when making requests to the receiving AWS managed application. 7. The requesting application, or the driver that it uses, initiates a resource request to the receiving application and passes the token that IAM Identity Center generated to the receiving application. 8. The receiving application makes calls to IAM Identity Center to obtain the identity of the user and the scopes that are encoded in the token. It might also make requests to obtain user attributes or the user’s group memberships from the Identity Center directory. 9. The receiving application uses its authorization conﬁguration to determine if the user is authorized to access the requested application resource. Customer managed applications 287 AWS IAM Identity Center User Guide 10.If the user is authorized to access the requested application resource, the receiving application responds to the request. 11.The user's identity, actions performed on their behalf, and other events recorded in the receiving application logs and CloudTrail events. The speciﬁc way in which this information is logged varies based on the application. Identity-enhanced IAM role sessions The AWS Security Token Service (STS) enables an application to obtain an identity-enhanced IAM role session. Identity-enhanced role sessions have an added identity context that carries a user identiﬁer to the AWS service that it calls. AWS services can look up the group memberships and attributes of the user in IAM Identity Center and use them to authorize the user’s access to resources. AWS applications obtain identity-enhanced role sessions by making requests to the AWS STS AssumeRole API action and passing a context assertion with the user’s identiﬁer (userId) in the ProvidedContexts parameter of the request to AssumeRole. The context assertion is obtained from the idToken claim received in response to a request to SSO OIDC to CreateTokenWithIAM. When an AWS application uses an identity-enhanced role session to access a resource, CloudTrail logs the userId, the initiating session, and the action taken. For more information, see Identity-enhanced IAM role session logging. Topics • Types of identity-enhanced IAM role sessions • Identity-enhanced IAM role session logging Types of identity-enhanced IAM role sessions AWS STS can create two diﬀerent types of identity-enhanced IAM role sessions, depending on the context assertion provided to the AssumeRole request. Applications that have obtained Id tokens from IAM Identity Center can add sts:identiy_context (recommended) or sts:audit_context (Supported for backward compatibility) to IAM role sessions. An identity- enhanced IAM role session can have only one of these context assertions, not both. Identity-enhanced IAM role sessions created with sts:identity_context When an identity-enhanced role session contains sts:identity_context the called AWS service determines if resource authorization is based on the user who is represented in the role Customer managed applications 288 AWS IAM Identity Center User Guide session, or if it's based on the role. AWS services that support user-based authorization provide the
sso-ug-117	sso-ug.pdf	117	request. Applications that have obtained Id tokens from IAM Identity Center can add sts:identiy_context (recommended) or sts:audit_context (Supported for backward compatibility) to IAM role sessions. An identity- enhanced IAM role session can have only one of these context assertions, not both. Identity-enhanced IAM role sessions created with sts:identity_context When an identity-enhanced role session contains sts:identity_context the called AWS service determines if resource authorization is based on the user who is represented in the role Customer managed applications 288 AWS IAM Identity Center User Guide session, or if it's based on the role. AWS services that support user-based authorization provide the application's administrator with controls to assign access to the user or to groups for which the user is a member. AWS services that do not support user-based authorization disregard the sts:identity_context. CloudTrail logs the userId of the IAM Identity Center user with all actions taken by the role. For more information, see Identity-enhanced IAM role session logging. To obtain this type of identity-enhanced role session from AWS STS, applications provide the value of the sts:identity_context ﬁeld in the AssumeRole request using the ProvidedContexts request parameter. Use arn:aws:iam::aws:contextProvider/IdentityCenter as the value for ProviderArn. For more information on how the authorization behaves, see the documentation for the receiving AWS service. Identity-enhanced IAM role sessions created with sts:audit_context In the past, sts:audit_context was used to enable AWS services to log the user identity without using it to make an authorization decision. AWS services are now able to use a single context - sts:identity_context - to achieve this as well as to make authorization decisions. We recommend using sts:identity_context in all new deployments of trusted identity propagation. Identity-enhanced IAM role session logging When a request is made to an AWS service using an identity-enhanced IAM role session, the user's IAM Identity Center userId is logged to CloudTrail in the OnBehalfOf element. The way in which events are logged in CloudTrail varies based on the AWS service. Not all AWS services log the onBehalfOf element. The following is an example of how a request made to an AWS service using an identity-enhanced role session is logged in CloudTrail. "userIdentity": { "type": "AssumedRole", "principalId": "AROAEXAMPLE:MyRole", "arn": "arn:aws:sts::111111111111:assumed-role/MyRole/MySession", "accountId": "111111111111", "accessKeyId": "ASIAEXAMPLE", Customer managed applications 289 User Guide AWS IAM Identity Center "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAEXAMPLE", "arn": "arn:aws:iam::111111111111:role/MyRole", "accountId": "111111111111", "userName": "MyRole" }, "attributes": { "creationDate": "2023-12-12T13:55:22Z", "mfaAuthenticated": "false" } }, "onBehalfOf": { "userId": "11111111-1111-1111-1111-1111111111", "identityStoreArn": "arn:aws:identitystore::111111111111:identitystore/ d-111111111" } } Rotate IAM Identity Center certiﬁcates IAM Identity Center uses certiﬁcates to set up a SAML trust relationship between IAM Identity Center and your application's service provider. When you add an application in IAM Identity Center, an IAM Identity Center certiﬁcate is automatically created for use with that application during the setup process. By default, this autogenerated IAM Identity Center certiﬁcate is valid for a period of ﬁve years. As an IAM Identity Center administrator, you'll occasionally need to replace older certiﬁcates with newer ones for a given application. For example, you might need to replace a certiﬁcate when the expiration date on the certiﬁcate approaches. The process of replacing an older certiﬁcate with a newer one is referred to as certiﬁcate rotation. Considerations before rotating a certiﬁcate Before you start the process of rotating a certiﬁcate in IAM Identity Center, consider the following: • The certiﬁcation rotation process requires that you reestablish the trust between IAM Identity Center and the service provider. To reestablish the trust, use the procedures provided in Rotate an IAM Identity Center certiﬁcate. Rotate certiﬁcates 290 AWS IAM Identity Center User Guide • Updating the certiﬁcate with the service provider may cause a temporary service disruption for your users until the trust has been successfully reestablished. Plan this operation carefully during oﬀ peak hours if possible. Rotate an IAM Identity Center certiﬁcate Rotating an IAM Identity Center certiﬁcate is a multistep process that involves the following: • Generating a new certiﬁcate • Adding the new certiﬁcate to the service provider’s website • Setting the new certiﬁcate to active • Deleting the inactive certiﬁcate Use all of the following procedures in the following order to complete the certiﬁcate rotation process for a given application. Step 1: Generate a new certiﬁcate New IAM Identity Center certiﬁcates that you generate can be conﬁgured to use the following properties: • Validity period – Speciﬁes the time allotted (in months) before a new IAM Identity Center certiﬁcate expires. • Key size – Determines the number of bits that a key must use with its cryptographic algorithm. You can set this value to either 1024-bit RSA or 2048-bit RSA. For general information about how key sizes work in cryptography, see Key size. • Algorithm – Speciﬁes the algorithm that IAM Identity Center uses when signing the SAML assertion/response. You can set this value to either
sso-ug-118	sso-ug.pdf	118	New IAM Identity Center certiﬁcates that you generate can be conﬁgured to use the following properties: • Validity period – Speciﬁes the time allotted (in months) before a new IAM Identity Center certiﬁcate expires. • Key size – Determines the number of bits that a key must use with its cryptographic algorithm. You can set this value to either 1024-bit RSA or 2048-bit RSA. For general information about how key sizes work in cryptography, see Key size. • Algorithm – Speciﬁes the algorithm that IAM Identity Center uses when signing the SAML assertion/response. You can set this value to either SHA-1 or SHA-256. AWS recommends using SHA-256 when possible, unless your service provider requires SHA-1. For general information about how cryptography algorithms work, see Public-key cryptography. 1. Open the IAM Identity Center console. 2. Choose Applications. 3. In the list of applications, choose the application that you want to generate a new certiﬁcate for. Rotate an IAM Identity Center certiﬁcate 291 AWS IAM Identity Center User Guide 4. On the application details page, choose the Conﬁguration tab. Under IAM Identity Center metadata, choose Manage certiﬁcate. If you don't have a Conﬁguration tab or the conﬁguration setting is not available, you do not need to rotate the certiﬁcate for this application. 5. On the IAM Identity Center certiﬁcate page, choose Generate new certiﬁcate. 6. In the Generate new IAM Identity Center certiﬁcate dialog box, specify the appropriate values for Validity period, Algorithm, and Key size. Then choose Generate. Step 2: Update the service provider's website Use the following procedure to reestablish the trust with the application's service provider. Important When you upload the new certiﬁcate to the service provider, your users might not be able to get authenticated. To correct this situation, set the new certiﬁcate as active as described in the next step. 1. In the IAM Identity Center console, choose the application that you just generated a new certiﬁcate for. 2. On the application details page, choose Edit conﬁguration. 3. Choose View instructions, and then follow the instructions for your speciﬁc application service provider’s website to add the newly generated certiﬁcate. Step 3: Set the new certiﬁcate to active An application can have up to two certiﬁcates assigned to it. IAM Identity Center will use the certiﬁcation that is set as active to sign all SAML assertions. 1. Open the IAM Identity Center console. 2. Choose Applications. 3. In the list of applications, choose your application. 4. On the application details page, choose the Conﬁguration tab. Under IAM Identity Center metadata, choose Manage certiﬁcate. Rotate an IAM Identity Center certiﬁcate 292 AWS IAM Identity Center User Guide 5. On the IAM Identity Center certiﬁcate page, select the certiﬁcate you want to set to active, choose Actions, and then choose Set as active. 6. In the Set the selected certiﬁcate as active dialog, conﬁrm that you understand that setting a certiﬁcate to active may require you to re-establish the trust, and then choose Make active. Step 4: Delete the old certiﬁcate Use the following procedure to complete the certiﬁcate rotation process for your application. You can only delete a certiﬁcate that is in an Inactive state. 1. Open the IAM Identity Center console. 2. Choose Applications. 3. In the list of applications, choose your application. 4. On the application details page, select the Conﬁguration tab. Under IAM Identity Center metadata, choose Manage certiﬁcate. 5. On the IAM Identity Center certiﬁcate page, select the certiﬁcate you want to delete. Choose Actions and then choose Delete. 6. In the Delete certiﬁcate dialog box, choose Delete. Certiﬁcate expiration status indicators In the IAM Identity Center console, the Applications page displays status indicator icons in the properties of each application. These icons display in the Expires on column next to each certiﬁcate in the list. The following describes the criteria that IAM Identity Center uses to determine which icon displays for each certiﬁcate. • Red – Indicates that a certiﬁcate is currently expired. • Yellow – Indicates that a certiﬁcate will expire in 90 days or less. • Green – Indicates that a certiﬁcate is currently valid and will remain valid for at least 90 more days. To check the status of a certiﬁcate 1. Open the IAM Identity Center console. 2. Choose Applications. Certiﬁcate expiration status indicators 293 AWS IAM Identity Center User Guide 3. In the list of applications, review the status of the certiﬁcates in the list as indicated in the Expires on column. Understand application properties in the IAM Identity Center console In IAM Identity Center you can customize the user experience by conﬁguring the application start URL, relay state, and session duration. Application start URL You use an application start URL to start the federation process with your application. The typical use is for an application that supports only
sso-ug-119	sso-ug.pdf	119	1. Open the IAM Identity Center console. 2. Choose Applications. Certiﬁcate expiration status indicators 293 AWS IAM Identity Center User Guide 3. In the list of applications, review the status of the certiﬁcates in the list as indicated in the Expires on column. Understand application properties in the IAM Identity Center console In IAM Identity Center you can customize the user experience by conﬁguring the application start URL, relay state, and session duration. Application start URL You use an application start URL to start the federation process with your application. The typical use is for an application that supports only service provider (SP)-initiated binding. The following steps and diagram illustrate the application start URL authentication workﬂow when a user chooses an application in the AWS access portal: 1. The user’s browser redirects the authentication request using the value for the application start URL (in this case https://example.com). 2. The application sends an HTML POST with a SAMLRequest to IAM Identity Center. 3. IAM Identity Center then sends an HTML POST with a SAMLResponse back to the application. Understand application properties 294 AWS IAM Identity Center Relay state User Guide During the federation authentication process, the relay state redirects users within the application. For SAML 2.0, this value is passed, unmodiﬁed, to the application. After the application properties are conﬁgured, IAM Identity Center sends the relay state value along with a SAML response to the application. Session duration Session duration is the length of time for which an application user session is valid. For SAML 2.0, this is used to set the SessionNotOnOrAfter date of the SAML assertion's element saml2:AuthNStatement. Session duration can be interpreted by applications in either of the following ways: • Applications can use it to determine the maximum time that is allowed for the user's session. Applications might generate a user session with a shorter duration. This can happen when the application only supports user sessions with a duration that is shorter than the conﬁgured session length. • Applications can use it as the exact duration and might not allow administrators to conﬁgure the value. This can happen when the application only supports a speciﬁc session length. For more information about how session duration is used, see your speciﬁc application’s documentation. Relay state 295 AWS IAM Identity Center User Guide Assign user access to applications in the IAM Identity Center console You can assign users single sign-on access to SAML 2.0 applications in the application catalog or to custom SAML 2.0 applications. Considerations for group assignments: • Assign access directly to groups. To help simplify administration of access permissions, we recommend that you assign access directly to groups rather than to individual users. With groups you can grant or deny permissions to groups of users, instead of applying those permissions to each individual. If a user moves to a diﬀerent organization, you simply move that user to a diﬀerent group. The user then automatically receives the permissions that are needed for the new organization. • Nested groups aren't supported. When assigning user access to applications, IAM Identity Center doesn't support users being added to nested groups. If a user is added to a nested group, they might receive a “You do not have any applications” message during sign-in. Assignments must be made against the immediate group for which the user is a member. To assign user or group access to applications Important For AWS managed applications, you must add users directly from within the relevant application consoles or through the APIs. 1. Open the IAM Identity Center console. Note If you manage users in AWS Managed Microsoft AD, make sure that the IAM Identity Center console is using the AWS Region where your AWS Managed Microsoft AD directory is located before taking the next step. 2. Choose Applications. 3. In the list of applications, choose the application name to which you want to assign access. Assign user access to applications 296 AWS IAM Identity Center User Guide 4. On the application details page, in the Assigned users section, choose Assign users. 5. In the Assign users dialog box, enter a user display name or group name. You can specify multiple users or groups by selecting the applicable accounts as they appear in search results. 6. Choose Assign users. Remove user access to SAML 2.0 applications Use this procedure to remove user access to SAML 2.0 applications in the application catalog or custom SAML 2.0 applications. For more information on authentication sessions and durations, see Authentication in IAM Identity Center. To remove user access to an application 1. Open the IAM Identity Center console. 2. Choose Applications. 3. In the list of applications, choose the application from which you want to remove user access. 4. On the application details page, in the Assigned users section, select the user
sso-ug-120	sso-ug.pdf	120	accounts as they appear in search results. 6. Choose Assign users. Remove user access to SAML 2.0 applications Use this procedure to remove user access to SAML 2.0 applications in the application catalog or custom SAML 2.0 applications. For more information on authentication sessions and durations, see Authentication in IAM Identity Center. To remove user access to an application 1. Open the IAM Identity Center console. 2. Choose Applications. 3. In the list of applications, choose the application from which you want to remove user access. 4. On the application details page, in the Assigned users section, select the user or group that you want to remove and then choose the Remove access button. 5. In the Remove access dialog box, verify the user or group name. Then choose Remove access. Map attributes in your application to IAM Identity Center attributes Some service providers require custom SAML assertions to pass additional data about your user sign-ins. In that case, use the following procedure to specify how your applications user attributes should map to corresponding attributes in IAM Identity Center. To map application attributes to attributes in IAM Identity Center 1. Open the IAM Identity Center console. 2. Choose Applications. 3. In the list of applications, choose the application where you want to map attributes. 4. On the application details page, choose the Actions and then choose Edit attribute mapping. 5. Choose Add new attribute mapping. Remove user access to applications 297 AWS IAM Identity Center User Guide 6. 7. In the ﬁrst text box, enter the application attribute. In the second text box, enter the attribute in IAM Identity Center that you want to map to the application attribute. For example, you might want to map the application attribute Username to the IAM Identity Center user attribute email. To see the list of allowed user attributes in IAM Identity Center, see the table in Attribute mappings between IAM Identity Center and External Identity Providers directory. 8. In the third column of the table, choose the appropriate format for the attribute from the menu. 9. Choose Save changes. Map attributes 298 AWS IAM Identity Center User Guide AWS account access AWS IAM Identity Center is integrated with AWS Organizations, which enables you to centrally manage permissions across multiple AWS accounts without conﬁguring each of your accounts manually. You can deﬁne permissions and assign these permissions to workforce users to control their access to speciﬁc AWS accounts using an organization instance of IAM Identity Center. Account instances of IAM Identity Center don't support account access. AWS account types There are two types of AWS accounts in AWS Organizations: • Management account - The AWS account that is used to create the organization. • Member accounts - The rest of the AWS accounts that belong to an organization. For more information about AWS account types, see AWS Organizations Terminology and Concepts in the AWS Organizations User Guide. You can also choose to register a member account as a delegated administrator for IAM Identity Center. Users in this account can perform most IAM Identity Center administrative tasks. For more information, see Delegated administration. For each task and account type, the following table indicates whether the IAM Identity Center administrative task can be performed by users in the account. IAM Identity Center administrative tasks Read users or groups (reading the group itself and the group's membership) Member account Delegated administr ator account Management account Yes Yes Yes AWS account types 299 AWS IAM Identity Center IAM Identity Center administrative tasks Add, edit, or delete users or groups Enable or disable user access Enable, disable, or manage incoming attributes Change or manage identity sources Create, edit, or delete customer managed applications Create, edit, or delete AWS managed applications Conﬁgure MFA Member account Delegated administr ator account Management account User Guide No No No No No Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes AWS account types 300 AWS IAM Identity Center User Guide IAM Identity Center administrative tasks Manage permission sets not provisioned in the management account Manage permissio n sets provisioned in the management account Enable IAM Identity Center Delete IAM Identity Center conﬁguration Enable or disable user access in the management account Register or deregister a member account as a delegated administr ator Member account Delegated administr ator account Management account No No No No No No Yes No No No No No Yes Yes Yes Yes Yes Yes AWS account types 301 AWS IAM Identity Center User Guide Assigning AWS account access You can use permission sets to simplify how you assign users and groups in your organization access to AWS accounts. Permission sets are stored in IAM Identity Center and deﬁne the level of access that users and groups have to an AWS account.
sso-ug-121	sso-ug.pdf	121	user access in the management account Register or deregister a member account as a delegated administr ator Member account Delegated administr ator account Management account No No No No No No Yes No No No No No Yes Yes Yes Yes Yes Yes AWS account types 301 AWS IAM Identity Center User Guide Assigning AWS account access You can use permission sets to simplify how you assign users and groups in your organization access to AWS accounts. Permission sets are stored in IAM Identity Center and deﬁne the level of access that users and groups have to an AWS account. You can create a single permission set and assign it to multiple AWS accounts within your organization. You can also assign multiple permission sets to the same user. For more information about permission sets, see Create, manage, and delete permission sets. Note You can also assign your users single sign-on access to applications. For information, see Application access. End-user experience The AWS access portal provides IAM Identity Center users with single sign-on access to all their assigned AWS accounts and applications through a web portal. The AWS access portal is diﬀerent from the AWS Management Console, which is a collection of service consoles for managing AWS resources. When you create a permission set, the name that you specify for the permission set appears in the AWS access portal as an available role. Users sign in to the AWS access portal, choose an AWS account, and then choose the role. After they choose the role, they can access AWS services by using the AWS Management Console or retrieve temporary credentials to access AWS services programmatically. To open the AWS Management Console or retrieve temporary credentials to access AWS programmatically, users complete the following steps: 1. Users open a browser window and use the sign-in URL that you provide to navigate to the AWS access portal. 2. Using their directory credentials, they sign in to the AWS access portal. 3. After authentication, on the AWS access portal page, they choose the Accounts tab to display the list of AWS accounts to which they have access. 4. Users then choose the AWS account that they want to use. Assigning AWS account access 302 AWS IAM Identity Center User Guide 5. Below the name of the AWS account, any permission sets to which users are assigned appear as available roles. For example, if you assigned user john_stiles to the PowerUser permission set, the role displays in the AWS access portal as PowerUser/john_stiles. Users who are assigned multiple permission sets choose which role to use. Users can choose their role to access the AWS Management Console. 6. In addition to the role, AWS access portal users can retrieve temporary credentials for command line or programmatic access by choosing Access keys. For step-by-step guidance that you can provide to your workforce users, see Using the AWS access portal and Getting IAM Identity Center user credentials for the AWS CLI or AWS SDKs. Enforcing and limiting access When you enable IAM Identity Center, IAM Identity Center creates a service-linked role. You can also use service control policies (SCPs). Delegating and enforcing access A service-linked role is a type of IAM role that is linked directly to an AWS service. After you enable IAM Identity Center, IAM Identity Center can create a service-linked role in each AWS account in your organization. This role provides predeﬁned permissions that allow IAM Identity Center to delegate and enforce which users have single sign-on access to speciﬁc AWS accounts in your organization in AWS Organizations. You need to assign one or more users with access to an account, to use this role. For more information, see Understanding service-linked roles in IAM Identity Center and Using service-linked roles for IAM Identity Center. Limiting access to the identity store from member accounts For the identity store service used by IAM Identity Center, users who have access to a member account can use API actions that require Read permissions. Member accounts have access to Read actions on both the sso-directory and identitystore namespaces. For more information, see Actions, resources, and condition keys for AWS IAM Identity Center directory and Actions, resources, and condition keys for AWS Identity Store in the Service Authorization Reference. To prevent users in member accounts from using API operations in the identity store, you can attach a service control policy (SCP). An SCP is a type of organization policy that you can use to manage permissions in your organization. The following example SCP prevents users in member accounts from accessing any API operation in the identity store. Enforcing and limiting access 303 AWS IAM Identity Center User Guide { "Sid": "ExplicitlyBlockIdentityStoreAccess", "Effect": "Deny", "Action": ["identitystore:", "sso-directory:"], "Resource": "*" } Note Limiting member accounts' access might impair functionality in IAM Identity Center
sso-ug-122	sso-ug.pdf	122	AWS Identity Store in the Service Authorization Reference. To prevent users in member accounts from using API operations in the identity store, you can attach a service control policy (SCP). An SCP is a type of organization policy that you can use to manage permissions in your organization. The following example SCP prevents users in member accounts from accessing any API operation in the identity store. Enforcing and limiting access 303 AWS IAM Identity Center User Guide { "Sid": "ExplicitlyBlockIdentityStoreAccess", "Effect": "Deny", "Action": ["identitystore:", "sso-directory:"], "Resource": "*" } Note Limiting member accounts' access might impair functionality in IAM Identity Center enabled applications. For more information, see Service control policies (SCPs) in the AWS Organizations User Guide. Delegated administration Delegated administration provides a convenient way for assigned users in a registered member account to perform most IAM Identity Center administrative tasks. When you enable IAM Identity Center, your IAM Identity Center instance is created in the management account in AWS Organizations by default. This was originally designed this way so that IAM Identity Center can provision, de-provision, and update roles across all your organization's member accounts. Even though your IAM Identity Center instance must always reside in the management account, you can choose to delegate administration of IAM Identity Center to a member account in AWS Organizations, thereby extending the ability to manage IAM Identity Center from outside the management account. Enabling delegated administration provides the following beneﬁts: • Minimizes the number of people who require access to the management account to help mitigate security concerns • Allows select administrators to assign users and groups to applications and to your organization's member accounts For more information about how IAM Identity Center works with AWS Organizations, see AWS account access. For additional information and to review an example company scenario showing how to conﬁgure delegated administration, see Getting started with IAM Identity Center delegated administration in the AWS Security Blog. Delegated administration 304 AWS IAM Identity Center Topics • Best practices • Prerequisites • Register a member account • Deregister a member account User Guide • View which member account has been registered as the delegated administrator Best practices Here are some best practices to consider before you conﬁgure delegated administration. • Grant least privilege to the management account – Knowing that the management account is a highly privileged account and to adhere to the principal of least privilege, we highly recommend that you restrict access to the management account to as few people as possible. The delegated administrator feature is intended to minimize the number of people who require access to the management account. • Create permission sets for use only in the management account – This makes it easier to administer permission sets tailored just for users accessing your management account and helps to diﬀerentiate them from permission sets managed by your delegated administrator account. • Consider your Active Directory location – If you plan on using Active Directory as your IAM Identity Center identity source, locate the directory in the member account where you have enabled the IAM Identity Center delegated administrator feature. If you decide to change the IAM Identity Center identity source from any other source to Active Directory, or change it from Active Directory to any other source, the directory must reside in (be owned by) the IAM Identity Center delegated administrator member account if one exists; otherwise, it must be in the management account. • Create user assignments only in the management account – The delegated administrator can't alter permission sets provisioned in the management account. However, delegated administrators can add, edit, and delete groups and group assignments. Prerequisites Before you can register an account as a delegated administrator you must ﬁrst have the following environment deployed: Best practices 305 AWS IAM Identity Center User Guide • AWS Organizations must be enabled and conﬁgured with at least one member account in addition to your default management account. • If your identity source is set to Active Directory, the IAM Identity Center conﬁgurable AD sync feature must be enabled. Register a member account To conﬁgure delegated administration, you must ﬁrst register a member account in your organization as a delegated administrator. Users in that member account who have suﬃcient permissions will have administrative access to IAM Identity Center. After a member account is successfully registered for delegated administration, it's referred to as the delegated administrator account. To learn more about tasks that the delegated administrator account can perform, see AWS account types. IAM Identity Center supports registering only one member account as a delegated administrator at a time. You can only register a member account while signed in with credentials from the management account. Use the following procedure to grant administrative access to IAM Identity Center by registering a speciﬁc member account in your AWS organization
sso-ug-123	sso-ug.pdf	123	who have suﬃcient permissions will have administrative access to IAM Identity Center. After a member account is successfully registered for delegated administration, it's referred to as the delegated administrator account. To learn more about tasks that the delegated administrator account can perform, see AWS account types. IAM Identity Center supports registering only one member account as a delegated administrator at a time. You can only register a member account while signed in with credentials from the management account. Use the following procedure to grant administrative access to IAM Identity Center by registering a speciﬁc member account in your AWS organization as a delegated administrator. Important This operation delegates IAM Identity Center administrative access to admin users in this member account. All users who have suﬃcient permissions to this delegated administrator account can perform all IAM Identity Center administrative tasks from the account, except for: • Enabling IAM Identity Center • Deleting IAM Identity Center conﬁgurations • Managing permission sets provisioned in the management account • Registering or deregistering other member accounts as delegated administrators • Enabling or disabling user access in the management account The delegated administrator can edit group membership. Register a member account 306 AWS IAM Identity Center To register a member account User Guide 1. Sign in to the AWS Management Console using the credentials of your management account in AWS Organizations. Management account credentials are required to run the RegisterDelegatedAdministrator API. 2. Select the Region where IAM Identity Center is enabled, and then open the IAM Identity Center console. 3. Choose Settings, and then select the Management tab. 4. In the Delegated administrator section, choose Register account. 5. On the Register delegated administrator page, select the AWS account you want to register, and then choose Register account. Deregister a member account You can only deregister a member account while signed in with credentials from the management account. Use the following procedure to remove administrative access from IAM Identity Center by deregistering a member account in your AWS organization that had previously been designated as a delegated administrator. Important When you deregister an account, you eﬀectively remove the ability for all admin users to manage IAM Identity Center from that account. As a result, they can no longer administer IAM Identity Center identities, access management, authentication, or application access from this account. This operation will not aﬀect any permissions or assignments conﬁgured in IAM Identity Center and therefore will have no impact on your end users as they will continue to have access to their apps and AWS accounts from within the AWS access portal. To deregister a member account 1. Sign in to the AWS Management Console using the credentials of your management account in AWS Organizations. Management account credentials are required to run the DeregisterDelegatedAdministrator API. Deregister a member account 307 AWS IAM Identity Center User Guide 2. Select the Region where IAM Identity Center is enabled, and then open the IAM Identity Center console. 3. Choose Settings, and then select the Management tab. 4. 5. In the Delegated administrator section, choose Deregister account. In the Deregister account dialog box, review the security implications, and then enter the name of the member account to conﬁrm that you understand. 6. Choose Deregister account. View which member account has been registered as the delegated administrator Use the following procedure to ﬁnd which member account in your AWS Organizations has been conﬁgured as the delegated administrator for IAM Identity Center. To view your registered member account 1. Open the IAM Identity Center console. 2. Choose Settings. 3. In the Details section, locate the registered account name under Delegated administrator. You can also locate this information by selecting the Management tab, and viewing it under the Delegated administrator section. Temporary elevated access for AWS accounts All access to your AWS account involves some level of privilege. Sensitive operations, such as changing the conﬁguration for a high-value resource, for example, a production environment, require special treatment due to scope and potential impact. Temporary elevated access (also known as just-in-time access) is a way to request, approve, and track the use of a permission to perform a speciﬁc task during a speciﬁed time. Temporary elevated access supplements other forms of access control, such as permission sets and multi-factor authentication. AWS IAM Identity Center provides the following options for temporary elevated access management in diﬀerent business and technical environments: • Vendor-managed and supported solutions – AWS has validated the IAM Identity Center integrations of select partner oﬀerings and assessed their capabilities against a common set of View delegated administrator accounts 308 AWS IAM Identity Center User Guide customer requirements. Choose the solution that best aligns with your scenario and follow the provider’s guidance to enable the capability with IAM Identity Center. • Self-managed and self-supported – This option provides a starting point
sso-ug-124	sso-ug.pdf	124	control, such as permission sets and multi-factor authentication. AWS IAM Identity Center provides the following options for temporary elevated access management in diﬀerent business and technical environments: • Vendor-managed and supported solutions – AWS has validated the IAM Identity Center integrations of select partner oﬀerings and assessed their capabilities against a common set of View delegated administrator accounts 308 AWS IAM Identity Center User Guide customer requirements. Choose the solution that best aligns with your scenario and follow the provider’s guidance to enable the capability with IAM Identity Center. • Self-managed and self-supported – This option provides a starting point if you are interested in temporary elevated access to AWS only and you can deploy, tailor, and maintain the capability by yourself. For more information, see Temporary elevated access management (TEAM). Validated AWS Security Partners for temporary elevated access AWS Security Partners use diﬀerent approaches to address a common set of temporary elevated access requirements. We recommend that you review each partner solution carefully, so that you can choose one that best ﬁts your needs and preferences, including your business, the architecture of your cloud environment, and your budget. Note For disaster recovery, we recommend that you set up emergency access to the AWS Management Console before a disruption occurs. AWS Identity has validated the capabilities and integration with IAM Identity Center for the following just-in-time oﬀerings by AWS Security Partners: • CyberArk Secure Cloud Access – Part of the CyberArk Identity Security Platform, this oﬀering provisions on-demand elevated access to AWS and multi-cloud environments. Approvals are addressed through integration with either ITSM or ChatOps tooling. All sessions can be recorded for audit and compliance. • Tenable (previously Ermetic) – The Tenable platform includes provisioning of just-in-time privileged access for administrative operations in AWS and multi-cloud environments. Session logs from all cloud environments, including AWS CloudTrail access logs, are available in a single interface for analysis and audit. The capability integrates with enterprise and developer tools such as Slack and Microsoft Teams. • Okta Access Requests – Part of Okta Identity Governance, enables you to conﬁgure a just-in- time access request workﬂow using Okta as an IAM Identity Center external identity provider (IdP) and your IAM Identity Center permission sets. Validated AWS Security Partners for temporary elevated access 309 AWS IAM Identity Center User Guide This list will be updated as AWS validates the capabilities of additional partner solutions and integration of these solutions with IAM Identity Center. Partners can nominate their solutions through the AWS Partner Network (APN) Security Competency. For more information, see AWS Security Competency Partners. Note If you are using resource-based policies, Amazon Elastic Kubernetes Service (Amazon EKS), or AWS Key Management Service (AWS KMS), see Referencing permission sets in resource policies, Amazon EKS Cluster conﬁg maps, and AWS KMS key policies before you choose your just-in-time solution. Temporary elevated access capabilities assessed for AWS partner validation AWS Identity has validated that the temporary elevated access capabilities oﬀered by CyberArk Secure Cloud Access, Tenable, and Okta Access Requests address the following common customer requirements: • Users can request access to a permission set for a user-speciﬁed time period, specifying the AWS account, permission set, time period, and reason. • Users can receive approval status for their request. • Users can't invoke a session with a given scope, unless there is an approved request with the same scope and they invoke the session during the approved time period. • There is a way to specify who can approve requests. • Approvers can't approve their own requests. • Approvers have a list of pending, approved, and rejected requests and can export it for auditors. • Approvers can approve and reject pending requests. • Approvers can add a note explaining their decision. • Approvers can revoke an approved request, preventing future use of elevated access. Temporary elevated access capabilities assessed for AWS partner validation 310 AWS IAM Identity Center Note User Guide If a user is signed in with elevated access when an approved request is revoked, the user will immediately lose access. For information about authentication sessions, see Authentication in IAM Identity Center. • User actions and approvals are available for audit. Single sign-on access to AWS accounts You can assign users in your connected directory permissions to the management account or member accounts in your organization in AWS Organizations based on common job functions. Or you can use custom permissions to meet your speciﬁc security requirements. For example, you can grant database administrators broad permissions to Amazon RDS in development accounts but limit their permissions in production accounts. IAM Identity Center conﬁgures all the necessary user permissions in your AWS accounts automatically. Note You might need to grant users or groups permissions to operate in the AWS Organizations management account. Because it is a highly privileged account,
sso-ug-125	sso-ug.pdf	125	You can assign users in your connected directory permissions to the management account or member accounts in your organization in AWS Organizations based on common job functions. Or you can use custom permissions to meet your speciﬁc security requirements. For example, you can grant database administrators broad permissions to Amazon RDS in development accounts but limit their permissions in production accounts. IAM Identity Center conﬁgures all the necessary user permissions in your AWS accounts automatically. Note You might need to grant users or groups permissions to operate in the AWS Organizations management account. Because it is a highly privileged account, additional security restrictions require you to have the IAMFullAccess policy or equivalent permissions before you can set this up. These additional security restrictions are not required for any of the member accounts in your AWS organization. Topics • Assign user or group access to AWS accounts • Remove user and group access to an AWS account • Revoke active IAM role sessions created by permission sets • Delegate who can assign single sign-on access to users and groups in the management account Single sign-on access to AWS accounts 311 AWS IAM Identity Center User Guide Assign user or group access to AWS accounts Use the following procedure to assign single sign-on access to users and groups in your connected directory and use permission sets to determine their level of access. To check existing user and group access, see View and change a permission set. Note To simplify administration of access permissions, we recommended that you assign access directly to groups rather than to individual users. With groups you can grant or deny permissions to groups of users rather than having to apply those permissions to each individual. If a user moves to a diﬀerent organization, you simply move that user to a diﬀerent group and they automatically receive the permissions that are needed for the new organization. To assign user or group access to AWS accounts 1. Open the IAM Identity Center console. Note Make sure that the IAM Identity Center console is using the Region where your AWS Managed Microsoft AD directory is located before you move to the next step. 2. In the navigation pane, under Multi-account permissions, choose AWS accounts. 3. On the AWS accounts page, a tree view list of your organization displays. Select the checkbox next to the AWS account to which you want to assign access. If you are setting up administrative access for IAM Identity Center, select the checkbox next to the management account . Note You can select up to 10 AWS accounts at a time per permission set when you assign single sign-on access to users and groups. To assign more than 10 AWS accounts to the same set of users and groups, repeat this procedure as required for the additional accounts. When prompted, select the same users, groups, and permission set. Assign user or group access to AWS accounts 312 AWS IAM Identity Center User Guide 4. Choose Assign users or groups. 5. For Step 1: Select users and groups, on the Assign users and groups to "AWS-account- name" page, do the following: 1. On the Users tab, select one or more users to whom to grant single sign-on access. To ﬁlter the results, start typing the name of the user that you want in the search box. 2. On the Groups tab, select one or more groups to which to grant single sign-on access. To ﬁlter the results, start typing the name of the group that you want in the search box. 3. To display the users and groups that you selected, choose the sideways triangle next to Selected users and groups. 4. After you conﬁrm that the correct users and groups are selected, choose Next. 6. For Step 2: Select permission sets, on the Assign permission sets to "AWS-account-name" page, do the following: 1. Select one or more permission sets. If required, you can create and select new permission sets. • To select one or more existing permission sets, under Permission sets, select the permission sets that you want to apply to the users and groups that you selected in the previous step. • To create one or more new permission sets, choose Create permission set, and follow the steps in Create a permission set. After you create the permission sets that you want to apply, in the IAM Identity Center console, return to AWS accounts and follow the instructions until you reach Step 2: Select permission sets. When you reach this step, select the new permission sets that you created, and proceed to the next step in this procedure. 2. After you conﬁrm that the correct permission sets are selected, choose Next. 7. For Step 3: Review and Submit, on the Review and submit assignments to "AWS-account-
sso-ug-126	sso-ug.pdf	126	more new permission sets, choose Create permission set, and follow the steps in Create a permission set. After you create the permission sets that you want to apply, in the IAM Identity Center console, return to AWS accounts and follow the instructions until you reach Step 2: Select permission sets. When you reach this step, select the new permission sets that you created, and proceed to the next step in this procedure. 2. After you conﬁrm that the correct permission sets are selected, choose Next. 7. For Step 3: Review and Submit, on the Review and submit assignments to "AWS-account- name" page, do the following: 1. Review the selected users, groups, and permission sets. 2. After you conﬁrm that the correct users, groups, and permission sets are selected, choose Submit. Assign user or group access to AWS accounts 313 AWS IAM Identity Center Considerations User Guide • The user and group assignment process might take a few minutes to complete. Leave this page open until the process successfully completes. • Note You might need to grant users or groups permissions to operate in the AWS Organizations management account. Because it is a highly privileged account, additional security restrictions require you to have the IAMFullAccess policy or equivalent permissions before you can set this up. These additional security restrictions are not required for any of the member accounts in your AWS organization. 8. If either of the following applies, follow the steps in Prompt users for MFA to enable MFA for IAM Identity Center: • You're using the default Identity Center directory as your identity source. • You're using an AWS Managed Microsoft AD directory or a self-managed directory in Active Directory as your identity source and you're not using RADIUS MFA with AWS Directory Service. Note If you're using an external identity provider, note that the external IdP, not IAM Identity Center, manages MFA settings. MFA in IAM Identity Center is not supported for use by external IdPs. When you set up account access for the administrative user, IAM Identity Center creates a corresponding IAM role. This role, which is controlled by IAM Identity Center, is created in the relevant AWS account, and the policies speciﬁed in the permission set are attached to the role. Alternatively, you can use AWS CloudFormation to create and assign permission sets and assign users to those permission sets. Users can then sign in to the AWS access portal or use AWS Command Line Interface (AWS CLI) commands. Assign user or group access to AWS accounts 314 AWS IAM Identity Center User Guide Remove user and group access to an AWS account Use this procedure to remove single sign-on access to an AWS account for one or more users and groups in your connected directory. Alternatively, you can use the delete-account-assignment AWS CLI. Note When you need to deprovision IAM Identity Center users or groups, you should ﬁrst remove any assignments of permission sets from your users and groups before deleting the users and groups. To remove user and group access to an AWS account 1. Open the IAM Identity Center console. 2. In the navigation pane, under Multi-account permissions, choose AWS accounts. 3. On the AWS accounts page, a tree view list of your organization appears. Select the name of the AWS account that contains the users and groups for whom you want to remove single sign-on access. 4. On the Overview page for the AWS account, under Assigned users and groups, select the name of one or more users or groups, and choose Remove access. 5. In the Remove access dialog box, conﬁrm that the names of the users or groups are correct, and choose Remove access. Revoke active IAM role sessions created by permission sets The following is a general procedure for revoking an active permission set session for an IAM Identity Center user. The procedure assumes that you want to remove all access for a user who has compromised credentials or for a bad actor who is in the system. The prerequisite is to have followed the guidance in Prepare to revoke an active IAM role session created by a permission set. We assume that the deny all policy is present in a service control policy (SCP). Note AWS recommends you build automation to handle all steps except console-only operations. Remove user and group access to an AWS account 315 AWS IAM Identity Center User Guide 1. Obtain the user ID of the person whose access you must revoke. You can use the identity store APIs to ﬁnd the user by their username. 2. Update the Deny policy to add the user ID from step 1 in your service control policy (SCP). After completing this step, the target user loses access and is unable to take actions with any roles that
sso-ug-127	sso-ug.pdf	127	in a service control policy (SCP). Note AWS recommends you build automation to handle all steps except console-only operations. Remove user and group access to an AWS account 315 AWS IAM Identity Center User Guide 1. Obtain the user ID of the person whose access you must revoke. You can use the identity store APIs to ﬁnd the user by their username. 2. Update the Deny policy to add the user ID from step 1 in your service control policy (SCP). After completing this step, the target user loses access and is unable to take actions with any roles that the policy aﬀects. 3. Remove all permission set assignments for the user. If access is assigned through group memberships, remove the user from all groups and all direct permission set assignments. This step prevents the user from assuming any additional IAM roles. If a user has an active AWS access portal session and you disable the user, they can continue to assume new roles until you remove their access. 4. If you use an identity provider (IdP) or Microsoft Active Directory as an identity source, disable the user in the identity source. Disabling the user prevents the creation of additional AWS access portal sessions. Use your IdP or Microsoft Active Directory API documentation to learn how to automate this step. If you're using the IAM Identity Center directory as an identity source, don't disable user access yet. You'll disable user access in step 6. 5. In the IAM Identity Center console, ﬁnd the user and delete their active session. a. Choose Users. b. Choose the user whose active session you want to delete. c. On the user's detail page, choose the Active sessions tab. d. Select the check boxes next to the sessions you want to delete and choose Delete session. After deleting a user session, the user will immediately lose access to the AWS access portal. Learn about session duration. 6. In the IAM Identity Center console, disable user access. a. Choose Users. b. Choose the user whose access you want to disable. c. On the user's detail page, expand General information and choose the Disable user access button to prevent further logins of the user. 7. Leave the Deny policy in place for at least 12 hours. Otherwise, the user with an active IAM role session will have restored actions with the IAM role. If you wait 12 hours, active sessions expire and the user won't be able to access the IAM role again. Revoke an active permission set session 316 AWS IAM Identity Center Important User Guide If you disable a user’s access before stopping the user session (you completed step 6 without completing step 5), you can no longer stop the user session through the IAM Identity Center console. If you inadvertently disable user access before stopping the user session, you can re-enable the user, stop their session, and then disable the their access again. You can now change the user's credentials if their password was compromised and restore their assignments. Delegate who can assign single sign-on access to users and groups in the management account Assigning single sign-on access to the management account using the IAM Identity Center console is a privileged action. By default, only an AWS account root user or a user who has the AWSSSOMasterAccountAdministrator and IAMFullAccess AWS managed policies attached, can assign single sign-on access to the management account. The AWSSSOMasterAccountAdministrator and IAMFullAccess policies manage single sign-on access to the management account within an AWS Organizations organization. Alternatively, you can use AWS CLI to create, attach policies to, and assign permission sets. The following lists the commands for each step: • To create a permission set: create-permission-set • To attach AWS Managed Policy to a permission set: attach-managed-policy-to-permission-set • To attach customer managed policy to a permission set: attach-customer-managed-policy-to- permission-set • To assign a permission set to a principal: create-account-assignment Use the following steps to delegate permissions to manage single sign-on access to users and groups in your directory. Delegate who can assign single sign-on access 317 AWS IAM Identity Center User Guide To grant permissions to manage single sign-on access to users and groups in your directory 1. Sign in to the IAM Identity Center console as a root user of the management account or with another user who has administrator permissions to the management account. 2. Follow the steps in Create a permission set to create a permission set, and then do the following: 1. On the Create new permission set page, select the Create a custom permission set check box, and then choose Next: Details. 2. On the Create new permission set page, specify a name for the custom permission set and optionally, a description. If required, modify the session duration and specify a relay state URL. Note
sso-ug-128	sso-ug.pdf	128	to the IAM Identity Center console as a root user of the management account or with another user who has administrator permissions to the management account. 2. Follow the steps in Create a permission set to create a permission set, and then do the following: 1. On the Create new permission set page, select the Create a custom permission set check box, and then choose Next: Details. 2. On the Create new permission set page, specify a name for the custom permission set and optionally, a description. If required, modify the session duration and specify a relay state URL. Note For the relay state URL, you must specify a URL that is in the AWS Management Console. For example: https://console.aws.amazon.com/ec2/ For more information, see Set relay state for quick access to the AWS Management Console. 3. Under What policies do you want to include in your permission set?, select the Attach AWS managed policies check box. 4. In the list of IAM policies, choose both the AWSSSOMasterAccountAdministrator and IAMFullAccess AWS managed policies. These policies grant permissions to any user and groups who are assigned access to this permission set in the future. 5. Choose Next: Tags. 6. Under Add tags (optional), specify values for Key and Value (optional), and then choose Next: Review. For more information about tags, see Tagging AWS IAM Identity Center resources. 7. Review the selections you made, and then choose Create. 3. Follow the steps in Assign user or group access to AWS accounts to assign the appropriate users and groups to the permission set that you just created. 4. Communicate the following to the assigned users: When they sign in to the AWS access portal and choose the Accounts tab, they must choose the appropriate role name to be authenticated with the permissions that you just delegated. Delegate who can assign single sign-on access 318 AWS IAM Identity Center User Guide Manage AWS accounts with permission sets A permission set is a template that you create and maintain that deﬁnes a collection of one or more IAM policies. Permission sets simplify the assignment of AWS account access for users and groups in your organization. For example, you can create a Database Admin permission set that includes policies for administering AWS RDS, DynamoDB, and Aurora services, and use that single permission set to grant access to a list of target AWS accounts within your AWS Organization for your database administrators. IAM Identity Center assigns access to a user or group in one or more AWS accounts with permission sets. When you assign a permission set, IAM Identity Center creates corresponding IAM Identity Center-controlled IAM roles in each account, and attaches the policies speciﬁed in the permission set to those roles. IAM Identity Center manages the role, and allows the authorized users you’ve deﬁned to assume the role, by using the IAM Identity Center User Portal or AWS CLI. As you modify the permission set, IAM Identity Center ensures that the corresponding IAM policies and roles are updated accordingly. You can add AWS managed policies, customer managed policies, inline policies, and AWS managed policies for job functions to your permission sets. You can also assign an AWS managed policy or a customer managed policy as a permissions boundary. To create a permission set, see Create, manage, and delete permission sets. Create a permission set that applies least-privilege permissions To follow the best practice of applying least-privilege permissions, after you create an administrative permission set, you create a more restrictive permission set and assign it to one or more users. The permission sets created in the previous procedure provide a starting point for you to assess the amount of access to resources your users need. To switch to least privilege permissions, you can run IAM Access Analyzer to monitor principals with AWS managed policies. After learning which permissions they're using, then you can write a custom policy or generate a policy with only the required permissions for your team. With IAM Identity Center, you can assign multiple permission sets to the same user. Your administrative user should also be assigned additional, more restrictive, permission sets. That way, they can access your AWS account with only the permissions that required, rather than always using their administrative permissions. Permission sets 319 AWS IAM Identity Center User Guide For example, if you're a developer, after you create your administrative user in IAM Identity Center, you can create a new permission set that grants PowerUserAccess permissions, and then assign that permission set to yourself. Unlike the administrative permission set, which uses AdministratorAccess permissions, the PowerUserAccess permission set doesn't allow management of IAM users and groups. When you sign into the AWS access portal to access your AWS account, you can choose PowerUserAccess rather than the AdministratorAccess to perform development tasks in the
sso-ug-129	sso-ug.pdf	129	required, rather than always using their administrative permissions. Permission sets 319 AWS IAM Identity Center User Guide For example, if you're a developer, after you create your administrative user in IAM Identity Center, you can create a new permission set that grants PowerUserAccess permissions, and then assign that permission set to yourself. Unlike the administrative permission set, which uses AdministratorAccess permissions, the PowerUserAccess permission set doesn't allow management of IAM users and groups. When you sign into the AWS access portal to access your AWS account, you can choose PowerUserAccess rather than the AdministratorAccess to perform development tasks in the account. Keep the following considerations in mind: • To get started quickly with creating a more restrictive permission set, use a predeﬁned permission set rather than a custom permission set. With a predeﬁned permission set, which uses predeﬁned permissions, you choose a single AWS managed policy from a list of available policies. Each policy grants a speciﬁc level of access to AWS services and resources or permissions for a common job function. For information about each of these policies, see AWS managed policies for job functions. • You can conﬁgure the session duration for a permission set to control the length of time that a user is signed into an AWS account. When users federate into their AWS account and use the AWS Management Console or the AWS Command Line Interface (AWS CLI), IAM Identity Center uses the session duration setting on the permission set to control the duration of the session. By default, the value for Session duration, which determines the length of time that a user can be signed into an AWS account before AWS signs the user out of the session, is set to one hour. You can specify a maximum value of 12 hours. For more information, see Set session duration for AWS accounts. • You can also conﬁgure the AWS access portal session duration to control the length of time that a workforce user is signed into the portal. By default, the value for Maximum session duration, which determines the length of time that a workforce user can be signed in to the AWS access portal before they must re-authenticate, is eight hours. You can specify a maximum value of 90 days. For more information, see Conﬁgure the session duration of the AWS access portal and IAM Identity Center integrated applications. • When you sign into the AWS access portal, choose the role that provides least-privilege permissions. Each permission set that you create and assign to your user appears as an available role in the AWS access portal. When you sign in to the portal as that user, choose the role that corresponds Create a permission set that applies least-privilege permissions 320 AWS IAM Identity Center User Guide to the most restrictive permission set that you can use to perform tasks in the account, rather than AdministratorAccess. • You can add other users to IAM Identity Center and assign existing or new permission sets to those users. For information, see, Assign user or group access to AWS accounts. Topics • Predeﬁned permissions for AWS managed policies • Custom permissions for AWS managed and customer managed policies • Create, manage, and delete permission sets • Conﬁgure permission set properties Predeﬁned permissions for AWS managed policies You can create a predeﬁned permission set with AWS managed policies. When you create a permission set with predeﬁned permissions, you choose one policy from a list of AWS managed policies. Within the available policies, you can choose from Common permission policies and Job function policies. Common permission policies Choose from a list of AWS managed policies that make it possible to access resources in your entire AWS account. You can add one of the following policies: • AdministratorAccess • PowerUserAccess • ReadOnlyAccess • ViewOnlyAccess Job function policies Choose from a list of AWS managed policies that make it possible to access resources in your AWS account that might be relevant to a job within your organization. You can add one of the following policies: • Billing • DataScientist Predeﬁned permissions 321 AWS IAM Identity Center User Guide • DatabaseAdministrator • NetworkAdministrator • SecurityAudit • SupportUser • SystemAdministrator For detailed descriptions of the available common permission policies and job function policies, see AWS managed policies for job functions in the AWS Identity and Access Management user guide. For instructions on how to create a permission set, see Create, manage, and delete permission sets. Custom permissions for AWS managed and customer managed policies You can create a permission set with Custom permissions, combining any of the AWS managed and customer managed policies that you have in AWS Identity and Access Management (IAM) along with inline policies. You can also include permissions boundary, setting the maximum possible permissions that other policies can grant
sso-ug-130	sso-ug.pdf	130	of the available common permission policies and job function policies, see AWS managed policies for job functions in the AWS Identity and Access Management user guide. For instructions on how to create a permission set, see Create, manage, and delete permission sets. Custom permissions for AWS managed and customer managed policies You can create a permission set with Custom permissions, combining any of the AWS managed and customer managed policies that you have in AWS Identity and Access Management (IAM) along with inline policies. You can also include permissions boundary, setting the maximum possible permissions that other policies can grant to users of your permission set. For instructions on how to create a permission set, see Create, manage, and delete permission sets. Policy types that you can attach to your permission set Topics • Inline policies • AWS managed policies • Customer managed policies • Permissions boundaries Inline policies You can attach an inline policy to a permission set. An inline policy is a block of text formatted as an IAM policy that you add directly to your permission set. You can paste in a policy, or generate a new one with the policy creation tool in the IAM Identity Center console when you create a new permission set. You can also create IAM policies with the AWS Policy Generator. When you deploy a permission set with an inline policy, IAM Identity Center creates an IAM policy in the AWS accounts where you assign your permission set. IAM Identity Center creates the policy Custom permissions 322 AWS IAM Identity Center User Guide when you assign the permission set to the account. The policy is then attached to the IAM role in your AWS account that your user assumes. When you create an inline policy and assign your permission set, IAM Identity Center conﬁgures the policies in your AWS accounts for you. When you build your permission set with Customer managed policies, you must create the policies in your AWS accounts yourself before you assign the permission set. AWS managed policies You can attach AWS managed policies to your permission set. AWS managed policies are IAM policies that AWS maintains. In contrast, Customer managed policies are IAM policies in your account that you create and maintain. AWS managed policies address common least privilege use cases in your AWS account. You can assign an AWS managed policy as permissions for the role that IAM Identity Center creates, or as a permissions boundary. AWS maintains AWS managed policies for job functions that assign job-speciﬁc access permissions to your AWS resources. You can add one job-function policy when you choose to use Predeﬁned permissions with your permission set. When you choose Custom permissions, you can add more than one job-function policy. Your AWS account also contains a large number of AWS managed IAM policies for speciﬁc AWS services and combinations of AWS services. When you create a permission set with Custom permissions, you can choose from many additional AWS managed policies to assign to your permission set. AWS populates every AWS account with AWS managed policies. To deploy a permission set with AWS managed policies, you don't need to ﬁrst create a policy in your AWS accounts. When you build your permission set with Customer managed policies, you must create the policies in your AWS accounts yourself before you assign the permission set. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. Customer managed policies You can attach customer managed policies to your permission set. Customer managed policies are IAM policies in your account that you create and maintain. In contrast, AWS managed policies are IAM policies in your account that AWS maintains. You can assign a customer managed policy as permissions for the role that IAM Identity Center creates, or as a permissions boundary. Custom permissions 323 AWS IAM Identity Center User Guide When you create a permission set with a customer managed policy, you must create an IAM policy with the same name and path in each AWS account where IAM Identity Center assigns your permission set. If you are specifying a custom path, make sure to specify the same path in each AWS account. For more information, see Friendly names and paths in the IAM User Guide. IAM Identity Center attaches the IAM policy to the IAM role that it creates in your AWS account. As a best practice, apply the same permissions to the policy in each account where you assign the permission set. For more information, see Use IAM policies in permission sets. Note When a customer managed policy is attached to a permission set, the name of the policy is not case sensitive. For more information, see Customer managed policies in the IAM User Guide. Permissions boundaries You can attach a
sso-ug-131	sso-ug.pdf	131	For more information, see Friendly names and paths in the IAM User Guide. IAM Identity Center attaches the IAM policy to the IAM role that it creates in your AWS account. As a best practice, apply the same permissions to the policy in each account where you assign the permission set. For more information, see Use IAM policies in permission sets. Note When a customer managed policy is attached to a permission set, the name of the policy is not case sensitive. For more information, see Customer managed policies in the IAM User Guide. Permissions boundaries You can attach a permissions boundary to your permission set. A permissions boundary is an AWS managed or customer managed IAM policy that sets the maximum permissions that an identity- based policy can grant to an IAM principal. When you apply a permissions boundary, your Inline policies, Customer managed policies, and AWS managed policies can't grant any permissions that exceed the permissions that your permissions boundary grants. A permissions boundary doesn't grant any permissions, but instead makes it so that IAM ignores all permissions beyond the boundary. When you create a permission set with a customer managed policy as a permissions boundary, you must create an IAM policy with the same name in each AWS account where IAM Identity Center assigns your permission set. IAM Identity Center attaches the IAM policy as a permissions boundary to the IAM role that it creates in your AWS account . For more information, see Permissions boundaries for IAM entities in the IAM User Guide. Create, manage, and delete permission sets Permission sets deﬁne the level of access that users and groups have to an AWS account. Permission sets are stored in IAM Identity Center and can be provisioned to one or more AWS accounts. You can assign more than one permission set to a user. For more information about Create, manage, and delete permission sets 324 AWS IAM Identity Center User Guide permission sets and how they are used in IAM Identity Center, see Manage AWS accounts with permission sets. Note You can search and sort permission sets by name in the IAM Identity Center console. Keep the following considerations in mind when creating permissions sets: • Organization instance To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. • Start with a predeﬁned permission set With a predeﬁned permission set, which uses predeﬁned permissions, you choose a single AWS managed policy from a list of available policies. Each policy grants a speciﬁc level of access to AWS services and resources or permissions for a common job function. For information about each of these policies, see AWS managed policies for job functions. After you have collected usage data you can reﬁne the permission set to be more restrictive. • Limit management session duration to reasonable work periods When users federate into their AWS account and use the AWS Management Console or the AWS Command Line Interface (AWS CLI), IAM Identity Center uses the session duration setting on the permission set to control the duration of the session. When the user session reaches the session duration they're signed out of the console and asked to sign in again. As a security best practice, we recommend that you don't set the session duration length longer than is needed to perform the role. By default, the value for Session duration is one hour. You can specify a maximum value of 12 hours. For more information, see Set session duration for AWS accounts. • Limit workforce user portal session duration Workforce users use portal sessions to choose roles and access applications. By default, the value for Maximum session duration, which determines the length of time that a workforce user can be signed in to the AWS access portal before they must re-authenticate, is eight hours. You can specify a maximum value of 90 days. For more information, see Conﬁgure the session duration of the AWS access portal and IAM Identity Center integrated applications. • Use the role that provides least-privilege permissions Create, manage, and delete permission sets 325 AWS IAM Identity Center User Guide Each permission set that you create and assign to your user appears as an available role in the AWS access portal. When you sign in to the portal as that user, choose the role that corresponds to the most restrictive permission set that you can use to perform tasks in the account, rather than AdministratorAccess. Test your permission sets to verify they provide the necessary access before sending the user invitation. Note You can also use AWS CloudFormation to create and assign permission sets and assign users to those permission sets. Topics • Create a permission set • View and
sso-ug-132	sso-ug.pdf	132	Each permission set that you create and assign to your user appears as an available role in the AWS access portal. When you sign in to the portal as that user, choose the role that corresponds to the most restrictive permission set that you can use to perform tasks in the account, rather than AdministratorAccess. Test your permission sets to verify they provide the necessary access before sending the user invitation. Note You can also use AWS CloudFormation to create and assign permission sets and assign users to those permission sets. Topics • Create a permission set • View and change a permission set • Delegate permission set administration • Use IAM policies in permission sets • Remove permission sets in IAM Identity Center • Delete permission sets in IAM Identity Center Create a permission set Use this procedure to create a predeﬁned permission set that uses a single AWS managed policy, or a custom permission set that uses up to 10 AWS managed or customer managed policies and an inline policy. You can request an adjustment to the maximum number of 10 policies in the Service Quotas console for IAM. You can create a permission set in the IAM Identity Center console. Note To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. Create, manage, and delete permission sets 326 AWS IAM Identity Center To create a permission set User Guide 1. Open the IAM Identity Center console. 2. Under Multi-account permissions, choose Permission sets. 3. Choose Create permission set. 4. On the Select permission set type page, under Permission set type, select a permission set type. 5. Choose one or more policies that you want to use for the permission set, based on the permission set type: • Predeﬁned permission set 1. Under Policy for predeﬁned permission set, select one of the IAM Job function policies or Common permission policies in the list, and then choose Next. For more information, see AWS managed policies for job functions and AWS managed policies in the AWS Identity and Access Management User Guide. 2. Go to Step 6 to complete the Specify permission set details page. • Custom permission set 1. Choose Next. 2. On the Specify policies and permission boundary page, choose the types of IAM policies that you want to apply to your new permission set. By default, you can add any combination of up to 10 AWS managed policies and Customer managed policies to your permission set. This quota is set by IAM. To raise it, request an increase to the IAM quota Managed policies attached to an IAM role in the Service Quotas console in each AWS account where you want to assign the permission set. • Expand AWS managed policies to add policies from IAM that AWS builds and maintains. For more information, see AWS managed policies. a. Search for and choose AWS managed policies that you want to apply to your users in the permission set. b. If you want to add another type of policy, choose its container and make your selection. Choose Next when you've chosen all the policies that you want to apply. Go to Step 6 to complete the Specify permission set details page. • Expand Customer managed policies to add policies from IAM that you build and maintain. For more information, see Customer managed policies. Create, manage, and delete permission sets 327 AWS IAM Identity Center User Guide a. Choose Attach policies and enter the name of a policy that you want to add to your permission set. In each account where you want to assign the permission set, create a policy with the name you entered. As a best practice, assign the same permissions to the policy in each account. b. Choose Attach more to add another policy. c. If you want to add another type of policy, choose its container and make your selection. Choose Next when you've chosen all the policies that you want to apply. Go to Step 6 to complete the Specify permission set details page. • Expand Inline policy to add custom JSON-formatted policy text. Inline policies don't correspond to existing IAM resources. To create an inline policy, enter custom policy language in the provided form. IAM Identity Center adds the policy to the IAM resources that it creates in your member accounts. For more information, see Inline policies. a. Add your desired actions and resources within the interactive editor to your inline policy. Additional statements can be added with Add new statement. b. If you want to add another type of policy, choose its container and make your selection. Choose Next when you've chosen all the policies that you want to apply. Go to Step 6
sso-ug-133	sso-ug.pdf	133	don't correspond to existing IAM resources. To create an inline policy, enter custom policy language in the provided form. IAM Identity Center adds the policy to the IAM resources that it creates in your member accounts. For more information, see Inline policies. a. Add your desired actions and resources within the interactive editor to your inline policy. Additional statements can be added with Add new statement. b. If you want to add another type of policy, choose its container and make your selection. Choose Next when you've chosen all the policies that you want to apply. Go to Step 6 to complete the Specify permission set details page. • Expand Permissions boundary to add an AWS managed or customer managed IAM policy as the maximum permissions that your other policies in the permission set can assign. For more information, see Permissions boundaries. a. Choose Use a permissions boundary to control the maximum permissions. b. Choose AWS managed policy to set a policy from IAM that AWS builds and maintains as your permissions boundary. Chose Customer managed policies to set a policy from IAM that you build and maintain as your permissions boundary. c. If you want to add another type of policy, choose its container and make your selection. Choose Next when you've chosen all the policies that you want to apply. Go to Step 6 to complete the Specify permission set details page. 6. On the Specify permission set details page, do the following: 1. Under Permission set name, type a name to identify this permission set in IAM Identity Center. The name that you specify for this permission set appears in the AWS access portal as an available role. Users sign into the AWS access portal, choose an AWS account, and then choose the role. Create, manage, and delete permission sets 328 AWS IAM Identity Center User Guide 2. (Optional) You can also type a description. The description appears in the IAM Identity Center console only, not the AWS access portal. 3. (Optional) Specify the value for Session duration. This value determines the length of time that a user can be logged on before the console logs them out of their session. For more information, see Set session duration for AWS accounts. 4. (Optional) Specify the value for Relay state. This value is used in the federation process to redirect users within the account. For more information, see Set relay state for quick access to the AWS Management Console. Note The relay state URL must be within the AWS Management Console. For example: https://console.aws.amazon.com/ec2/ 5. Expand Tags (optional), choose Add tag, and then specify values for Key and Value (optional). For information about tags, see Tagging AWS IAM Identity Center resources. 6. Choose Next. 7. On the Review and create page, review the selections that you made, and then choose Create. 8. By default, when you create a permission set, the permission set isn't provisioned (used in any AWS accounts). To provision a permission set in an AWS account, you must assign IAM Identity Center access to users and groups in the account, and then apply the permission set to those users and groups. For more information, see Assign user or group access to AWS accounts. View and change a permission set You can use permission sets to grant users access to AWS accounts. You can view and change a permission set with the AWS IAM Identity Center console. You can search and sort permission sets by name in the IAM Identity Center console. For more information about permission sets and how they are used in IAM Identity Center, see the section called “Permission sets”. Permission sets are not required to manage user access to applications. Create, manage, and delete permission sets 329 AWS IAM Identity Center Note User Guide To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. View permission set assignments Use this procedure to view applied permission set in the AWS IAM Identity Center console. All AWS accounts where a permission set is provisioned To view all the assignments for a permission set, use the following procedure: 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, choose Permission sets. 3. On the Permission sets page, select the permission set you want to view. 4. Once on the selected permission sets page, under the Accounts tab, you can see the accounts where the permission set is used. You can select the account to see how the permission set is provisioned within the account. You can delete, edit, and attach policies to the permission set. All permission sets for an AWS account To view all the
sso-ug-134	sso-ug.pdf	134	1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, choose Permission sets. 3. On the Permission sets page, select the permission set you want to view. 4. Once on the selected permission sets page, under the Accounts tab, you can see the accounts where the permission set is used. You can select the account to see how the permission set is provisioned within the account. You can delete, edit, and attach policies to the permission set. All permission sets for an AWS account To view all the assignments for a permission set, use the following procedure: 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, choose AWS accounts. Select the account for which you want to view the provisioned permission sets. 3. Once on the selected AWS account page, under the Permission sets tab, you can view the diﬀerent permission set assigned to the selected AWS account. You can select the permission set hyperlink to learn more about the permission set. All applied permission sets to users and groups To view all the permission sets assigned to users or groups, use the following procedure: Create, manage, and delete permission sets 330 AWS IAM Identity Center User Guide 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Select either Users or Groups under Dashboard to view IAM Identity Center users or groups. a. Once on the Users page, select the user for whom you want to see applied permission sets. Next, select the AWS accounts tab and the AWS account under the AWS account access section. You’ll be able to see the applied permission sets and AWS account for the selected user. b. Once on the Groups page, select the group you want to view applied permission sets. Next, select the AWS accounts tab and the AWS account under the AWS account access section. You’ll be able to see the applied permission sets and AWS account for the selected group. Change a permission set Use this procedure to change a permission set with the IAM Identity Center console. You can add or remove permission sets from users or groups. 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, choose AWS accounts. 3. On the AWS account page, a tree view list of your organization appears. Select the name of the AWS account from which you want to change the permission set. 4. On the Overview page of the AWS account, under Assigned Users and Groups, select the username or group name of the permission set you want to change. Then choose Change permission sets. 5. Make the desired changes to the permission set and then choose Save changes. 6. Navigate to the Permission sets tab and select the recently changed permission set and choose Update. 7. On the Update permissions page, choose Update. Delegate permission set administration IAM Identity Center enables you to delegate management of permission sets and assignments in accounts by creating IAM policies that reference the Amazon Resource Names (ARNs) of IAM Create, manage, and delete permission sets 331 AWS IAM Identity Center User Guide Identity Center resources. For example, you can create policies that enable diﬀerent administrators to manage assignments in speciﬁed accounts for permission sets with speciﬁc tags. Note To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. You can use either of the following methods to create these types of policies. • (Recommended) Create permission sets in IAM Identity Center, each with a diﬀerent policy, and assign the permission sets to diﬀerent users or groups. This enables you to manage administrative permissions for users who sign in using your chosen IAM Identity Center identity source. • Create custom policies in IAM, and then attach them to IAM roles that your administrators assume. For information about roles, see IAM roles to get their assigned IAM Identity Center administrative permissions. Important IAM Identity Center resource ARNs are case sensitive. The following shows the proper case for referencing the IAM Identity Center permission set and account resource types. Resource Types ARN Context Keys PermissionSet arn:${Partition}:s aws:ResourceTag/${ so:::permissionSet TagKey} /${InstanceId}/${P ermissionSetId} Account arn:${Partition}:s Not Applicable so:::account/${Acc ountId} Create, manage, and delete permission sets 332 AWS IAM Identity Center User Guide Use IAM policies in permission sets In Create a permission set, you learned how to add policies, including customer managed policies and permissions boundaries, to a permission set. When you add customer managed policies and permissions to a permission set, IAM Identity
sso-ug-135	sso-ug.pdf	135	Important IAM Identity Center resource ARNs are case sensitive. The following shows the proper case for referencing the IAM Identity Center permission set and account resource types. Resource Types ARN Context Keys PermissionSet arn:${Partition}:s aws:ResourceTag/${ so:::permissionSet TagKey} /${InstanceId}/${P ermissionSetId} Account arn:${Partition}:s Not Applicable so:::account/${Acc ountId} Create, manage, and delete permission sets 332 AWS IAM Identity Center User Guide Use IAM policies in permission sets In Create a permission set, you learned how to add policies, including customer managed policies and permissions boundaries, to a permission set. When you add customer managed policies and permissions to a permission set, IAM Identity Center doesn't create a policy in any AWS accounts. You must instead create those policies in advance in each account where you want to assign your permission set, and match them to the name and path speciﬁcations of your permission set. When you assign a permission set to an AWS account in your organization, IAM Identity Center creates an AWS Identity and Access Management (IAM) role and attaches your IAM policies to that role. Considerations • To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. • Before you assign your permission set with IAM policies, you must prepare your member account. The name of an IAM policy in your member account must be a match to the name of the policy in your management account. IAM Identity Center fails to assign the permission set if the policy doesn't exist in your member account. Note When a customer managed policy is attached to a permission set, the name of the policy is not case sensitive. • The permissions that the policy grants don't have to be an exact match between accounts. Assign an IAM policy to a permission set 1. Create an IAM policy in each of the AWS accounts where you want to assign the permission set. 2. Assign permissions to the IAM policy. You can assign diﬀerent permissions in diﬀerent accounts. For a consistent experience, conﬁgure and maintain identical permissions in each policy. You can use automation resources like AWS CloudFormation StackSets to create copies of an IAM policy with the same name and permissions in each member account. For more information about CloudFormation StackSets, see Working with AWS CloudFormation StackSets in the AWS CloudFormation User guide. Create, manage, and delete permission sets 333 AWS IAM Identity Center User Guide 3. Create a permission set in your management account and add your IAM policy under Customer managed policies or Permissions boundary. For more details about how to create a permission set, See Create a permission set. 4. Add any inline policies, AWS managed policies, or additional IAM policies that you have prepared. 5. Create and assign your permission set. Remove permission sets in IAM Identity Center You can remove a permission set from IAM Identity Center users and groups in the IAM Identity Center console. You can also remove a permission set from an AWS account. For more information about permission sets and how they are used in IAM Identity Center, see Manage AWS accounts with permission sets. Note To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. Remove permission set from a user Remove permission set from a user Use this procedure to remove a permission set from a user with the IAM Identity Center console. 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under IAM Identity Center, select Users. 3. Select the username of the user you want to remove a permission set from. 4. On the user details page, select the AWS accounts tab. Under AWS account access, select your AWS account. 5. In the right pane, the applied permissions for the selected user appears. Select the permission set you want to remove. Under Account Access details, select Remove. 6. A dialog box appears asking if you want to remove this permission set. Select Remove. Create, manage, and delete permission sets 334 AWS IAM Identity Center User Guide Remove permission set from a group Remove permission set from a group Use this procedure to remove a permission set from a group with the IAM Identity Center console. 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, select AWS accounts. Select the link to your management account. 3. Under the Assigned users and groups tab, select the group you want to remove the permission set from and then select Change permission set. 4. On the Change permission sets page, clear the permission set you want to remove
sso-ug-136	sso-ug.pdf	136	permission set from a group Remove permission set from a group Use this procedure to remove a permission set from a group with the IAM Identity Center console. 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, select AWS accounts. Select the link to your management account. 3. Under the Assigned users and groups tab, select the group you want to remove the permission set from and then select Change permission set. 4. On the Change permission sets page, clear the permission set you want to remove and then select Save changes. Create, manage, and delete permission sets 335 AWS IAM Identity Center User Guide Remove permission set from an AWS account Use this procedure to remove a permission set from the AWS account with the IAM Identity Center console. 1. Sign in to the AWS Management Console and open the AWS IAM Identity Center console at https://console.aws.amazon.com/singlesignon/. 2. Under Multi-account permissions, select AWS accounts. Select the name of the AWS account from which you want to remove the permission set. 3. On the Overview page of the AWS account, choose the Permission sets tab. Select the permission set you want to remove. Then select Remove. 4. In the Remove permission set dialog box, conﬁrm that the correct permission set is selected, type Delete to conﬁrm removal, and then choose Remove access. Delete permission sets in IAM Identity Center Before you can delete a permission set from IAM Identity Center, you should remove it from all AWS accounts that use the permission set. To check existing user and group access, see View and change a permission set. Considerations • To use permission sets, you'll need to use an Organization instance of IAM Identity Center. For more information, see Organization and account instances of IAM Identity Center. • If you want to revoke an active permission set session, see Revoke active IAM role sessions created by permission sets. • You should remove permission sets and applications assignments from users or groups you want to delete before deleting them. Otherwise, you'll have unassigned and unused permission sets and applications in IAM Identity Center. Use the following procedure to delete one or more permission sets so that they can no longer be used by any AWS account in the organization. Create, manage, and delete permission sets 336 AWS IAM Identity Center Important User Guide All users and groups that have been assigned this permission set, regardless of what AWS account is using it, will no longer be able to sign in. To check existing user and group access, see View and change a permission set. To delete a permission set from an AWS account 1. Open the IAM Identity Center console. 2. Under Multi-account permissions, choose Permission sets. 3. 4. Select the permission set that you want to delete, and then choose Delete. In the Delete permission set dialog box, type the name of the permission set to conﬁrm deletion, and then choose Delete. The name is case-sensitive. Conﬁgure permission set properties In IAM Identity Center, administrators can complete the following conﬁguration and management tasks to control user access and session duration. Task Learn more Administrators can set the maximum duration for user sessions when accessing AWS resources through IAM Identity Center. Administrators can customize the landing page users see after successfully authentic ating through IAM Identity Center. Set session duration for AWS accounts Set relay state for quick access to the AWS Management Console Ensure users no longer have access to AWS resources when their permissions are revoked. Use a Deny policy to revoke active user permissions Conﬁgure permission set properties 337 AWS IAM Identity Center User Guide Set session duration for AWS accounts For each permission set, you can specify a session duration to control the length of time that a user can be signed in to an AWS account. When the speciﬁed duration elapses, AWS signs the user out of the session. When you create a new permission set, the session duration is set to 1 hour (in seconds) by default. The minimum session duration is 1 hour, and can be set to a maximum of 12 hours. IAM Identity Center automatically creates IAM roles in each assigned account for each permission set, and conﬁgures these roles with a maximum session duration of 12 hours. When users federate into their AWS account console or when the AWS Command Line Interface (AWS CLI) is used, IAM Identity Center uses the session duration setting on the permission set to control the duration of the session. By default, IAM roles generated by IAM Identity Center for permission sets can only be assumed by IAM Identity Center users, which ensures that the session duration speciﬁed in the IAM Identity Center permission
sso-ug-137	sso-ug.pdf	137	hours. IAM Identity Center automatically creates IAM roles in each assigned account for each permission set, and conﬁgures these roles with a maximum session duration of 12 hours. When users federate into their AWS account console or when the AWS Command Line Interface (AWS CLI) is used, IAM Identity Center uses the session duration setting on the permission set to control the duration of the session. By default, IAM roles generated by IAM Identity Center for permission sets can only be assumed by IAM Identity Center users, which ensures that the session duration speciﬁed in the IAM Identity Center permission set is enforced. Important As a security best practice, we recommend that you do not set the session duration length longer than is needed to perform the role. After you create a permission set, you can update it to apply a new session duration. Use the following procedure to modify the session duration length for a permission set. To set the session duration 1. Open the IAM Identity Center console. 2. Under Multi-account permissions, choose Permission sets. 3. Choose the name of the permission set for which you want to change the session duration. 4. On the details page for the permission set, to the right of the General settings section heading, choose Edit. 5. On the Edit general permission set settings page, choose a new value for Session duration. 6. If the permission set is provisioned in any AWS accounts, the names of the accounts appear under AWS accounts to reprovision automatically. After the session duration value for the permission set is updated, all AWS accounts that use the permission set are reprovisioned. Conﬁgure permission set properties 338 AWS IAM Identity Center User Guide This means that the new value for this setting is applied to all AWS accounts that use the permission set. 7. Choose Save changes. 8. At the top of the AWS accounts page, a notiﬁcation appears. • If the permission set is provisioned in one or more AWS accounts, the notiﬁcation conﬁrms that the AWS accounts were reprovisioned successfully, and the updated permission set was applied to the accounts. • If the permission set isn't provisioned in an AWS account, the notiﬁcation conﬁrms that the settings for the permission set were updated. Set relay state for quick access to the AWS Management Console By default, when a user signs into the AWS access portal, chooses an account, and then chooses the role that AWS creates from the assigned permission set, IAM Identity Center redirects the user’s browser to the AWS Management Console. You can change this behavior by setting the relay state to a diﬀerent console URL. Setting the relay state enables you to provide the user with quick access to the console that's most appropriate for their role. For example, you can set the relay state to the Amazon EC2 console URL (https://console.aws.amazon.com/ec2/) to redirect the user to that console when they choose the Amazon EC2 administrator role. During the redirection to the default URL or relay state URL, IAM Identity Center routes the user’s browser to the console endpoint in the last AWS Region used by the user. For example, if a user ended their last console session in the Europe (Stockholm) Region (eu-north-1), the user is redirected to the Amazon EC2 console in that Region. Conﬁgure permission set properties 339 AWS IAM Identity Center User Guide To conﬁgure IAM Identity Center to redirect the user to a console in a speciﬁc AWS Region, include the Region speciﬁcation as part of the URL. For example, to redirect the user to the Amazon EC2 console in the US East (Ohio) Region (us-east-2), specify the URL for the Amazon EC2 console in that Region (https://us-east-2.console.aws.amazon.com/ec2/). If you enabled IAM Identity Center in the US West (Oregon) Region (us-west-2) Region and you want to direct the user to that Region, specify https://us-west-2.console.aws.amazon.com. Conﬁgure the relay state Use the following procedure to conﬁgure the relay state URL for a permission set. 1. Open the IAM Identity Center console. 2. Under Multi-account permissions, choose Permission sets. 3. Choose the name of the permission set for which you want to set the new relay state URL. 4. On the details page for the permission set, to the right of the General settings section heading, choose Edit. 5. On the Edit general permission set settings page, under Relay state, type a console URL for any of the AWS services. For example: Conﬁgure permission set properties 340 AWS IAM Identity Center User Guide https://console.aws.amazon.com/ec2/ Note The relay state URL must be within the AWS Management Console. 6. If the permission set is provisioned in any AWS accounts, the names of the accounts appear under AWS accounts to reprovision automatically. After the relay state URL for the permission set is updated, all
sso-ug-138	sso-ug.pdf	138	details page for the permission set, to the right of the General settings section heading, choose Edit. 5. On the Edit general permission set settings page, under Relay state, type a console URL for any of the AWS services. For example: Conﬁgure permission set properties 340 AWS IAM Identity Center User Guide https://console.aws.amazon.com/ec2/ Note The relay state URL must be within the AWS Management Console. 6. If the permission set is provisioned in any AWS accounts, the names of the accounts appear under AWS accounts to reprovision automatically. After the relay state URL for the permission set is updated, all AWS accounts that use the permission set are reprovisioned. This means that the new value for this setting is applied to all AWS accounts that use the permission set. 7. Choose Save changes. 8. At the top of the AWS Organization page, a notiﬁcation appears. • If the permission set is provisioned in one or more AWS accounts, the notiﬁcation conﬁrms that the AWS accounts were reprovisioned successfully, and the updated permission set was applied to the accounts. • If the permission set isn't provisioned in an AWS account, the notiﬁcation conﬁrms that the settings for the permission set were updated. Note You can automate this process by using the AWS API, an AWS SDK, or the AWS Command Line Interface(AWS CLI). For more information, see: • The CreatePermissionSet or UpdatePermissionSet actions in the IAM Identity Center API Reference • The create-permission-set or update-permission-set commands in the sso- admin section of the AWS CLI Command Reference. Use a Deny policy to revoke active user permissions You might need to revoke an IAM Identity Center user’s access to AWS accounts while the user is actively using a permission set. You can remove their ability to use their active IAM role sessions by implementing a Deny policy for an unspeciﬁed user in advance, then when needed, you can Conﬁgure permission set properties 341 AWS IAM Identity Center User Guide update the Deny policy to specify the user whose access you want to block. This topic explains how to create a Deny policy and considerations for how to deploy the policy. Prepare to revoke an active IAM role session created by a permission set You can prevent the user from taking actions with an IAM role they're actively using by applying a deny all policy for a speciﬁc user through the use of a Service Control Policy You can also prevent a user from using any permission set until you change their password, which removes a bad actor actively misusing stolen credentials. If you need to deny access broadly and prevent a user from re-entering a permission set or accessing other permission sets, you might also remove all user access, stop the active AWS access portal session, and disable the user sign-in. See Revoke active IAM role sessions created by permission sets to learn how to use the Deny policy in conjunction with additional actions for broader access revocation. Deny policy You can use a Deny policy with a condition that matches to the user’s UserID from the IAM Identity Center identity store to prevent further actions by an IAM role that the user is actively using. Using this policy avoids impact to other users who might be using the same permission set when you deploy the Deny policy. This policy uses the placeholder user ID, Add user ID here, for "identitystore:userId" that you’ll update with the user ID for which you want to revoke access. { "Version": "2012-10-17", "Statement": [ { "Effect": "Deny", "Action": [ "" ], "Resource": "", "Condition": { "StringEquals": { "identitystore:userId": "Add user ID here" } } } ] } Conﬁgure permission set properties 342 AWS IAM Identity Center User Guide Although you could use another condition key such as “aws:userId”, “identitystore:userId” is certain because it's a globally unique value that's associated with one person. Using “aws:userId” in the condition can be aﬀected by how user attributes are synchronized from your source of identities and can change if the user’s username or email address changes. From the IAM Identity Center console, you can ﬁnd a user’s identitystore:userId by navigating to Users, searching for the user by name, expanding the General information section and copying the User ID. It's also convenient to stop a user’s AWS access portal session and disable their sign-in access in the same section while searching for the User ID. You can automate the process to create a Deny policy by obtaining the user’s User ID through querying the identity store APIs. Deploying the deny policy You can use a placeholder user ID that isn't valid, such as Add user ID here, to deploy the Deny policy in advance using a Service Control Policy (SCP) that you attach to the AWS accounts users might have access
sso-ug-139	sso-ug.pdf	139	General information section and copying the User ID. It's also convenient to stop a user’s AWS access portal session and disable their sign-in access in the same section while searching for the User ID. You can automate the process to create a Deny policy by obtaining the user’s User ID through querying the identity store APIs. Deploying the deny policy You can use a placeholder user ID that isn't valid, such as Add user ID here, to deploy the Deny policy in advance using a Service Control Policy (SCP) that you attach to the AWS accounts users might have access to. This is the recommended approach for its ease and speed of impact. When you revoke a user’s access with the Deny policy, you'll edit the policy to replace the placeholder user ID with the user ID of the person whose access you want to revoke. This prevents the user from taking any actions with any permission set in every account that you attach the SCP. It blocks the user’s actions even if they use their active AWS access portal session to navigate to diﬀerent accounts and assume diﬀerent roles. With the user’s access fully blocked by the SCP, you can then disable their ability to sign in, revoke their assignments, and stop their AWS access portal session if needed. As an alternative to using SCPs, you can also include the Deny policy in the inline policy of permission sets and in customer managed policies that are used by the permission sets the user can access. If you must revoke access for more than one person, you can use a list of values in the condition block, such as: "Condition": { "StringEquals": { "identitystore:userId": [" user1 userId", "user2 userId"...] } } Conﬁgure permission set properties 343 AWS IAM Identity Center Important User Guide Regardless of the method(s) you use, you must take any other corrective actions and keep the user’s user ID in the policy for at least 12 hours. After that time, any roles the user has assumed expire and you can then remove their user ID from the Deny policy. Referencing permission sets in resource policies, Amazon EKS Cluster conﬁg maps, and AWS KMS key policies When you assign a permission set to an AWS account, IAM Identity Center creates a role with a name that begins with AWSReservedSSO_. The complete name and Amazon Resource Name (ARN) for the role use the following format: Name ARN AWSReservedSSO_ permission-set-nam arn:aws:iam:: aws-account- e_unique-suffix ID:role/aws-reserved/sso.amaz onaws.com/ aws-region /AWSReser vedSSO_ permission-set-nam e_unique-suffix If your identity source in IAM Identity Center is hosted in us-east-1, there is no aws-region in the ARN. The complete name and ARN for the role use the following format: Name ARN AWSReservedSSO_ permission-set-nam arn:aws:iam:: aws-account-ID :role/ e_unique-suffix aws-reserved/sso.amazonaws.com/ AWSReservedSSO_ permission-set-nam e_unique-suffix For example, if you create a permission set that grants AWS account access to database administrators, a corresponding role is created with the following name and ARN: Referencing permission sets 344 AWS IAM Identity Center User Guide Name ARN AWSReservedSSO_DatabaseAdmi arn:aws:iam::111122223333:role/ nistrator_1234567890abcdef aws-reserved/sso.amazonaws.com/ eu-west-2/AWSReservedSSO_Dat abaseAdministrator_12345678 90abcdef If you delete all assignments to this permission set in the AWS account, the corresponding role that IAM Identity Center created is also deleted. If you make a new assignment to the same permission set later, IAM Identity Center creates a new role for the permission set. The name and ARN of the new role include a diﬀerent, unique suﬃx. In this example, the unique suﬃx is abcdef0123456789. Name ARN AWSReservedSSO_DatabaseAdmi arn:aws:iam::111122223333:role/ nistrator_ abcdef0123456789 aws-reserved/sso.amazonaws.com/ eu-west-2/AWSReservedSSO_Dat abaseAdministrator_ abcdef012 3456789 The suﬃx change in the new name and ARN for the role will cause any policies that reference the original name and ARN to be out-of-date, which disrupts access for individuals who use the corresponding permission set. For example, a change in the ARN for the role will disrupt access for users of the permission set if the original ARN is referenced in the following conﬁgurations: • In the aws-auth ConfigMap ﬁle for Amazon Elastic Kubernetes Service (Amazon EKS) clusters when you use the aws-auth ConfigMap for cluster access. • In a resource-based policy for an AWS Key Management Service (AWS KMS) key. This policy is also referred to as a key policy. Note We recommend that you use Amazon EKS access entries to manage access to your Amazon EKS clusters. This allows you to use IAM permissions to manage the principals that have Referencing permission sets 345 AWS IAM Identity Center User Guide access to an Amazon EKS cluster. By using Amazon EKS access entries, you can use an IAM principal with Amazon EKS permissions to regain access to a cluster without contacting Support. Although you can update resource-based policies for most AWS services to reference a new ARN for a role that corresponds to a permission set, you must have
sso-ug-140	sso-ug.pdf	140	policy. Note We recommend that you use Amazon EKS access entries to manage access to your Amazon EKS clusters. This allows you to use IAM permissions to manage the principals that have Referencing permission sets 345 AWS IAM Identity Center User Guide access to an Amazon EKS cluster. By using Amazon EKS access entries, you can use an IAM principal with Amazon EKS permissions to regain access to a cluster without contacting Support. Although you can update resource-based policies for most AWS services to reference a new ARN for a role that corresponds to a permission set, you must have a backup role that you create in IAM for Amazon EKS and AWS KMS if the ARN changes. For Amazon EKS, the backup IAM role must exist in the aws-auth ConfigMap. For AWS KMS, it must exist in your key policies. If you don’t have a backup IAM role with permissions to update the aws-auth ConfigMap or the AWS KMS key policy, contact Support to regain access to those resources. Recommendations to avoid access disruptions To avoid access disruptions due to changes in the ARN for a role that corresponds to a permission set, we recommend that you do the following. • Maintain at least one permission set assignment. Maintain this assignment in the AWS accounts that contain the roles that you reference in the aws-auth ConfigMap for Amazon EKS, key policies in AWS KMS, or resource-based policies for other AWS services. For example, if you create an EKSAccess permission set and reference the corresponding role ARN from AWS account 111122223333, then permanently assign an administrative group to the permission set in that account. Because the assignment is permanent, IAM Identity Center won’t delete the corresponding role, which eliminates the renaming risk. The administrative group will always have access without the risk of privilege escalation. • For Amazon EKS clusters that use aws-auth ConfigMap and AWS KMS: Include a role created in IAM. If you reference role ARNs for permission sets in an aws-auth ConfigMap for Amazon EKS cluster or in key policies for AWS KMS keys, we recommend that you also include at least one role that you create in IAM. The role must allow you to access the Amazon EKS cluster or manage the AWS KMS key policy. The permission set must be able to assume this role. That way, if the role ARN for a permission set changes, you can update the reference to the ARN in the aws- auth ConfigMap or AWS KMS key policy. The next section provides an example of how you Recommendations to avoid access disruptions 346 AWS IAM Identity Center User Guide can create a trust policy for a role that's created in IAM. The role can be assumed only by an AdministratorAccess permission set. Custom trust policy example Following is an example of a custom trust policy that provides an AdministratorAccess permission set with access to a role that's created in IAM. The key elements of this policy include: • The Principal element of this trust policy speciﬁes an AWS account principal. In this policy, principals in the AWS account 111122223333 with sts:AssumeRole permissions can assume the role that's created in IAM. • The Condition element of this trust policy speciﬁes additional requirements for principals that can assume the role created in IAM. In this policy, the permission set with the following role ARN can assume the role. arn:aws:iam::111122223333:role/aws-reserved/sso.amazonaws.com/eu-west-2/ AWSReservedSSO_AdministratorAccess_" Note The Condition element includes the ArnLike condition operator and uses a wildcard at the end of the permission set role ARN, rather than a unique suﬃx. This means that the policy allows the permission set to assume the role created in IAM even if the role ARN for the permission set changes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": "sts:AssumeRole", "Condition": { "ArnLike": { Custom trust policy example 347 AWS IAM Identity Center User Guide "aws:PrincipalArn": "arn:aws:iam::111122223333:role/aws-reserved/ sso.amazonaws.com/eu-west-2/AWSReservedSSO_AdministratorAccess_" } } } ] } Including a role that you create in IAM in such a policy will provide you with emergency access to your Amazon EKS clusters, AWS KMS keys, or other AWS resources if a permission set or all assignments to the permission set are accidentally deleted and re-created. Attribute-based access control Attribute-based access control (ABAC) is an authorization strategy that deﬁnes permissions based on attributes. You can use IAM Identity Center to manage access to your AWS resources across multiple AWS accounts using user attributes that come from any IAM Identity Center identity source. In AWS, these attributes are called tags. Using user attributes as tags in AWS helps you simplify the process of creating ﬁne-grained permissions in AWS and ensures that your workforce gets access only to the AWS resources with matching tags. For example, you can assign developers Bob and
sso-ug-141	sso-ug.pdf	141	set are accidentally deleted and re-created. Attribute-based access control Attribute-based access control (ABAC) is an authorization strategy that deﬁnes permissions based on attributes. You can use IAM Identity Center to manage access to your AWS resources across multiple AWS accounts using user attributes that come from any IAM Identity Center identity source. In AWS, these attributes are called tags. Using user attributes as tags in AWS helps you simplify the process of creating ﬁne-grained permissions in AWS and ensures that your workforce gets access only to the AWS resources with matching tags. For example, you can assign developers Bob and Sally, who are from two diﬀerent teams, to the same permission set in IAM Identity Center and then select the team name attribute for access control. When Bob and Sally sign in to their AWS accounts, IAM Identity Center sends their team name attribute in the AWS session so Bob and Sally can access AWS project resources only if their team name attribute matches the team name tag on the project resource. If Bob moves to Sally’s team in the future, you can modify his access by simply updating his team name attribute in the corporate directory. When Bob signs in next time, he will automatically get access to the project resources of his new team without requiring any permissions updates in AWS. This approach also helps in reducing the number of distinct permissions you need to create and manage in IAM Identity Center as users associated with the same permission sets can now have unique permissions based on their attributes. You can use these user attributes in IAM Identity Center permission sets and resource-based policies to implement ABAC to AWS resources and simplify permissions management at scale. Beneﬁts The following are additional beneﬁts of using ABAC in IAM Identity Center. Attribute-based access control 348 AWS IAM Identity Center User Guide • ABAC requires fewer permission sets – Because you don't have to create diﬀerent policies for diﬀerent job functions, you create fewer permission sets. This reduces your permissions management complexity. • Using ABAC, teams can change and grow quickly – Permissions for new resources are automatically granted based on attributes when resources are appropriately tagged upon creation. • Use employee attributes from your corporate directory with ABAC – You can use existing employee attributes from any identity source conﬁgured in IAM Identity Center to make access control decisions in AWS. • Track who is accessing resources – Security administrators can easily determine the identity of a session by reviewing the user attributes in AWS CloudTrail to track user activity in AWS. For information about how to conﬁgure ABAC using the IAM Identity Center console, see Attributes for access control. For information about how to enable and conﬁgure ABAC using the IAM Identity Center APIs, see CreateInstanceAccessControlAttributeConﬁguration in the IAM Identity Center API Reference Guide. Topics • Checklist: Conﬁguring ABAC in AWS using IAM Identity Center • Attributes for access control Checklist: Conﬁguring ABAC in AWS using IAM Identity Center This checklist includes the conﬁguration tasks that are necessary to prepare your AWS resources and to set up IAM Identity Center for ABAC access. Complete the tasks in this checklist in order. When a reference link takes you to a topic, return back to this topic so that you can proceed with the remaining tasks in this checklist. Step Task Reference 1 Review how to add tags to all your AWS resources. To implement ABAC in IAM Identity Center, you'll ﬁrst need to add tags to all your AWS resources that you want to implement ABAC for. • Tagging AWS resources Checklist: Conﬁguring ABAC in AWS using IAM Identity Center 349 AWS IAM Identity Center Step Task User Guide Reference 2 3 Review how to conﬁgure your identity source in IAM Identity Center with the associated user identities and • Manage your identity source attributes in your identity store. IAM Identity Center lets you use user attributes from any supported IAM Identity Center identity source for ABAC in AWS. Based on the following criteria, determine which attributes you want to use for making access control decisions in AWS and send them to IAM Identity • Getting started Center. • If you are using an external identity provider (IdP), decide whether you want to use attributes passed • Choosing attributes when using an external identity from the IdP or select attributes from within IAM provider as your identity Identity Center. source • If you choose to have your IdP send attributes, conﬁgure your IdP to transmit the attributes in • IAM Identity Center identity source tutorials SAML assertions. See the Optional sections in the tutorial for your speciﬁc IdP. • If you use an IdP as your identity source and choose to select attributes in IAM Identity Center, investiga • Provisioning
sso-ug-142	sso-ug.pdf	142	you are using an external identity provider (IdP), decide whether you want to use attributes passed • Choosing attributes when using an external identity from the IdP or select attributes from within IAM provider as your identity Identity Center. source • If you choose to have your IdP send attributes, conﬁgure your IdP to transmit the attributes in • IAM Identity Center identity source tutorials SAML assertions. See the Optional sections in the tutorial for your speciﬁc IdP. • If you use an IdP as your identity source and choose to select attributes in IAM Identity Center, investiga • Provisioning an external identity provider into IAM te how to conﬁgure SCIM so that the attribute Identity Center using SCIM values come from your IdP. If you cannot use SCIM with your IdP, add the users and their attributes using the IAM Identity Center console User page. • Supported external identity provider attributes Checklist: Conﬁguring ABAC in AWS using IAM Identity Center 350 AWS IAM Identity Center Step Task User Guide Reference • If you use Active Directory or IAM Identity Center as your identity source, or you use an IdP and choose • Choosing attributes when using IAM Identity Center to select attributes in IAM Identity Center, review as your identity source the available attributes that you can conﬁgure. Then • Choosing attributes when using AWS Managed Microsoft AD as your identity source • Default mappings between IAM Identity Center and Microsoft AD • Enable and conﬁgure attributes for access control jump immediately to step 4 to start conﬁguring your ABAC attributes using the IAM Identity Center console. Select the attributes to use for ABAC using the Attributes for access control page in the IAM Identity Center console. From this page you can select attributes for access control from the identity source that you conﬁgured in step 2. After your identities and their attributes are in IAM Identity Center, you must create key-value pairs (mappings) which will be passed to your AWS accounts for use in access control decisions. Create custom permissions policies within your permission set and use access control attributes • Create permission policies for ABAC in IAM Identity to create ABAC rules so that users can only access Center resources with matching tags. User attributes that you conﬁgured in step 4 are used as tags in AWS for access control decisions. You can refer to the access control attributes in the permissions policy using the aws:PrincipalTag/key condition. In your various AWS accounts, assign users to permissions sets you created in step 5. Doing so ensures that when they federate into their accounts and access AWS resources, they only get access based on matching tags. • Assign user or group access to AWS accounts 4 5 6 Checklist: Conﬁguring ABAC in AWS using IAM Identity Center 351 AWS IAM Identity Center User Guide After you complete these steps, users who federate into an AWS account using single sign-on will get access to their AWS resources based on matching attributes. Attributes for access control Attributes for access control is the name of the page in the IAM Identity Center console where you select user attributes that you want to use in policies to control access to resources. You can assign users to workloads in AWS based on existing attributes in the users' identity source. For example, suppose you want to assign access to S3 buckets based on department names. While on the Attributes for access control page, you select the Department user attribute for use with attribute-based access control (ABAC). In the IAM Identity Center permission set, you then write a policy that grants users access only when the Department attribute matches the department tag that you assigned to your S3 buckets. IAM Identity Center passes the user's department attribute to the account being accessed. The attribute is then used to determine access based on the policy. For more information about ABAC, see Attribute-based access control. Getting started How you get started conﬁguring attributes for access control depends on which identity source you are using. Regardless of the identity source you choose, after you have selected your attributes you need to create or edit permission set policies. These policies must grant user identities access to AWS resources. Choosing attributes when using IAM Identity Center as your identity source When you conﬁgure IAM Identity Center as the identity source, you ﬁrst add users and conﬁgure their attributes. Next, navigate to the Attributes for access control page and select the attributes you want to use in policies. Finally, navigate to the AWS accounts page to create or edit permission sets to use the attributes for ABAC. Choosing attributes when using AWS Managed Microsoft AD as your identity source When you conﬁgure IAM Identity Center with AWS Managed Microsoft AD as your
sso-ug-143	sso-ug.pdf	143	must grant user identities access to AWS resources. Choosing attributes when using IAM Identity Center as your identity source When you conﬁgure IAM Identity Center as the identity source, you ﬁrst add users and conﬁgure their attributes. Next, navigate to the Attributes for access control page and select the attributes you want to use in policies. Finally, navigate to the AWS accounts page to create or edit permission sets to use the attributes for ABAC. Choosing attributes when using AWS Managed Microsoft AD as your identity source When you conﬁgure IAM Identity Center with AWS Managed Microsoft AD as your identity source, you ﬁrst map a set of attributes from Active Directory to user attributes in IAM Identity Center. Next, navigate to the Attributes for access control page. Then choose which attributes to use in your ABAC conﬁguration based on the existing set of SSO attributes mapped from Active Directory. Finally, author ABAC rules using the access control attributes in permission sets to grant user identities access to AWS resources. For a list of the default mappings for user attributes in IAM Attributes for access control 352 AWS IAM Identity Center User Guide Identity Center to the user attributes in your AWS Managed Microsoft AD directory, see Default mappings between IAM Identity Center and Microsoft AD. Choosing attributes when using an external identity provider as your identity source When you conﬁgure IAM Identity Center with an external identity provider (IdP) as your identity source, there are two ways to use attributes for ABAC. • You can conﬁgure your IdP to send the attributes through SAML assertions. In this case, IAM Identity Center passes the attribute name and value from the IdP through for policy evaluation. Note Attributes in SAML assertions will not be visible to you on the Attributes for access control page. You will have to know these attributes in advance and add them to access control rules when you author policies. If you decide to trust your external IdPs for attributes, then these attributes will always be passed when users federate into AWS accounts. In scenarios where the same attributes are coming to IAM Identity Center through SAML and SCIM, the SAML attributes value take precedence in access control decisions. • You can conﬁgure which attributes you use from the Attributes for access control page in the IAM Identity Center console. The attributes values that you choose here replace the values for any matching attributes that come from an IdP through an assertion. Depending on whether you are using SCIM, consider the following: • If using SCIM, the IdP automatically synchronizes the attribute values into IAM Identity Center. Additional attributes that are required for access control might not be present in the list of SCIM attributes. In that case, consider collaborating with the IT admin in your IdP to send such attributes to IAM Identity Center via SAML assertions using the required https:// aws.amazon.com/SAML/Attributes/AccessControl: preﬁx. For information about how to conﬁgure user attributes for access control in your IdP to send through SAML assertions, see the IAM Identity Center identity source tutorials for your IdP. • If you are not using SCIM, you must manually add the users and set their attributes just as if you were using IAM Identity Center as an identity source. Next, navigate to the Attributes for access control page and choose the attributes you want to use in policies. Attributes for access control 353 AWS IAM Identity Center User Guide For a complete list of supported attributes for user attributes in IAM Identity Center to the user attributes in your external IdPs, see Supported external identity provider attributes. To get started with ABAC in IAM Identity Center, see the following topics. Topics • Enable and conﬁgure attributes for access control • Create permission policies for ABAC in IAM Identity Center Enable and conﬁgure attributes for access control To use attribute-based access control (ABAC), you must ﬁrst enable it in either the Settings page of the IAM Identity Center console or the IAM Identity Center API. Regardless of the identity source, you can always conﬁgure user attributes from the Identity Store for use in ABAC. In the console, you can do this by navigating to the Attributes for access control tab on the Settings page. If you use an external identity provider (IdP) as the identity source, you also have the option of receiving attributes from the external IdP in SAML assertions. In this case, you need to conﬁgure the external IdP to send the desired attributes. If an attribute from a SAML assertion is also deﬁned as an ABAC attribute in IAM Identity Center, IAM Identity Center will send the value from its Identity Store as a session tag on sign-in to an AWS account. Note You cannot view attributes conﬁgured and sent
sso-ug-144	sso-ug.pdf	144	to the Attributes for access control tab on the Settings page. If you use an external identity provider (IdP) as the identity source, you also have the option of receiving attributes from the external IdP in SAML assertions. In this case, you need to conﬁgure the external IdP to send the desired attributes. If an attribute from a SAML assertion is also deﬁned as an ABAC attribute in IAM Identity Center, IAM Identity Center will send the value from its Identity Store as a session tag on sign-in to an AWS account. Note You cannot view attributes conﬁgured and sent by an external IdP from the Attributes for access control page in the IAM Identity Center console. If you are passing access control attributes in the SAML assertions from your external IdP, then those attributes are directly sent to the AWS account when users federate in. The attributes won’t be available in IAM Identity Center for mapping. Topics • Enable attributes for access control • Select your attributes for access control • Disable attributes for access control Attributes for access control 354 AWS IAM Identity Center User Guide Enable attributes for access control Use the following procedure to enable the attributes for access (ABAC) control feature using the IAM Identity Center console. Note If you have existing permission sets and you plan to enable ABAC in your IAM Identity Center instance, additional security restrictions require you to ﬁrst have the iam:UpdateAssumeRolePolicy policy. These additional security restrictions are not required if you do not have any permission sets created in your account. To enable Attributes for access control 1. Open the IAM Identity Center console. 2. Choose Settings 3. On the Settings page, locate the Attributes for access control information box, and then choose Enable. Continue to the next procedure to conﬁgure it. Select your attributes for access control Use the following procedure to set up attributes for your ABAC conﬁguration. To select your attributes using the IAM Identity Center console 1. Open the IAM Identity Center console. 2. Choose Settings 3. On the Settings page, choose the Attributes for access control tab, and then choose Manage attributes. 4. On the Attributes for access control page, choose Add attribute and enter the Key and Value details. This is where you will be mapping the attribute coming from your identity source to an attribute that IAM Identity Center passes as a session tag. Attributes for access control 355 AWS IAM Identity Center User Guide Key represents the name you are giving to the attribute for use in policies. This can be any arbitrary name, but you need to specify that exact name in the policies you author for access control. For example, lets say that you are using Okta (an external IdP) as your identity source and need to pass your organization's cost center data along as session tags. In Key, you would enter a similarly matched name like CostCenter as your key name. It's important to note that whichever name you choose here, it must also be named exactly the same in your aws:PrincipalTag condition key (that is, "ec2:ResourceTag/CostCenter": "${aws:PrincipalTag/CostCenter}"). Note Use a single-value attribute for your key, for example, Manager. IAM Identity Center doesn't support multi-value attributes for ABAC, for example, Manager, IT Systems. Value represents the content of the attribute coming from your conﬁgured identity source. Here you can enter any value from the appropriate identity source table listed in Attribute mappings between IAM Identity Center and External Identity Providers directory. For example, using the context provided in the above mentioned example, you would review the list of supported IdP attributes and determine that the closest match of a supported attribute would be ${path:enterprise.costCenter} and you would then enter it in the Value ﬁeld. See the screenshot provided above for reference. Note, that you can’t use external IdP attribute values outside of this list for ABAC unless you use the option of passing attributes through the SAML assertion. 5. Choose Save changes. Now that you have conﬁgured mapping your access control attributes, you need to complete the ABAC conﬁguration process. To do this, create your ABAC rules and add them to your permission sets and/or resource-based policies. This is required so that you can grant user identities access Attributes for access control 356 AWS IAM Identity Center User Guide to AWS resources. For more information, see Create permission policies for ABAC in IAM Identity Center. Disable attributes for access control Use the following procedure to disable the ABAC feature and delete all of the attribute mappings that have been conﬁgured. To disable Attributes for access control 1. Open the IAM Identity Center console. 2. Choose Settings. 3. On the Settings page, choose the Attributes for access control tab, and then choose Manage attributes. 4. On the Manage attributes for
sso-ug-145	sso-ug.pdf	145	required so that you can grant user identities access Attributes for access control 356 AWS IAM Identity Center User Guide to AWS resources. For more information, see Create permission policies for ABAC in IAM Identity Center. Disable attributes for access control Use the following procedure to disable the ABAC feature and delete all of the attribute mappings that have been conﬁgured. To disable Attributes for access control 1. Open the IAM Identity Center console. 2. Choose Settings. 3. On the Settings page, choose the Attributes for access control tab, and then choose Manage attributes. 4. On the Manage attributes for access control page, choose Disable. 5. In the Disable attributes for access control dialog window, review the information and when ready enter DISABLE, and then choose Conﬁrm. Important This step deletes all attributes and stops the use of attributes for access control when federating into AWS accounts regardless of whether any attributes are present in SAML assertions from an external identity source provider. Create permission policies for ABAC in IAM Identity Center You can create permissions policies that determine who can access your AWS resources based on the conﬁgured attribute value. When you enable ABAC and specify attributes, IAM Identity Center passes the attribute value of the authenticated user into IAM for use in policy evaluation. aws:PrincipalTag condition key You can use access control attributes in your permission sets using the aws:PrincipalTag condition key for creating access control rules. For example, in the following policy you can tag all the resources in your organization with their respective cost centers. You can also use a single permission set that grants developers access to their cost center resources. Now, whenever developers federate into the account using single sign-on and their cost center attribute, they only Attributes for access control 357 AWS IAM Identity Center User Guide get access to the resources in their respective cost centers. As the team adds more developers and resources to their project, you only have to tag resources with the correct cost center. Then you pass cost center information in the AWS session when developers federate into AWS accounts. As a result, as the organization adds new resources and developers to the cost center, developers can manage resources aligned to their cost centers without needing any permission updates. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ec2:DescribeInstances" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "ec2:StartInstances", "ec2:StopInstances" ], "Resource": "", "Condition": { "StringEquals": { "ec2:ResourceTag/CostCenter": "${aws:PrincipalTag/CostCenter}" } } } ] } For more information, see aws:PrincipalTag and EC2: Start or stop instances based on matching principal and resource tags in the IAM User Guide. If policies contain invalid attributes in their conditions, then the policy condition will fail and access will be denied. For more information, see Error 'An unexpected error has occurred' when a user tries to sign in using an external identity provider. Attributes for access control 358 AWS IAM Identity Center User Guide Repair the IAM identity provider When you add single sign-on access to an AWS account, IAM Identity Center creates an IAM identity provider in each AWS account. An IAM identity provider helps keep your AWS account secure because you don't have to distribute or embed long-term security credentials, such as access keys, in your application. If you delete or modify your identity provider, you must manually reapply your user and group assignments. Reapplying your user and group assignments recreates the identity provider. For more information, see: • AWS account access • Application access Understanding service-linked roles in IAM Identity Center Service-linked roles are predeﬁned IAM permissions that allow IAM Identity Center to delegate and enforce which users have single sign-on access to speciﬁc AWS accounts in your organization in AWS Organizations. The service enables this functionality by provisioning a service-linked role in every AWS account within its organization. The service then allows other AWS services like IAM Identity Center to leverage those roles to perform service-related tasks. For more information, see AWS Organizations and service-linked roles. When you enable IAM Identity Center, IAM Identity Center creates a service-linked role in all accounts within the organization in AWS Organizations. IAM Identity Center also creates the same service-linked role in every account that is subsequently added to your organization. This role allows IAM Identity Center to access each account's resources on your behalf. For more information, see AWS account access. Service-linked roles that are created in each AWS account are named AWSServiceRoleForSSO. For more information, see Using service-linked roles for IAM Identity Center. Notes • If you're signed in to the AWS Organizations management account, it uses your currently signed-in role and not the service-linked role. This prevents the escalation of privileges. Repair the IAM identity provider 359 AWS IAM Identity Center User Guide • When IAM Identity Center performs
sso-ug-146	sso-ug.pdf	146	every account that is subsequently added to your organization. This role allows IAM Identity Center to access each account's resources on your behalf. For more information, see AWS account access. Service-linked roles that are created in each AWS account are named AWSServiceRoleForSSO. For more information, see Using service-linked roles for IAM Identity Center. Notes • If you're signed in to the AWS Organizations management account, it uses your currently signed-in role and not the service-linked role. This prevents the escalation of privileges. Repair the IAM identity provider 359 AWS IAM Identity Center User Guide • When IAM Identity Center performs any IAM operations in the AWS Organizations management account, all operations happen using the credentials of the IAM principal. This enables the logs in CloudTrail to provide visibility of who made all privilege changes in the management account. Service-linked roles 360 AWS IAM Identity Center User Guide Resiliency design and Regional behavior The IAM Identity Center service is fully managed and uses highly available and durable AWS services, such as Amazon S3 and Amazon EC2. To ensure availability in the event of an availability zone disruption, IAM Identity Center operates across multiple availability zones. You enable IAM Identity Center in your AWS Organizations management account. This is required so that IAM Identity Center can provision, de-provision, and update roles across all your AWS accounts. When you enable IAM Identity Center, it's deployed to the AWS Region that's currently selected. If you want to deploy to a speciﬁc AWS Region, change the region selection before enabling IAM Identity Center. Note IAM Identity Center controls access to its permission sets and applications from its primary Region only. We recommend that you consider the risks associated with access control when IAM Identity Center operates in a single Region. Although IAM Identity Center determines access from the Region in which you enable the service, AWS accounts are global. This means that after users sign in to IAM Identity Center, they can operate in any Region when they access AWS accounts through IAM Identity Center. Most AWS managed applications such as Amazon SageMaker AI, however, must be installed in the same Region as IAM Identity Center for users to authenticate and assign access to these applications. For information about Regional constraints when using an application with IAM Identity Center, see the documentation for the application. You can also use IAM Identity Center to authenticate and authorize access to SAML-based applications that are reachable through a public URL, regardless of the platform or cloud on which the application is built. We don't recommend using Account instances of IAM Identity Center as a means to implement resiliency as it creates a second, isolated control point that isn't connected to your organization instance. 361 AWS IAM Identity Center User Guide Designed for availability The following table provides the availability that IAM Identity Center is designed to achieve. These values don’t represent a Service Level Agreement or guarantee, but rather provide insight to the design goals. The availability percentages reference access to data or functions, and aren’t a reference to durability (for example, long term retention of data). Service component Availability design goal Data plane (including sign-in) Control plane 99.95% 99.90% Set up emergency access to the AWS Management Console IAM Identity Center is built from highly available AWS infrastructure and uses an Availability Zone architecture to eliminate single points of failure. For an extra layer of protection in the unlikely event of an IAM Identity Center or AWS Region disruption, we recommend that you set up a conﬁguration that you can use to provide temporary access to the AWS Management Console. AWS enables you to: • Connect your third-party IdP to IAM Identity Center. • Connect your third-party IdP to individual AWS accounts by using SAML 2.0-based federation. If you use IAM Identity Center, you can use these capabilities to create the emergency access conﬁguration described in the following sections. This conﬁguration enables you to use IAM Identity Center as the mechanism for AWS account access. If IAM Identity Center is disrupted, your emergency operations users can sign in to the AWS Management Console through direct federation, by using the same credentials that they use to access their accounts. This conﬁguration works when IAM Identity Center is unavailable, but the IAM data plane and your external identity provider (IdP) are available. Important We recommend that you deploy this conﬁguration before a disruption occurs because you can't create the conﬁguration if your access to create the required IAM roles is also Designed for availability 362 AWS IAM Identity Center User Guide disrupted. Also, test this conﬁguration periodically to ensure that your team understands what to do if IAM Identity Center is disrupted. Topics • Summary of emergency access conﬁguration • How to design your critical operations roles • How
sso-ug-147	sso-ug.pdf	147	accounts. This conﬁguration works when IAM Identity Center is unavailable, but the IAM data plane and your external identity provider (IdP) are available. Important We recommend that you deploy this conﬁguration before a disruption occurs because you can't create the conﬁguration if your access to create the required IAM roles is also Designed for availability 362 AWS IAM Identity Center User Guide disrupted. Also, test this conﬁguration periodically to ensure that your team understands what to do if IAM Identity Center is disrupted. Topics • Summary of emergency access conﬁguration • How to design your critical operations roles • How to plan your access model • How to design emergency role, account, and group mapping • How to create your emergency access conﬁguration • Emergency preparation tasks • Emergency failover process • Return to normal operations • One-time setup of a direct IAM federation application in Okta Summary of emergency access conﬁguration To conﬁgure emergency access, you must complete the following tasks: 1. Create an emergency operations account in your organization in AWS Organizations. This account will become your emergency operations account. 2. Connect your IdP to the emergency operations account by using SAML 2.0-based federation. 3. In the emergency operations account, create a role for third-party identity provider federation. Also, create an emergency operations role in each of your workload accounts, with your required permissions. 4. Delegate access to your workload accounts for the IAM role that you created in the emergency operations account. To authorize access to your emergency operations account, create an emergency operations group in your IdP, with no members. 5. Enable the emergency operations group in your IdP to use the emergency operations role by creating a rule in your IdP that enables SAML 2.0 federated access to the AWS Management Console. During normal operations, no one has access to the emergency operations account because the emergency operations group in your IdP has no members. In the event of an IAM Identity Center Summary of emergency access conﬁguration 363 AWS IAM Identity Center User Guide disruption, use your IdP to add trusted users to the emergency operations group in your IdP. These users can then sign in to your IdP, navigate to the AWS Management Console, and assume the emergency operations role in the emergency operations account. From there, these users can switch roles to the emergency access role in your workload accounts where they need to perform operations work. How to design your critical operations roles With this design, you conﬁgure a single AWS account in which you federate through IAM, so that users can assume critical operations roles. The critical operations roles have a trust policy that enables users to assume a corresponding role in your workload accounts. The roles in the workload accounts provide the permissions that users require to perform essential work. The following diagram provides a design overview. How to design your critical operations roles 364 AWS IAM Identity Center User Guide How to plan your access model Before you conﬁgure emergency access, create a plan for how the access model will work. Use the following process to create this plan. 1. Identify the AWS accounts where emergency operator access is essential during a disruption to IAM Identity Center. For example, your production accounts are probably essential, but your development and test accounts might not be. 2. For that collection of accounts, identify the speciﬁc critical roles that you need in your accounts. Across these accounts, be consistent in deﬁning what the roles can do. This simpliﬁes work in your emergency access account where you create cross-account roles. We recommend that you start with two distinct roles in these accounts: Read Only (RO) and Operations (Ops). If required, you can create more roles and map these roles to a more distinct group of emergency access users in your setup. 3. Identify and create emergency access groups in your IdP. The group members are the users to whom you are delegating access to emergency access roles. 4. Deﬁne which roles these groups can assume in the emergency access account. To do this, deﬁne rules in your IdP that generate claims that list which roles the group can access. These groups can then assume your Read Only or Operations roles in emergency access account. From those roles, they can assume corresponding roles in your workload accounts. How to design emergency role, account, and group mapping The following diagram shows how to map your emergency access groups to roles in your emergency access account. The diagram also shows the cross-account role trust relationships that enable emergency access account roles to access corresponding roles in your workload accounts. We recommend that your emergency plan design use these mappings as a starting point. How to plan your access model 365 AWS IAM Identity Center User
sso-ug-148	sso-ug.pdf	148	then assume your Read Only or Operations roles in emergency access account. From those roles, they can assume corresponding roles in your workload accounts. How to design emergency role, account, and group mapping The following diagram shows how to map your emergency access groups to roles in your emergency access account. The diagram also shows the cross-account role trust relationships that enable emergency access account roles to access corresponding roles in your workload accounts. We recommend that your emergency plan design use these mappings as a starting point. How to plan your access model 365 AWS IAM Identity Center User Guide How to create your emergency access conﬁguration Use the following mapping table to create your emergency access conﬁguration. This table reﬂects a plan that includes two roles in the workload accounts: Read Only (RO) and Operations (Ops) , with corresponding trust policies and permissions policies. The trust policies enable the emergency access account roles to access the individual workload account roles. The individual workload account roles also have permissions policies for what the role can do in the account. The permissions policies can be AWS managed policies or customer managed policies. Account Roles to create Trust policy Permissions policy Account 1 EmergencyAccess_RO EmergencyAccess_Ro le1_RO Account 1 EmergencyAccess_Op s EmergencyAccess_Ro le1_Ops arn:aws:iam::aws:p olicy/ReadOnlyAccess arn:aws:iam::aws:p olicy/job-function/ SystemAdministrator How to create your emergency access conﬁguration 366 AWS IAM Identity Center User Guide Account Roles to create Trust policy Permissions policy Account 2 EmergencyAccess_RO EmergencyAccess_Ro le2_RO arn:aws:iam::aws:p olicy/ReadOnlyAccess Account 2 EmergencyAccess_Op s EmergencyAccess_Ro le2_Ops arn:aws:iam::aws:p olicy/job-function/ Emergency access account EmergencyAccess_Ro le1_RO IdP SystemAdministrator AssumeRole for role resource in account EmergencyAccess_Ro le1_Ops EmergencyAccess_Ro le2_RO EmergencyAccess_Ro le2_Ops In this mapping plan, the emergency access account contains two read-only roles and two operations roles. These roles trust your IdP to authenticate and authorize your selected groups to access the roles by passing the names of the roles in assertions. There are corresponding read- only and operations roles in workload Account 1 and Account 2. For workload Account 1, the EmergencyAccess_RO role trusts the EmergencyAccess_Role1_RO role that resides in the emergency access account. The table speciﬁes similar trust patterns between the workload account read-only and operations roles and the corresponding emergency access roles. Emergency preparation tasks To prepare your emergency access conﬁguration, we recommend that you perform the following tasks before an emergency occurs. 1. Set up a direct IAM federation application in your IdP. For more information, see One-time setup of a direct IAM federation application in Okta. 2. Create an IdP connection in the emergency access account that can be accessed during the event. Emergency preparation tasks 367 AWS IAM Identity Center User Guide 3. Create emergency access roles in the emergency access accounts as described in the mapping table above. 4. Create temporary operations roles with trust and permission policies in each of the workload accounts. 5. Create temporary operations groups in your IdP. The group names will depend on the names of the temporary operations roles. 6. Test direct IAM federation. 7. Disable the IdP federation application in your IdP to prevent regular usage. Emergency failover process When an IAM Identity Center instance isn't available and you determine that you must provide emergency access to the AWS Management Console, we recommend the following failover process. 1. The IdP administrator enables the direct IAM federation application in your IdP. 2. Users request access to the temporary operations group through your existing mechanism, such as an email request, Slack channel, or other form of communication. 3. Users that you add to your emergency access groups sign in to the IdP, select the emergency access account, and, users choose a role to use in the emergency access account. From these roles, they can assume roles in corresponding workload accounts that have cross-account trust with the emergency account role. Return to normal operations Check the AWS Health Dashboardto conﬁrm when the health of the IAM Identity Center service is restored. To return to normal operations, perform the following steps. 1. After the status icon for the IAM Identity Center service indicates that the service is healthy, sign in to IAM Identity Center. 2. If you can sign in to IAM Identity Center successfully, communicate to emergency access users that IAM Identity Center is available. Instruct these users to sign out and use the AWS access portal to sign back in to IAM Identity Center. 3. After all emergency access users sign out, in the IdP, disable the IdP federation application. We recommend that you perform this task after working hours. 4. Remove all users from the emergency access group in the IdP. Emergency failover process 368 AWS IAM Identity Center User Guide Your emergency access role infrastructure remains in place as a backup access plan, but it is now disabled. One-time setup of a direct IAM federation
sso-ug-149	sso-ug.pdf	149	users that IAM Identity Center is available. Instruct these users to sign out and use the AWS access portal to sign back in to IAM Identity Center. 3. After all emergency access users sign out, in the IdP, disable the IdP federation application. We recommend that you perform this task after working hours. 4. Remove all users from the emergency access group in the IdP. Emergency failover process 368 AWS IAM Identity Center User Guide Your emergency access role infrastructure remains in place as a backup access plan, but it is now disabled. One-time setup of a direct IAM federation application in Okta 1. 2. Sign in to your Okta account as a user with administrative permissions. In the Okta Admin Console, under Applications, choose Applications. 3. Choose Browse App Catalog. Search for and choose AWS Account Federation. Then choose Add integration. 4. Set up direct IAM federation with AWS by following the steps in How to Conﬁgure SAML 2.0 for AWS Account Federation. 5. On the Sign-On Options tab, select SAML 2.0 and enter Group Filter and Role Value Pattern settings. The name of the group for the user directory depends on the ﬁlter that you conﬁgure. In the ﬁgure above, the role variable is for the emergency operations role in your emergency access account. For example, if you create the EmergencyAccess_Role1_RO role (as described in the mapping table) in AWS account 123456789012, and if your group ﬁlter setting is conﬁgured as shown in the ﬁgure above, your group name should be aws#EmergencyAccess_Role1_RO#123456789012. 6. In your directory (for example, your directory in Active Directory), create the emergency access group and specify a name for the directory (for example, aws#EmergencyAccess_Role1_RO#123456789012). Assign your users to this group by using your existing provisioning mechanism. 7. In the emergency access account, conﬁgure a custom trust policy that provides the permissions required for the emergency access role to be assumed during a disruption. Following is an example statement for a custom trust policy that is attached to the EmergencyAccess_Role1_RO role. For an illustration, see the emergency account in the diagram under How to design emergency role, account, and group mapping. { "Version": "2012-10-17", One-time setup of a direct IAM federation application in Okta 369 AWS IAM Identity Center User Guide "Statement": [ { "Effect":"Allow", "Principal":{ "Federated":"arn:aws:iam::123456789012:saml-provider/Okta" }, "Action":[ "sts:AssumeRoleWithSAML", "sts:SetSourceIdentity", "sts:TagSession" ], "Condition":{ "StringEquals":{ "SAML:aud":"https:~/~/signin.aws.amazon.com/saml" } } } ] } 8. The following is an example statement for a permissions policy that is attached to the EmergencyAccess_Role1_RO role. For an illustration, see the emergency account in the diagram under How to design emergency role, account, and group mapping. { "Version": "2012-10-17", "Statement":[ { "Effect":"Allow", "Action":"sts:AssumeRole", "Resource":[ "arn:aws:iam::<account 1>:role/EmergencyAccess_RO", "arn:aws:iam::<account 2>:role/EmergencyAccess_RO" ] } ] } 9. On the workload accounts, conﬁgure a custom trust policy. Following is an example statement for a trust policy that is attached to the EmergencyAccess_RO role. In this example, account 123456789012 is the emergency access account. For an illustration, see workload account in the diagram under How to design emergency role, account, and group mapping. One-time setup of a direct IAM federation application in Okta 370 AWS IAM Identity Center User Guide { "Version": "2012-10-17", "Statement":[ { "Effect":"Allow", "Principal":{ "AWS":"arn:aws:iam::123456789012:root" }, "Action":"sts:AssumeRole" } ] } Note Most IdPs enable you to keep an application integration deactivated until required. We recommend that you keep the direct IAM federation application deactivated in your IdP until required for emergency access. One-time setup of a direct IAM federation application in Okta 371 AWS IAM Identity Center User Guide Security in AWS IAM Identity Center Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS compliance programs. To learn about the compliance programs that apply to AWS IAM Identity Center, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using IAM Identity Center. The following topics show you how to conﬁgure IAM Identity Center to meet your security and compliance objectives. You also learn how to use other
sso-ug-150	sso-ug.pdf	150	learn about the compliance programs that apply to AWS IAM Identity Center, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using IAM Identity Center. The following topics show you how to conﬁgure IAM Identity Center to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your IAM Identity Center resources. Topics • Identity and access management for IAM Identity Center • IAM Identity Center console and API authorization • AWS STS condition context keys for IAM Identity Center • Logging and monitoring in IAM Identity Center • Compliance validation for IAM Identity Center • Resilience in IAM Identity Center • Infrastructure security in IAM Identity Center 372 AWS IAM Identity Center User Guide Identity and access management for IAM Identity Center Access to IAM Identity Center requires credentials that AWS can use to authenticate your requests. Those credentials must have permissions to access AWS resources, such as an AWS managed application. Authentication to the AWS access portal is controlled by the directory that you have connected to IAM Identity Center. However, authorization to the AWS accounts that are available to users from within the AWS access portal is determined by two factors: 1. Who has been assigned access to those AWS accounts in the IAM Identity Center console. For more information, see Single sign-on access to AWS accounts. 2. What level of permissions have been granted to the users in the IAM Identity Center console to allow them the appropriate access to those AWS accounts. For more information, see Create, manage, and delete permission sets. The following sections explain how you as an administrator can control access to the IAM Identity Center console or can delegate administrative access for day-to-day tasks from the IAM Identity Center console. • Authentication • Access control Authentication Learn how to access AWS using IAM identities. Access control You can have valid credentials to authenticate your requests, but unless you have permissions, you can't create or access IAM Identity Center resources. For example, you must have permissions to create an IAM Identity Center connected directory. The following sections describe how to manage permissions for IAM Identity Center. We recommend that you read the overview ﬁrst. • Overview of managing access permissions to your IAM Identity Center resources Identity and access management for IAM Identity Center 373 AWS IAM Identity Center User Guide • Identity-based policy examples for IAM Identity Center • Using service-linked roles for IAM Identity Center Overview of managing access permissions to your IAM Identity Center resources Every AWS resource is owned by an AWS account, and permissions to create or access the resources are governed by permissions policies. To provide access, an account administrator can add permissions to IAM identities (that is, users, groups, and roles). Some services (such as AWS Lambda) also support adding permissions to resources. Note An account administrator (or administrator user) is a user with administrator privileges. For more information, see IAM best practices in the IAM User Guide. Topics • IAM Identity Center resources and operations • Understanding resource ownership • Managing access to resources • Specifying policy elements: actions, eﬀects, resources, and principals • Specifying conditions in a policy IAM Identity Center resources and operations In IAM Identity Center, the primary resources are application instances, proﬁles, and permission sets. Understanding resource ownership A resource owner is the AWS account that created a resource. That is, the resource owner is the AWS account of the principal entity (the account, a user, or an IAM role) that authenticates the request that creates the resource. The following examples illustrate how this works: Overview of managing access 374 AWS IAM Identity Center User Guide • If the AWS account root user creates an IAM Identity Center resource, such as an application instance or permission set, your AWS account is the owner of that resource. • If you create a user in your AWS account and grant that user permissions to create IAM Identity Center resources, the user can then create IAM Identity Center resources. However, your AWS account, to which the user belongs, owns the resources. • If you create an IAM role in your AWS account with permissions to create IAM Identity Center resources, anyone who can assume the role can create IAM Identity Center resources. Your AWS account, to which the role belongs, owns the IAM Identity Center resources. Managing access to resources A permissions policy describes who has access to what. The following
sso-ug-151	sso-ug.pdf	151	you create a user in your AWS account and grant that user permissions to create IAM Identity Center resources, the user can then create IAM Identity Center resources. However, your AWS account, to which the user belongs, owns the resources. • If you create an IAM role in your AWS account with permissions to create IAM Identity Center resources, anyone who can assume the role can create IAM Identity Center resources. Your AWS account, to which the role belongs, owns the IAM Identity Center resources. Managing access to resources A permissions policy describes who has access to what. The following section explains the available options for creating permissions policies. Note This section discusses using IAM in the context of IAM Identity Center. It doesn't provide detailed information about the IAM service. For complete IAM documentation, see What is IAM? in the IAM User Guide. For information about IAM policy syntax and descriptions, see AWS IAM policy reference in the IAM User Guide. Policies that are attached to an IAM identity are referred to as identity-based policies (IAM policies). Policies that are attached to a resource are referred to as resource-based policies. IAM Identity Center supports only identity-based policies (IAM policies). Topics • Identity-based policies (IAM policies) • Resource-based policies Identity-based policies (IAM policies) You can add permissions to IAM identities. For example, you can do the following: • Attach a permissions policy to a user or a group in your AWS account – An account administrator can use a permissions policy that is associated with a particular user to grant permissions for that user to add an IAM Identity Center resource, such as a new application. Overview of managing access 375 AWS IAM Identity Center User Guide • Attach a permissions policy to a role (grant cross-account permissions) – You can attach an identity-based permissions policy to an IAM role to grant cross-account permissions. For more information about using IAM to delegate permissions, see Access management in the IAM User Guide. The following permissions policy grants permissions to a user to run all of the actions that begin with List. These actions show information about an IAM Identity Center resource, such as an application instance or permissions set. Note that the wildcard character () in the Resource element indicates that the actions are allowed for all IAM Identity Center resources that are owned by the account. { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":"sso:List", "Resource":"*" } ] } For more information about using identity-based policies with IAM Identity Center, see Identity- based policy examples for IAM Identity Center. For more information about users, groups, roles, and permissions, see Identities (users, groups, and roles) in the IAM User Guide. Resource-based policies Other services, such as Amazon S3, also support resource-based permissions policies. For example, you can attach a policy to an S3 bucket to manage access permissions to that bucket. IAM Identity Center doesn't support resource-based policies. Specifying policy elements: actions, eﬀects, resources, and principals For each IAM Identity Center resource (see IAM Identity Center resources and operations), the service deﬁnes a set of API operations. To grant permissions for these API operations, IAM Identity Center deﬁnes a set of actions that you can specify in a policy. Note that performing an API operation can require permissions for more than one action. Overview of managing access 376 AWS IAM Identity Center User Guide The following are the basic policy elements: • Resource – In a policy, you use an Amazon Resource Name (ARN) to identify the resource to which the policy applies. • Action – You use action keywords to identify resource operations that you want to allow or deny. For example, the sso:DescribePermissionsPolicies permission allows the user permissions to perform the IAM Identity Center DescribePermissionsPolicies operation. • Eﬀect – You specify the eﬀect when the user requests the speciﬁc action—this can be either allow or deny. If you don't explicitly grant access to (allow) a resource, access is implicitly denied. You can also explicitly deny access to a resource, which you might do to make sure that a user cannot access it, even if a diﬀerent policy grants access. • Principal – In identity-based policies (IAM policies), the user that the policy is attached to is the implicit principal. For resource-based policies, you specify the user, account, service, or other entity that you want to receive permissions (applies to resource-based policies only). IAM Identity Center doesn't support resource-based policies. To learn more about IAM policy syntax and descriptions, see AWS IAM policy reference in the IAM User Guide. Specifying conditions in a policy When you grant permissions, you can use the access policy language to specify the conditions that are required for a policy to take eﬀect. For example, you might want a policy to be applied only after a speciﬁc date.
sso-ug-152	sso-ug.pdf	152	is attached to is the implicit principal. For resource-based policies, you specify the user, account, service, or other entity that you want to receive permissions (applies to resource-based policies only). IAM Identity Center doesn't support resource-based policies. To learn more about IAM policy syntax and descriptions, see AWS IAM policy reference in the IAM User Guide. Specifying conditions in a policy When you grant permissions, you can use the access policy language to specify the conditions that are required for a policy to take eﬀect. For example, you might want a policy to be applied only after a speciﬁc date. For more information about specifying conditions in a policy language, see Condition in the IAM User Guide. To express conditions, you use predeﬁned condition keys. There are no condition keys speciﬁc to IAM Identity Center. However, there are AWS condition keys that you can use as appropriate. For a complete list of AWS keys, see Available global condition keys in the IAM User Guide. Identity-based policy examples for IAM Identity Center This topic provides examples of IAM policies that you can create to grant users and roles permissions to administer IAM Identity Center. Identity-based policies (IAM policies) 377 AWS IAM Identity Center Important User Guide We recommend that you ﬁrst review the introductory topics that explain the basic concepts and options available for you to manage access to your IAM Identity Center resources. For more information, see Overview of managing access permissions to your IAM Identity Center resources. The sections in this topic cover the following: • Custom policy examples • Permissions required to use the IAM Identity Center console Custom policy examples This section provides examples of common use cases that require a custom IAM policy. These example policies are identity-based policies, which do not specify the Principal element. This is because with an identity-based policy, you don't specify the principal who gets the permission. Instead, you attach the policy to the principal. When you attach an identity-based permission policy to an IAM role, the principal identiﬁed in the role's trust policy gets the permissions. You can create identity-based policies in IAM and attach them to users, groups, and/or roles. You can also apply these policies to IAM Identity Center users when you create a permission set in IAM Identity Center. Note Use these examples when you create policies for your environment and make sure to test for both positive (“access granted”) and negative (“access denied”) test cases before you deploy these policies in your production environment. For more information about testing IAM policies, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. Topics • Example 1: Allow a user to view IAM Identity Center • Example 2: Allow a user to manage permissions to AWS accounts in IAM Identity Center • Example 3: Allow a user to manage applications in IAM Identity Center • Example 4: Allow a user to manage users and groups in your Identity Center directory Identity-based policies (IAM policies) 378 AWS IAM Identity Center User Guide Example 1: Allow a user to view IAM Identity Center The following permissions policy grants read-only permissions to a user so they can view all the settings and directory information conﬁgured in IAM Identity Center. Note This policy is provided for example purposes only. In a production environment, we recommend that you use the ViewOnlyAccess AWS managed policy for IAM Identity Center. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "ds:DescribeDirectories", "ds:DescribeTrusts", "iam:ListPolicies", "organizations:DescribeOrganization", "organizations:DescribeAccount", "organizations:ListParents", "organizations:ListChildren", "organizations:ListAccounts", "organizations:ListRoots", "organizations:ListAccountsForParent", "organizations:ListDelegatedAdministrators", "organizations:ListOrganizationalUnitsForParent", "sso:ListManagedPoliciesInPermissionSet", "sso:ListPermissionSetsProvisionedToAccount", "sso:ListAccountAssignments", "sso:ListAccountsForProvisionedPermissionSet", "sso:ListPermissionSets", "sso:DescribePermissionSet", "sso:GetInlinePolicyForPermissionSet", "sso-directory:DescribeDirectory", "sso-directory:SearchUsers", "sso-directory:SearchGroups" ], Identity-based policies (IAM policies) 379 AWS IAM Identity Center "Resource": "" } ] } User Guide Example 2: Allow a user to manage permissions to AWS accounts in IAM Identity Center The following permissions policy grants permissions to allow a user to create, manage, and deploy permission sets for your AWS accounts. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sso:AttachManagedPolicyToPermissionSet", "sso:CreateAccountAssignment", "sso:CreatePermissionSet", "sso:DeleteAccountAssignment", "sso:DeleteInlinePolicyFromPermissionSet", "sso:DeletePermissionSet", "sso:DetachManagedPolicyFromPermissionSet", "sso:ProvisionPermissionSet", "sso:PutInlinePolicyToPermissionSet", "sso:UpdatePermissionSet" ], "Resource": "" }, { "Sid": "IAMListPermissions", "Effect": "Allow", "Action": [ "iam:ListRoles", "iam:ListPolicies" ], "Resource": "" }, { "Sid": "AccessToSSOProvisionedRoles", "Effect": "Allow", "Action": [ "iam:AttachRolePolicy", Identity-based policies (IAM policies) 380 AWS IAM Identity Center User Guide "iam:CreateRole", "iam:DeleteRole", "iam:DeleteRolePolicy", "iam:DetachRolePolicy", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:ListRolePolicies", "iam:PutRolePolicy", "iam:UpdateRole", "iam:UpdateRoleDescription" ], "Resource": "arn:aws:iam:::role/aws-reserved/sso.amazonaws.com/" }, { "Effect": "Allow", "Action": [ "iam:GetSAMLProvider" ], "Resource": "arn:aws:iam:::saml-provider/AWSSSO_*_DO_NOT_DELETE" } ] } Note The additional permissions listed under the "Sid": "IAMListPermissions", and "Sid": "AccessToSSOProvisionedRoles" sections are required only to enable the user to create assignments in the AWS Organizations management account. In certain cases, you may also need to add iam:UpdateSAMLProvider to these sections. Example 3: Allow a user to manage applications in IAM Identity Center The following permissions policy grants permissions to allow
sso-ug-153	sso-ug.pdf	153	"iam:AttachRolePolicy", Identity-based policies (IAM policies) 380 AWS IAM Identity Center User Guide "iam:CreateRole", "iam:DeleteRole", "iam:DeleteRolePolicy", "iam:DetachRolePolicy", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:ListRolePolicies", "iam:PutRolePolicy", "iam:UpdateRole", "iam:UpdateRoleDescription" ], "Resource": "arn:aws:iam:::role/aws-reserved/sso.amazonaws.com/" }, { "Effect": "Allow", "Action": [ "iam:GetSAMLProvider" ], "Resource": "arn:aws:iam:::saml-provider/AWSSSO__DO_NOT_DELETE" } ] } Note The additional permissions listed under the "Sid": "IAMListPermissions", and "Sid": "AccessToSSOProvisionedRoles" sections are required only to enable the user to create assignments in the AWS Organizations management account. In certain cases, you may also need to add iam:UpdateSAMLProvider to these sections. Example 3: Allow a user to manage applications in IAM Identity Center The following permissions policy grants permissions to allow a user to view and conﬁgure applications in IAM Identity Center, including pre-integrated SaaS applications from within the IAM Identity Center catalog. Note The sso:AssociateProfile operation used in the following policy example is required for management of user and group assignments to applications. It also allows a user to Identity-based policies (IAM policies) 381 AWS IAM Identity Center User Guide assign users and groups to AWS accounts by using existing permission sets. If a user must manage AWS account access within IAM Identity Center, and requires permissions necessary to manage permission sets, see Example 2: Allow a user to manage permissions to AWS accounts in IAM Identity Center. As of October 2020, many of these operations are available only through the AWS console. This example policy includes “read” actions such as list, get, and search, which are relevant to the error- free operation of the console for this case. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sso:AssociateProfile", "sso:CreateApplicationInstance", "sso:ImportApplicationInstanceServiceProviderMetadata", "sso:DeleteApplicationInstance", "sso:DeleteProfile", "sso:DisassociateProfile", "sso:GetApplicationTemplate", "sso:UpdateApplicationInstanceServiceProviderConfiguration", "sso:UpdateApplicationInstanceDisplayData", "sso:DeleteManagedApplicationInstance", "sso:UpdateApplicationInstanceStatus", "sso:GetManagedApplicationInstance", "sso:UpdateManagedApplicationInstanceStatus", "sso:CreateManagedApplicationInstance", "sso:UpdateApplicationInstanceSecurityConfiguration", "sso:UpdateApplicationInstanceResponseConfiguration", "sso:GetApplicationInstance", "sso:CreateApplicationInstanceCertificate", "sso:UpdateApplicationInstanceResponseSchemaConfiguration", "sso:UpdateApplicationInstanceActiveCertificate", "sso:DeleteApplicationInstanceCertificate", "sso:ListApplicationInstanceCertificates", "sso:ListApplicationTemplates", "sso:ListApplications", "sso:ListApplicationInstances", "sso:ListDirectoryAssociations", Identity-based policies (IAM policies) 382 AWS IAM Identity Center User Guide "sso:ListProfiles", "sso:ListProfileAssociations", "sso:ListInstances", "sso:GetProfile", "sso:GetSSOStatus", "sso:GetSsoConfiguration", "sso-directory:DescribeDirectory", "sso-directory:DescribeUsers", "sso-directory:ListMembersInGroup", "sso-directory:SearchGroups", "sso-directory:SearchUsers" ], "Resource": "" } ] } Example 4: Allow a user to manage users and groups in your Identity Center directory The following permissions policy grants permissions to allow a user to create, view, modify, and delete users and groups in IAM Identity Center. In some cases, direct modiﬁcations to users and groups in IAM Identity Center are restricted. For example, when Active Directory, or an external identity provider with Automatic Provisioning enabled, is selected as the identity source. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sso-directory:ListGroupsForUser", "sso-directory:DisableUser", "sso-directory:EnableUser", "sso-directory:SearchGroups", "sso-directory:DeleteGroup", "sso-directory:AddMemberToGroup", "sso-directory:DescribeDirectory", "sso-directory:UpdateUser", "sso-directory:ListMembersInGroup", "sso-directory:CreateUser", "sso-directory:DescribeGroups", Identity-based policies (IAM policies) 383 AWS IAM Identity Center User Guide "sso-directory:SearchUsers", "sso:ListDirectoryAssociations", "sso-directory:RemoveMemberFromGroup", "sso-directory:DeleteUser", "sso-directory:DescribeUsers", "sso-directory:UpdateGroup", "sso-directory:CreateGroup" ], "Resource": "" } ] } Permissions required to use the IAM Identity Center console For a user to work with the IAM Identity Center console without errors, additional permissions are required. If an IAM policy has been created that is more restrictive than the minimum required permissions, the console won't function as intended for users with that policy. The following example lists the set of permissions that might be needed to ensure error-free operation within the IAM Identity Center console. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sso:DescribeAccountAssignmentCreationStatus", "sso:DescribeAccountAssignmentDeletionStatus", "sso:DescribePermissionSet", "sso:DescribePermissionSetProvisioningStatus", "sso:DescribePermissionsPolicies", "sso:DescribeRegisteredRegions", "sso:GetApplicationInstance", "sso:GetApplicationTemplate", "sso:GetInlinePolicyForPermissionSet", "sso:GetManagedApplicationInstance", "sso:GetMfaDeviceManagementForDirectory", "sso:GetPermissionSet", "sso:GetPermissionsPolicy", "sso:GetProfile", "sso:GetSharedSsoConfiguration", "sso:GetSsoConfiguration", Identity-based policies (IAM policies) 384 AWS IAM Identity Center User Guide "sso:GetSSOStatus", "sso:GetTrust", "sso:ListAccountAssignmentCreationStatus", "sso:ListAccountAssignmentDeletionStatus", "sso:ListAccountAssignments", "sso:ListAccountsForProvisionedPermissionSet", "sso:ListApplicationInstanceCertificates", "sso:ListApplicationInstances", "sso:ListApplications", "sso:ListApplicationTemplates", "sso:ListDirectoryAssociations", "sso:ListInstances", "sso:ListManagedPoliciesInPermissionSet", "sso:ListPermissionSetProvisioningStatus", "sso:ListPermissionSets", "sso:ListPermissionSetsProvisionedToAccount", "sso:ListProfileAssociations", "sso:ListProfiles", "sso:ListTagsForResource", "sso-directory:DescribeDirectory", "sso-directory:DescribeGroups", "sso-directory:DescribeUsers", "sso-directory:ListGroupsForUser", "sso-directory:ListMembersInGroup", "sso-directory:SearchGroups", "sso-directory:SearchUsers" ], "Resource": "*" } ] } AWS managed policies for IAM Identity Center To create IAM customer managed policies that provide your team with only the permissions they need takes time and expertise. To get started quickly, you can use AWS managed policies. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) AWS managed policies 385 AWS IAM Identity Center User Guide where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the
sso-ug-154	sso-ug.pdf	154	most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide. New actions that allow you to list and delete user sessions are available under the new namespace identitystore-auth. Any additional permissions for actions in this namespace will be updated on this page. When creating your custom IAM policies, avoid using * after identitystore-auth because this applies to all actions that exist in the namespace today or in the future. AWS managed policy: AWSSSOMasterAccountAdministrator The AWSSSOMasterAccountAdministrator policy provides required administrative actions to principals. The policy is intended for principals who perform the job role of an AWS IAM Identity Center administrator. Over time the list of actions provided will be updated to match the existing functionality of IAM Identity Center and the actions that are required as an administrator. You can attach the AWSSSOMasterAccountAdministrator policy to your IAM identities. When you attach the AWSSSOMasterAccountAdministrator policy to an identity, you grant administrative AWS IAM Identity Center permissions. Principals with this policy can access IAM Identity Center within the AWS Organizations management account and all member accounts. This principal can fully manage all IAM Identity Center operations, including the ability to create an IAM Identity Center instance, users, permission sets, and assignments. The principal can also instantiate those assignments throughout the AWS organization member accounts and establish connections between AWS Directory Service managed directories and IAM Identity Center. As new administrative features are released, the account administrator will be granted these permissions automatically. Permissions groupings This policy is grouped into statements based on the set of permissions provided. • AWSSSOMasterAccountAdministrator – Allows IAM Identity Center to pass the service role named AWSServiceRoleforSSO to IAM Identity Center so that it can later assume the role and AWS managed policies 386 AWS IAM Identity Center User Guide perform actions on their behalf. This is necessary when the person or application attempts to enable IAM Identity Center. For more information, see AWS account access. • AWSSSOMemberAccountAdministrator – Allows IAM Identity Center to perform account administrator actions in a multi-account AWS environment. For more information, see AWS managed policy: AWSSSOMemberAccountAdministrator. • AWSSSOManageDelegatedAdministrator – Allows IAM Identity Center to register and deregister a delegated administrator for your organization. To view the permissions for this policy, see AWSSSOMasterAccountAdministrator in AWS Managed Policy Reference. Additional information about this policy When IAM Identity Center is enabled for the ﬁrst time, the IAM Identity Center service creates a service linked role in the AWS Organizations management account (formerly master account) so that IAM Identity Center can manage the resources in your account. The actions required are iam:CreateServiceLinkedRole and iam:PassRole, which are shown in the following snippets. { "Version" : "2012-10-17", "Statement" : [ { "Sid" : "AWSSSOCreateSLR", "Effect" : "Allow", "Action" : "iam:CreateServiceLinkedRole", "Resource" : "arn:aws:iam:::role/aws-service-role/sso.amazonaws.com/ AWSServiceRoleForSSO", "Condition" : { "StringLike" : { "iam:AWSServiceName" : "sso.amazonaws.com" } } }, { "Sid" : "AWSSSOMasterAccountAdministrator", "Effect" : "Allow", "Action" : "iam:PassRole", "Resource" : "arn:aws:iam:::role/aws-service-role/sso.amazonaws.com/ AWSServiceRoleForSSO", AWS managed policies 387 AWS IAM Identity Center "Condition" : { "StringLike" : { "iam:PassedToService" : "sso.amazonaws.com" User Guide } } }, { "Sid" : "AWSSSOMemberAccountAdministrator", "Effect" : "Allow", "Action" : [ "ds:DescribeTrusts", "ds:UnauthorizeApplication", "ds:DescribeDirectories", "ds:AuthorizeApplication", "iam:ListPolicies", "organizations:EnableAWSServiceAccess", "organizations:ListRoots", "organizations:ListAccounts", "organizations:ListOrganizationalUnitsForParent", "organizations:ListAccountsForParent", "organizations:DescribeOrganization", "organizations:ListChildren", "organizations:DescribeAccount", "organizations:ListParents", "organizations:ListDelegatedAdministrators", "sso:", "sso-directory:", "identitystore:", "identitystore-auth:", "ds:CreateAlias", "access-analyzer:ValidatePolicy", "signin:CreateTrustedIdentityPropagationApplicationForConsole", "signin:ListTrustedIdentityPropagationApplicationsForConsole" ], "Resource" : "" }, { "Sid" : "AWSSSOManageDelegatedAdministrator", "Effect" : "Allow", "Action" : [ "organizations:RegisterDelegatedAdministrator", "organizations:DeregisterDelegatedAdministrator" ], "Resource" : "", AWS managed policies 388 AWS IAM Identity Center "Condition" : { "StringEquals" : { "organizations:ServicePrincipal" : "sso.amazonaws.com" User Guide } } }, { "Sid": "AllowDeleteSyncProfile", "Effect": "Allow", "Action": [ "identity-sync:DeleteSyncProfile" ], "Resource": [ "arn:aws:identity-sync:::profile/*" ] } ] } AWS managed policy: AWSSSOMemberAccountAdministrator The AWSSSOMemberAccountAdministrator policy provides required administrative actions to principals. The policy is intended for principals who perform the job role of an IAM Identity Center administrator. Over time the list of actions provided will be updated to match the existing functionality of IAM Identity Center and the actions that are required as an administrator. You can attach the AWSSSOMemberAccountAdministrator policy to your IAM identities. When you attach the AWSSSOMemberAccountAdministrator policy to an identity, you grant administrative AWS IAM Identity Center permissions. Principals with this policy can access IAM Identity Center within the AWS Organizations management account and all member accounts. This principal can fully manage all IAM Identity
sso-ug-155	sso-ug.pdf	155	principals. The policy is intended for principals who perform the job role of an IAM Identity Center administrator. Over time the list of actions provided will be updated to match the existing functionality of IAM Identity Center and the actions that are required as an administrator. You can attach the AWSSSOMemberAccountAdministrator policy to your IAM identities. When you attach the AWSSSOMemberAccountAdministrator policy to an identity, you grant administrative AWS IAM Identity Center permissions. Principals with this policy can access IAM Identity Center within the AWS Organizations management account and all member accounts. This principal can fully manage all IAM Identity Center operations, including the ability to create users, permission sets, and assignments. The principal can also instantiate those assignments throughout the AWS organization member accounts and establish connections between AWS Directory Service managed directories and IAM Identity Center. As new administrative features are released, the account administrator is granted these permissions automatically. To view the permissions for this policy, see AWSSSOMemberAccountAdministrator in AWS Managed Policy Reference. AWS managed policies 389 AWS IAM Identity Center User Guide Additional information about this policy IAM Identity Center administrators manage users, groups, and passwords in their Identity Center directory store (sso-directory). The account admin role includes permissions for the following actions: • "sso:" • "sso-directory:" IAM Identity Center administrators need limited permissions to the following AWS Directory Service actions to perform daily tasks. • "ds:DescribeTrusts" • "ds:UnauthorizeApplication" • "ds:DescribeDirectories" • "ds:AuthorizeApplication" • “ds:CreateAlias” These permissions allow IAM Identity Center administrators to identify existing directories and manage applications so that they can be conﬁgured for use with IAM Identity Center. For more information about each of these actions, see AWS Directory Service API permissions: Actions, resources, and conditions reference. IAM Identity Center uses IAM policies to grant permissions to IAM Identity Center users. IAM Identity Center administrators create permission sets and attach polices to them. The IAM Identity Center administrator must have the permissions to list the existing policies so that they can choose which polices to use with the permission set they are creating or updating. To set secure and functional permissions, the IAM Identity Center administrator must have permissions to run the IAM Access Analyzer policy validation. • "iam:ListPolicies" • "access-analyzer:ValidatePolicy" IAM Identity Center administrators need limited access to the following AWS Organizations actions to perform daily tasks: AWS managed policies 390 AWS IAM Identity Center User Guide • "organizations:EnableAWSServiceAccess" • "organizations:ListRoots" • "organizations:ListAccounts" • "organizations:ListOrganizationalUnitsForParent" • "organizations:ListAccountsForParent" • "organizations:DescribeOrganization" • "organizations:ListChildren" • "organizations:DescribeAccount" • "organizations:ListParents" • "organizations:ListDelegatedAdministrators" • "organizations:RegisterDelegatedAdministrator" • "organizations:DeregisterDelegatedAdministrator" These permissions allow IAM Identity Center administrators the ability to work with organization resources (accounts) for basic IAM Identity Center administrative tasks such as the following: • Identifying the management account that belongs to the organization • Identifying the member accounts that belong to the organization • Enabling AWS service access for accounts • Setting up and managing a delegated administrator For more information about using a delegated administrator with IAM Identity Center, see Delegated administration. For more information about how these permissions are used with AWS Organizations, see Using AWS Organizations with other AWS services. AWS managed policy: AWSSSODirectoryAdministrator You can attach the AWSSSODirectoryAdministrator policy to your IAM identities. This policy grants administrative permissions over IAM Identity Center users and groups. Principals with this policy attached can make any updates to IAM Identity Center users and groups. To view the permissions for this policy, see AWSSSODirectoryAdministrator in AWS Managed Policy Reference. AWS managed policies 391 AWS IAM Identity Center User Guide AWS managed policy: AWSSSOReadOnly You can attach the AWSSSOReadOnly policy to your IAM identities. This policy grants read-only permissions that allow users to view information in IAM Identity Center. Principals with this policy attached cannot view the IAM Identity Center users or groups directly. Principals with this policy attached cannot make any updates in IAM Identity Center. For example, principals with these permissions can view IAM Identity Center settings, but cannot change any of the setting values. To view the permissions for this policy, see AWSSSOReadOnly in AWS Managed Policy Reference. AWS managed policy: AWSSSODirectoryReadOnly You can attach the AWSSSODirectoryReadOnly policy to your IAM identities. This policy grants read-only permissions that allow users to view users and groups in IAM Identity Center. Principals with this policy attached cannot view IAM Identity Center assignments, permission sets, applications, or settings. Principals with this policy attached can't make any updates in IAM Identity Center. For example, principals with these permissions can view IAM Identity Center users, but they can't change any user attributes or assign MFA devices. To view the permissions for this policy, see AWSSSODirectoryReadOnly in AWS Managed Policy Reference. AWS managed policy: AWSIdentitySyncFullAccess You can attach the AWSIdentitySyncFullAccess policy to your IAM identities. Principals with this policy attached have full access permissions to create and delete sync proﬁles, associate or
sso-ug-156	sso-ug.pdf	156	IAM Identity Center. Principals with this policy attached cannot view IAM Identity Center assignments, permission sets, applications, or settings. Principals with this policy attached can't make any updates in IAM Identity Center. For example, principals with these permissions can view IAM Identity Center users, but they can't change any user attributes or assign MFA devices. To view the permissions for this policy, see AWSSSODirectoryReadOnly in AWS Managed Policy Reference. AWS managed policy: AWSIdentitySyncFullAccess You can attach the AWSIdentitySyncFullAccess policy to your IAM identities. Principals with this policy attached have full access permissions to create and delete sync proﬁles, associate or update a sync proﬁle with a sync target, create, list and delete sync ﬁlters, and start or stop synchronization. Permission details To view the permissions for this policy, see AWSIdentitySyncFullAccess in AWS Managed Policy Reference. AWS managed policy: AWSIdentitySyncReadOnlyAccess You can attach the AWSIdentitySyncReadOnlyAccess policy to your IAM identities. AWS managed policies 392 AWS IAM Identity Center User Guide This policy grants read-only permissions that allow users to view information about the identity synchronization proﬁle, ﬁlters, and target settings. Principals with this policy attached can't make any updates to synchronization settings. For example, principals with these permissions can view identity synchronization settings, but can't change any of the proﬁle or ﬁlter values. To view the permissions for this policy, see AWSIdentitySyncReadOnlyAccess in AWS Managed Policy Reference. AWS managed policy: AWSSSOServiceRolePolicy You can't attach the AWSSSOServiceRolePolicy policy to your IAM identities. This policy is attached to a service-linked role that allows IAM Identity Center to delegate and enforce which users have single sign-on access to speciﬁc AWS accounts in AWS Organizations. When you enable IAM, a service-linked role is created in all of the AWS accounts within your organization. IAM Identity Center also creates the same service-linked role in every account that is subsequently added to your organization. This role allows IAM Identity Center to access each account's resources on your behalf. Service-linked roles that are created in each AWS account are named AWSServiceRoleForSSO. For more information, see Using service-linked roles for IAM Identity Center. AWS managed policy: AWSIAMIdentityCenterAllowListForIdentityContext When assuming a role with the IAM Identity Center identity context, AWS Security Token Service (AWS STS) automatically attaches the AWSIAMIdentityCenterAllowListForIdentityContext policy to the role. This policy provides the list of actions that are allowed when you use trusted identity propagation with roles that are assumed with the IAM Identity Center identity context. All other actions that are called with this context are blocked. The identity context is passed as ProvidedContext. To view the permissions for this policy, see AWSIAMIdentityCenterAllowListForIdentityContext in AWS Managed Policy Reference. IAM Identity Center updates to AWS managed policies The following table describes the updates to AWS managed policies for IAM Identity Center since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the IAM Identity Center Document history page. AWS managed policies 393 AWS IAM Identity Center User Guide Change Description Date AWSSSOServiceRolePolicy AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes permissions to call identity-sync:Dele teSyncProfile . February 11, 2025 This policy now includes the October 2, 2024 qapps:ListQAppSess ionData and qapps:Exp ortQAppSessionData actions to support identity- enhanced console sessions for AWS managed applications that support these sessions. AWSSSOMasterAccoun tAdministrator IAM Identity Center added a new action to grant September 26, 2024 AWSIAMIdentityCent erAllowListForIdentityContext DeleteSyncProﬁle permissions to allow you to use this policy to delete sync proﬁles. This is action is associated with DeleteInstance API. This policy now includes the September 4, 2024 s3:ListCallerAcces sGrants action to support identity-enhanced console sessions for AWS managed applications that support these sessions. AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the July 12, 2024 aoss:APIAccessAll , es:ESHttpHead , es:ESHttpPost , es:ESHttpGet , AWS managed policies 394 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext es:ESHttpPatch , es:ESHttpDelete , and es:ESHttpPut actions to support identity-enhanced console sessions for AWS managed applications that support these sessions. This policy now includes the June 27, 2024 qapps:PredictQApp , qapps:ImportDocument , qapps:AssociateLib raryItemReview , qapps:Disassociate LibraryItemReview qapps:GetQAppSession , , qapps:UpdateQAppSe ssion , qapps:Get QAppSessionMetadat a , qapps:UpdateQAppSe ssionMetadata , and qapps:TagResource actions to support identity- enhanced console sessions for AWS managed applications that support these sessions. AWS managed policies 395 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the May 17, 2024 elasticmapreduce:A ddJobFlowSteps , elasticmapreduce:D escribeCluster , elasticmapreduce:C ancelSteps , elasticma preduce:DescribeSt ep , and elasticma preduce:ListSteps actions to support trusted identity propagation in Amazon EMR. AWS managed policies 396 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes April 30, 2024 the qapps:CreateQApp , qapps:PredictProbl emStatementFromCon versation , qapps:Pre dictQAppFromProble , qapps:Cop mStatement yQApp , qapps:Get QApp , qapps:Lis tQApps , qapps:Upd ateQApp , qapps:Del eteQApp , qapps:Ass ociateQAppWithUser ,
sso-ug-157	sso-ug.pdf	157	sessions. AWS managed policies 395 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the May 17, 2024 elasticmapreduce:A ddJobFlowSteps , elasticmapreduce:D escribeCluster , elasticmapreduce:C ancelSteps , elasticma preduce:DescribeSt ep , and elasticma preduce:ListSteps actions to support trusted identity propagation in Amazon EMR. AWS managed policies 396 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes April 30, 2024 the qapps:CreateQApp , qapps:PredictProbl emStatementFromCon versation , qapps:Pre dictQAppFromProble , qapps:Cop mStatement yQApp , qapps:Get QApp , qapps:Lis tQApps , qapps:Upd ateQApp , qapps:Del eteQApp , qapps:Ass ociateQAppWithUser , qapps:Disassociate QAppFromUser , qapps:ImportDocume ntToQApp , qapps:Imp ortDocumentToQAppS ession , qapps:Cre ateLibraryItem , qapps:GetLibraryItem , qapps:UpdateLibrar yItem , qapps:Cre ateLibraryItemRevi ew , qapps:Lis tLibraryItems , qapps:CreateSubscr iptionToken , qapps:StartQAppSes sion , and qapps:Sto actions to pQAppSession support identity-enhanced console sessions for AWS AWS managed policies 397 AWS IAM Identity Center User Guide Change Description Date AWSSSOMasterAccoun tAdministrator AWSSSOMemberAccoun tAdministrator managed applications that support these sessions. This policy now includes the April 26, 2024 signin:CreateTrust edIdentityPropagat ionApplicationForC onsole and signin:Li stTrustedIdentityP ropagationApplicat ionsForConsole actions to support identity-enhanced console sessions for AWS managed applications that support these sessions. This policy now includes the April 26, 2024 signin:CreateTrust edIdentityPropagat ionApplicationForC onsole and signin:Li stTrustedIdentityP ropagationApplicat ionsForConsole actions to support identity-enhanced console sessions for AWS managed applications that support these sessions. AWS managed policies 398 AWS IAM Identity Center User Guide Change Description Date AWSSSOReadOnly This policy now includes the April 26, 2024 signin:ListTrusted IdentityPropagatio nApplicationsForCo nsole action to support identity-enhanced console sessions for AWS managed applications that support these sessions. AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the April 26, 2024 qbusiness:PutFeedb ack action to support identity-enhanced console sessions for AWS managed applications that support these sessions. AWS managed policies 399 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the April 24, 2024 q:StartConversatio n , q:SendMessage , q:ListConversation s , q:GetConversation , q:StartTroubleshoo tingAnalysis , q:GetTroubleshooti ngResults , q:StartTr oubleshootingResol utionExplanation , and q:UpdateTroublesho otingCommandResult actions to support identity- enhanced console sessions for AWS managed applications that support these sessions. AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the April 19, 2024 sts:SetContext action to support identity-enhanced console sessions for AWS managed applications that support these sessions. AWS managed policies 400 AWS IAM Identity Center User Guide Change Description Date AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes April 11, 2024 the qbusiness:Chat , qbusiness:ChatSync , qbusiness:ListConv ersations , qbusiness :ListMessages , and qbusiness:DeleteCo nversation support identity-enhanced actions to console sessions for AWS managed applications that support these sessions. AWSIAMIdentityCent erAllowListForIdentityContext This policy now includes the November 26, 2023 s3:GetAccessGrants InstanceForPrefix and s3:GetDataAccess actions. AWSIAMIdentityCent erAllowListForIdentityContext This policy provides the list of actions that are allowed November 15, 2023 when you use trusted identity propagation with roles that are assumed with the IAM Identity Center identity context. AWSSSODirectoryReadOnly This policy now includes the February 21, 2023 new namespace identitys tore-auth with new permissions to allow users to list and get sessions. AWS managed policies 401 AWS IAM Identity Center User Guide Change Description Date AWSSSOServiceRolePolicy This policy now allows October 20, 2022 AWSSSOMasterAccoun tAdministrator AWSSSOMemberAccoun tAdministrator AWSSSODirectoryAdm inistrator theUpdateSAMLProvider action to be taken on the management account. This policy now includes the October 20, 2022 new namespace identitys tore-auth with new permissions to allow the admin to list and delete sessions for a user. This policy now includes the October 20, 2022 new namespace identitys tore-auth with new permissions to allow the admin to list and delete sessions for a user. This policy now includes the October 20, 2022 new namespace identitys tore-auth with new permissions to allow the admin to list and delete sessions for a user. AWS managed policies 402 AWS IAM Identity Center User Guide Change Description Date AWSSSOMasterAccoun tAdministrator AWSSSOMemberAccoun tAdministrator August 16, 2022 August 16, 2022 This policy now includes new permissions to call ListDelegatedAdmin istrators in AWS Organizations. This policy also now includes a subset of permissions AWSSSOManageDelega tedAdministrator includes permissions to call that RegisterDelegatedA dministrator and DeregisterDelegate dAdministrator . This policy now includes new permissions to call ListDelegatedAdmin istrators in AWS Organizations. This policy also now includes a subset of permissions AWSSSOManageDelega tedAdministrator includes permissions to call that RegisterDelegatedA dministrator and DeregisterDelegate dAdministrator . AWS managed policies 403 AWS IAM Identity Center User Guide Change Description Date AWSSSOReadOnly AWSSSOServiceRolePolicy AWSSSOServiceRolePolicy AWSSSOMasterAccoun tAdministrator AWSSSOMemberAccoun tAdministrator AWSSSOReadOnly This policy now includes new permissions to call ListDelegatedAdmin istrators in AWS Organizations. This policy now includes new permissions to call DeleteRolePermissi onsBoundary and PutRolePermisionsB oundary . This policy now includes new permissions that allow calls to ListAWSServiceAcce ssForOrganization and ListDeleg atedAdministrators AWS Organizations. in Add IAM Access Analyzer permissions that allow a principal to use the policy checks for validation. August 11, 2022 July 14, 2022 May
sso-ug-158	sso-ug.pdf	158	includes permissions to call that RegisterDelegatedA dministrator and DeregisterDelegate dAdministrator . AWS managed policies 403 AWS IAM Identity Center User Guide Change Description Date AWSSSOReadOnly AWSSSOServiceRolePolicy AWSSSOServiceRolePolicy AWSSSOMasterAccoun tAdministrator AWSSSOMemberAccoun tAdministrator AWSSSOReadOnly This policy now includes new permissions to call ListDelegatedAdmin istrators in AWS Organizations. This policy now includes new permissions to call DeleteRolePermissi onsBoundary and PutRolePermisionsB oundary . This policy now includes new permissions that allow calls to ListAWSServiceAcce ssForOrganization and ListDeleg atedAdministrators AWS Organizations. in Add IAM Access Analyzer permissions that allow a principal to use the policy checks for validation. August 11, 2022 July 14, 2022 May 11, 2022 April 28, 2022 AWS managed policies 404 AWS IAM Identity Center User Guide Change Description Date AWSSSOMasterAccoun tAdministrator This policy now allows all IAM Identity Center Identity Store March 29, 2022 service actions. For information about the actions available in the IAM Identity Center Identity Store service, see the IAM Identity Center Identity Store API Reference. AWSSSOMemberAccoun tAdministrator This policy now allows all IAM Identity Center Identity Store March 29, 2022 service actions. AWSSSODirectoryAdm inistrator This policy now allows all IAM Identity Center Identity Store March 29, 2022 AWSSSODirectoryReadOnly March 29, 2022 service actions. This policy now grants access to the IAM Identity Center Identity Store service read actions. This access is required to retrieve user and group information from the IAM Identity Center Identity Store service. AWSIdentitySyncFullAccess This policy allows full access to identity-sync permissions. March 3, 2022 AWSIdentitySyncRea dOnlyAccess This policy grants read-only permissions that allow a principal to view identity-sync settings. March 3, 2022 AWS managed policies 405 AWS IAM Identity Center User Guide Change Description Date AWSSSOReadOnly This policy grants read-only permissions that allow a principal to view IAM Identity Center conﬁguration settings. August 4, 2021 IAM Identity Center started tracking changes IAM Identity Center started tracking changes for AWS August 4, 2021 managed policies. Using service-linked roles for IAM Identity Center AWS IAM Identity Center uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to IAM Identity Center. It is predeﬁned by IAM Identity Center and includes all the permissions that the service requires to call other AWS services on your behalf. For more information, see Understanding service-linked roles in IAM Identity Center. A service-linked role makes setting up IAM Identity Center easier because you don’t have to manually add the necessary permissions. IAM Identity Center deﬁnes the permissions of its service- linked role, and unless deﬁned otherwise, only IAM Identity Center can assume its role. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. For information about other services that support service-linked roles, see AWS Services That Work with IAM and look for the services that have Yes in the Service-Linked Role column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for IAM Identity Center IAM Identity Center uses the service-linked role named AWSServiceRoleForSSO to grant IAM Identity Center permissions to manage AWS resources, including IAM roles, policies, and SAML IdP on your behalf. The AWSServiceRoleForSSO service-linked role trusts the following services to assume the role: • IAM Identity Center (service preﬁx: sso) Using service-linked roles 406 AWS IAM Identity Center User Guide The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on roles on the path “/aws-reserved/sso.amazonaws.com/” and with the name preﬁx “AWSReservedSSO_”: • iam:AttachRolePolicy • iam:CreateRole • iam:DeleteRole • iam:DeleteRolePermissionsBoundary • iam:DeleteRolePolicy • iam:DetachRolePolicy • iam:GetRole • iam:ListRolePolicies • iam:PutRolePolicy • iam:PutRolePermissionsBoundary • iam:ListAttachedRolePolicies The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on SAML providers with name preﬁx as “AWSSSO_”: • iam:CreateSAMLProvider • iam:GetSAMLProvider • iam:UpdateSAMLProvider • iam:DeleteSAMLProvider The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on all organizations: • organizations:DescribeAccount • organizations:DescribeOrganization • organizations:ListAccounts • organizations:ListAWSServiceAccessForOrganization • organizations:ListDelegatedAdministrators Using service-linked roles 407 AWS IAM Identity Center User Guide The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on all IAM roles (): • iam:listRoles The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on “arn:aws:iam:::role/aws-service-role/sso.amazonaws.com/ AWSServiceRoleForSSO”: • iam:GetServiceLinkedRoleDeletionStatus • iam:DeleteServiceLinkedRole The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on “arn:aws:identity-sync:::proﬁle/”: • identity-sync:DeleteSyncProfile For more information on updates to the AWSSSOServiceRolePolicy service-linked role permissions policy, see IAM Identity Center updates to AWS managed policies. { "Version":"2012-10-17", "Statement":[ { "Sid":"IAMRoleProvisioningActions", "Effect":"Allow", "Action":[ "iam:AttachRolePolicy", "iam:CreateRole", "iam:DeleteRolePermissionsBoundary", "iam:PutRolePermissionsBoundary", "iam:PutRolePolicy", "iam:UpdateRole", "iam:UpdateRoleDescription", "iam:UpdateAssumeRolePolicy" ], "Resource":[ "arn:aws:iam:::role/aws-reserved/sso.amazonaws.com/" ], "Condition":{ Using service-linked roles 408 AWS IAM Identity Center User Guide "StringNotEquals":{ "aws:PrincipalOrgMasterAccountId":"${aws:PrincipalAccount}" } } }, { "Sid":"IAMRoleReadActions", "Effect":"Allow", "Action":[ "iam:GetRole", "iam:ListRoles" ], "Resource":[ "" ]
sso-ug-159	sso-ug.pdf	159	policy allows IAM Identity Center to complete the following on “arn:aws:iam:::role/aws-service-role/sso.amazonaws.com/ AWSServiceRoleForSSO”: • iam:GetServiceLinkedRoleDeletionStatus • iam:DeleteServiceLinkedRole The AWSSSOServiceRolePolicy service-linked role permissions policy allows IAM Identity Center to complete the following on “arn:aws:identity-sync:::proﬁle/”: • identity-sync:DeleteSyncProfile For more information on updates to the AWSSSOServiceRolePolicy service-linked role permissions policy, see IAM Identity Center updates to AWS managed policies. { "Version":"2012-10-17", "Statement":[ { "Sid":"IAMRoleProvisioningActions", "Effect":"Allow", "Action":[ "iam:AttachRolePolicy", "iam:CreateRole", "iam:DeleteRolePermissionsBoundary", "iam:PutRolePermissionsBoundary", "iam:PutRolePolicy", "iam:UpdateRole", "iam:UpdateRoleDescription", "iam:UpdateAssumeRolePolicy" ], "Resource":[ "arn:aws:iam:::role/aws-reserved/sso.amazonaws.com/" ], "Condition":{ Using service-linked roles 408 AWS IAM Identity Center User Guide "StringNotEquals":{ "aws:PrincipalOrgMasterAccountId":"${aws:PrincipalAccount}" } } }, { "Sid":"IAMRoleReadActions", "Effect":"Allow", "Action":[ "iam:GetRole", "iam:ListRoles" ], "Resource":[ "" ] }, { "Sid":"IAMRoleCleanupActions", "Effect":"Allow", "Action":[ "iam:DeleteRole", "iam:DeleteRolePolicy", "iam:DetachRolePolicy", "iam:ListRolePolicies", "iam:ListAttachedRolePolicies" ], "Resource":[ "arn:aws:iam:::role/aws-reserved/sso.amazonaws.com/" ] }, { "Sid":"IAMSLRCleanupActions", "Effect":"Allow", "Action":[ "iam:DeleteServiceLinkedRole", "iam:GetServiceLinkedRoleDeletionStatus", "iam:DeleteRole", "iam:GetRole" ], "Resource":[ "arn:aws:iam:::role/aws-service-role/sso.amazonaws.com/ AWSServiceRoleForSSO" ] }, Using service-linked roles 409 User Guide AWS IAM Identity Center { "Sid": "IAMSAMLProviderCreationAction", "Effect": "Allow", "Action": [ "iam:CreateSAMLProvider" ], "Resource": [ "arn:aws:iam:::saml-provider/AWSSSO_" ], "Condition": { "StringNotEquals": { "aws:PrincipalOrgMasterAccountId": "${aws:PrincipalAccount}" } } }, { "Sid": "IAMSAMLProviderUpdateAction", "Effect": "Allow", "Action": [ "iam:UpdateSAMLProvider" ], "Resource": [ "arn:aws:iam:::saml-provider/AWSSSO_" ] }, { "Sid":"IAMSAMLProviderCleanupActions", "Effect":"Allow", "Action":[ "iam:DeleteSAMLProvider", "iam:GetSAMLProvider" ], "Resource":[ "arn:aws:iam:::saml-provider/AWSSSO_" ] }, { "Effect":"Allow", "Action":[ "organizations:DescribeAccount", "organizations:DescribeOrganization", "organizations:ListAccounts", "organizations:ListAWSServiceAccessForOrganization", "organizations:ListDelegatedAdministrators" Using service-linked roles 410 User Guide AWS IAM Identity Center ], "Resource":[ "" ] }, { "Sid":"AllowUnauthAppForDirectory", "Effect":"Allow", "Action":[ "ds:UnauthorizeApplication" ], "Resource":[ "" ] }, { "Sid":"AllowDescribeForDirectory", "Effect":"Allow", "Action":[ "ds:DescribeDirectories", "ds:DescribeTrusts" ], "Resource":[ "" ] }, { "Sid":"AllowDescribeAndListOperationsOnIdentitySource", "Effect":"Allow", "Action":[ "identitystore:DescribeUser", "identitystore:DescribeGroup", "identitystore:ListGroups", "identitystore:ListUsers" ], "Resource":[ "" ] }, { "Sid":"AllowDeleteSyncProfile", "Effect":"Allow", "Action":[ "identity-sync:DeleteSyncProfile" Using service-linked roles 411 AWS IAM Identity Center ], "Resource":[ "arn:aws:identity-sync::profile/*" User Guide ] } ] } You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. Creating a service-linked role for IAM Identity Center You don't need to manually create a service-linked role. Once enabled, IAM Identity Center creates a service-linked role in all accounts within the organization in AWS Organizations. IAM Identity Center also creates the same service-linked role in every account that is subsequently added to your organization. This role allows IAM Identity Center to access each account's resources on your behalf. Notes • If you're signed in to the AWS Organizations management account, it uses your currently signed-in role and not the service-linked role. This prevents the escalation of privileges. • When IAM Identity Center performs any IAM operations in the AWS Organizations management account, all operations happen using the credentials of the IAM principal. This enables the logs in CloudTrail to provide visibility of who made all privilege changes in the management account. Important If you were using the IAM Identity Center service before December 7, 2017, when it began supporting service-linked roles, then IAM Identity Center created the AWSServiceRoleForSSO role in your account. To learn more, see A New Role Appeared in My IAM Account. Using service-linked roles 412 AWS IAM Identity Center User Guide If you delete this service-link role and then need to create it again, you can use the same process to recreate the role in your account. Editing a service-linked role for IAM Identity Center IAM Identity Center does not allow you to edit the AWSServiceRoleForSSO service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide. Deleting a service-linked role for IAM Identity Center You don't need to manually delete the AWSServiceRoleForSSO role. When an AWS account is removed from an AWS organization, IAM Identity Center automatically cleans up the resources and deletes the service-linked role from that AWS account. You can also use the IAM console, the IAM CLI, or the IAM API to manually delete the service-linked role. To do this, you must ﬁrst manually clean up the resources for your service-linked role and then you can manually delete it. Note If the IAM Identity Center service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again. To delete IAM Identity Center resources used by the AWSServiceRoleForSSO 1. Remove user and group access to an AWS account for all users and groups that have access to the AWS account. 2. Remove permission sets in IAM Identity Center that you have associated with the AWS account. To manually delete the service-linked role using IAM Use the IAM console, the IAM CLI, or the IAM API to delete the AWSServiceRoleForSSO service- linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Using service-linked roles 413
sso-ug-160	sso-ug.pdf	160	for a few minutes and try the operation again. To delete IAM Identity Center resources used by the AWSServiceRoleForSSO 1. Remove user and group access to an AWS account for all users and groups that have access to the AWS account. 2. Remove permission sets in IAM Identity Center that you have associated with the AWS account. To manually delete the service-linked role using IAM Use the IAM console, the IAM CLI, or the IAM API to delete the AWSServiceRoleForSSO service- linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Using service-linked roles 413 AWS IAM Identity Center User Guide IAM Identity Center console and API authorization Existing IAM Identity Center console APIs support dual authorization, which allows you to maintain use of existing API operations when newer APIs are available. If you have existing instances of IAM Identity Center that were created prior to November 15, 2023 and October 15th, 2020, you can use the following tables to determine which API operations now map to newer API operations that were released after those dates. Topics • API actions after November 2023 • API actions after October 2020 API actions after November 2023 Instances of IAM Identity Center that were created before November 15, 2023 honor both old and new API actions as long as there is no explicit deny on any of the actions. Instances created after November 15, 2023 use newer API actions for authorization in the IAM Identity Center console. Console operation name used before November 15, 2023 API action used after November 15, 2023 AssociateProﬁle CreateApplicationAssignment CreateManagedApplicationInstance \| CreateApplicationInstance CreateApplication CreateManagedApplicationInstance PutApplicationAuthenticationMethod DeleteApplicationInstance \| DeleteMan agedApplicationInstance DeleteApplication DeleteSSO DeleteInstance DisassociateProﬁle DeleteApplicationAssignment GetApplicationTemplate DescribeApplicationProvider GetManagedApplicationInstance DescribeApplication IAM Identity Center console and API authorization 414 AWS IAM Identity Center User Guide Console operation name used before November 15, 2023 API action used after November 15, 2023 GetSharedSsoConﬁguration DescribeInstance ListApplicationInstances ListApplications ListApplicationTemplates ListApplicationProviders ListDirectoryAssociations DescribeInstance ListProﬁleAssociations ListApplicationAssignments UpdateApplicationInstanceDisplayData \| UpdateApplicationInstanceStatus \| UpdateManagedApplicationInstanceStatus UpdateApplication API actions after October 2020 Instances of IAM Identity Center that were created before October 15, 2020 honor both old and new API actions as long as there is no explicit deny on any of the actions. Instances created after October 15, 2020 use newer API actions for authorization in the IAM Identity Center console. Operation name API actions used before October 15, 2020 API actions used after October 15, 2020 AssociateProﬁle AssociateProﬁle CreateAccountAssignment AttachManagedPolicy PutPermissionsPolicy AttachManagedPolic yToPermissionSet CreatePermissionSet CreatePermissionSet CreatePermissionSet DeleteApplicationInstanceFo rAWsAccount DeleteApplicationInstance \| DeleteTrust DeleteAccountAssignment DeleteApplicationProﬁleFor AwsAccount DeleteProﬁle DeleteAccountAssignment API actions after October 2020 415 AWS IAM Identity Center Operation name API actions used before October 15, 2020 API actions used after October 15, 2020 User Guide DeletePermissionsPolicy DeletePermissionsPolicy DeleteInlinePolicyFromPermi ssionSet DeletePermissionSet DeletePermissionSet DeletePermissionSet DescribePermissionsPolicies DescribePermissionsPolicies DetachManagedPolicy DeletePermissionsPolicy ListManagedPoliciesInPermis sionSet DetachManagedPolic yFromPermissionSet DisassociateProﬁle DisassociateProﬁle DeleteAccountAssignment GetApplicationInstanceForAW SAccount GetApplicationInstance ListAccountAssignments GetAWSAccountProﬁleStatus GetProﬁle ListPermissionSetsProvision edToAccount GetPermissionSet GetPermissionSet DescribePermissionSet GetPermissionsPolicy GetPermissionsPolicy GetInlinePolicyForPermissio nSet ListAccountsWithProvisioned PermissionSet ListApplicationInstances \| GetApplicationInstance ListAccountsForProvisionedP ermissionSet ListAWSAccountProfiles ListProﬁles \| GetProﬁle ListPermissionSetsProvision edToAccount ListPermissionSets ListPermissionSets ListPermissionSets ListProﬁleAssociations ListProﬁleAssociations ListAccountAssignments ProvisionApplicationInstanc eForAWSAccount GetApplicationInstance \| CreateApplicationInstance CreateAccountAssignment API actions after October 2020 416 AWS IAM Identity Center Operation name API actions used before October 15, 2020 API actions used after October 15, 2020 User Guide ProvisionApplicationProﬁle ForAWSAccountInstance GetProﬁle \| CreateProﬁle \| UpdateProﬁle CreateAccountAssignment ProvisionSAMLProvider GetTrust \| CreateTrust \| UpdateTrust CreateAccountAssignment PutPermissionsPolicy PutPermissionsPolicy PutInlinePolicyToPermission Set UpdatePermissionSet UpdatePermissionSet UpdatePermissionSet AWS STS condition context keys for IAM Identity Center When a principal makes a request to AWS, AWS gathers the request information into a request context, which is used to evaluate and authorize the request. You can use the Condition element of a JSON policy to compare keys in the request context with key values that you specify in your policy. Request information is provided by diﬀerent sources, including the principal making the request, the resource, the request it is made against, and the metadata about the request itself. Service-speciﬁc condition keys are deﬁned for use with an individual AWS service. IAM Identity Center includes an AWS STS context provider that enables AWS managed applications and third-party applications to add values for condition keys that are deﬁned by IAM Identity Center. These keys are included in IAM roles. The key values are set when an application passes a token to AWS STS. The application obtains the token that it passes to AWS STS in either of the following ways: • During authentication with IAM Identity Center. • After token exchange with a trusted token issuer for trusted identity propagation. In this case, the application obtains a token from a trusted token issuer and exchanges that token for a token from IAM Identity Center. These keys are typically used by applications that integrate with trusted identity propagation. In some cases, when key values are present, you can use these keys in IAM policies that
sso-ug-161	sso-ug.pdf	161	when an application passes a token to AWS STS. The application obtains the token that it passes to AWS STS in either of the following ways: • During authentication with IAM Identity Center. • After token exchange with a trusted token issuer for trusted identity propagation. In this case, the application obtains a token from a trusted token issuer and exchanges that token for a token from IAM Identity Center. These keys are typically used by applications that integrate with trusted identity propagation. In some cases, when key values are present, you can use these keys in IAM policies that you create to allow or deny permissions. AWS STS condition keys for IAM Identity Center 417 AWS IAM Identity Center User Guide For example, you might want to provide conditional access to a resource based on the value of the UserId. This value indicates which IAM Identity Center user is using the role. The example is similar to using SourceId. Unlike SourceId, however, the value for UserId represents a speciﬁc, veriﬁed user from the identity store. This value is present in the token that the application obtains and then passes to AWS STS. It is not a general purpose string that can contain arbitrary values. Topics • identitystore:UserId • identitystore:IdentityStoreArn • identitycenter:ApplicationArn • identitycenter:CredentialId • identitycenter:InstanceArn identitystore:UserId This context key is the UserId of the IAM Identity Center user who is the subject of the context assertion issued by IAM Identity Center. The context assertion is passed to AWS STS. You can use this key to compare the UserId of the IAM Identity Center user on behalf of whom the request is made with the identiﬁer for the user that you specify in the policy. • Availability – This key is included in the request context after a context assertion issued by IAM Identity Center is set, when a role is assumed using any AWS STS assume-role command in the AWS CLI or AWS STS AssumeRole API operation. • Data type – String • Value type – Single-valued identitystore:IdentityStoreArn This context key is the ARN of the identity store that is attached to the instance of IAM Identity Center that issued the context assertion. It is also the identity store in which you can look up attributes for identitystore:UserID. You can use this key in policies to determine whether the identitystore:UserID comes from an expected identity store ARN. • Availability – This key is included in the request context after a context assertion issued by IAM Identity Center is set, when a role is assumed using any AWS STS assume-role command in the AWS CLI or AWS STS AssumeRole API operation. UserId 418 AWS IAM Identity Center • Data type – Arn, String • Value type – Single-valued identitycenter:ApplicationArn User Guide This context key is the ARN of the application to which IAM Identity Center issued a context assertion. You can use this key in policies to determine whether identitycenter:ApplicationArn comes from an expected application. Using this key can help prevent an IAM role from being accessed by an unexpected application. • Availability – This key is included in the request context of an AWS STS AssumeRole API operation. The request context includes a context assertion issued by IAM Identity Center. • Data type – Arn, String • Value type – Single-valued identitycenter:CredentialId This context key is a random ID for the identity-enhanced role credential and is used for logging only. Because this key value is unpredictable, we recommend that you do not use it for context assertions in policies. • Availability – This key is included in the request context of an AWS STS AssumeRole API operation. The request context includes a context assertion issued by IAM Identity Center. • Data type – String • Value type – Single-valued identitycenter:InstanceArn This context key is the ARN of the instance of IAM Identity Center that issued the context assertion for the identitystore:UserID. You can use this key to determine whether the identitystore:UserID and context assertion came from an expected IAM Identity Center instance ARN. • Availability – This key is included in the request context of an AWS STS AssumeRole API operation. The request context includes a context assertion issued by IAM Identity Center. ApplicationArn 419 AWS IAM Identity Center • Data type – Arn, String • Value type – Single-valued User Guide Logging and monitoring in IAM Identity Center As a best practice, you should monitor your organization to ensure that changes are logged. This helps you to ensure that any unexpected change can be investigated and unwanted changes can be rolled back. AWS IAM Identity Center currently supports two AWS services that help you monitor your organization and the activity that happens within it. Topics • Logging IAM Identity Center API calls with AWS CloudTrail • Logging IAM
sso-ug-162	sso-ug.pdf	162	by IAM Identity Center. ApplicationArn 419 AWS IAM Identity Center • Data type – Arn, String • Value type – Single-valued User Guide Logging and monitoring in IAM Identity Center As a best practice, you should monitor your organization to ensure that changes are logged. This helps you to ensure that any unexpected change can be investigated and unwanted changes can be rolled back. AWS IAM Identity Center currently supports two AWS services that help you monitor your organization and the activity that happens within it. Topics • Logging IAM Identity Center API calls with AWS CloudTrail • Logging IAM Identity Center SCIM API calls with AWS CloudTrail • Connect application components with Amazon EventBridge • Logging conﬁgurable AD sync errors Logging IAM Identity Center API calls with AWS CloudTrail AWS IAM Identity Center is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in IAM Identity Center. CloudTrail captures API calls for IAM Identity Center as events. The calls captured include calls from the IAM Identity Center console and code calls to the IAM Identity Center API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for IAM Identity Center. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to IAM Identity Center, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. The following table summarizes the CloudTrail events of IAM Identity Center, their CloudTrail event sources, and matching APIs. Refer to the IAM Identity Center API references to learn more about the APIs. Logging and monitoring 420 AWS IAM Identity Center Note User Guide There's an additional group of CloudTrail events, referred to as Sign-in, which AWS emits for signing in to AWS as an IAM Identity Center user. These events have no matching public APIs, and therefore aren't listed in the API references. CloudTrail event sources sso.amazo naws.com CloudTrail events Public APIs Description IAM Identity Center IAM Identity Center The IAM Identity Center APIs enable the managemen t of permission sets, applications, trusted token issuers, account and applicati on assignments, IAM Identity Center instances, and tags. Identity Store Identity Store OIDC OIDC The Identity Store APIs enable the sso-direc tory.amaz management of the onaws.com life cycle of your , identitys workforce's users and tore.amaz groups, and the users' group memberships. Also, they support the management of users' MFA devices. The OIDC APIs support trusted identity propagati on, and sign-in to AWS CLI and IDE onaws.com sso.amazo naws.com , sso- oauth.amazonaw s.com Logging IAM Identity Center API calls with AWS CloudTrail 421 AWS IAM Identity Center User Guide CloudTrail events Public APIs Description CloudTrail event sources toolkits as an already authenticated IAM Identity Center user. AWS access portal AWS access portal The AWS access portal APIs support sso.amazo naws.com Identity Store SCIM AWS Sign-In No public API the operations of the AWS access portal and users getting account credentials through the AWS CLI. The SCIM APIs support the provisioning of users, groups, and group membershi ps through the SCIM protocol. See Logging IAM Identity Center SCIM API calls with AWS CloudTrail for more information. AWS emits Sign-in CloudTrail events for user authentication and federation ﬂows into IAM Identity Center. identitystore- scim.amazonaw s.com signin.am azon.com Topics • CloudTrail use cases for IAM Identity Center • IAM Identity Center information in CloudTrail Logging IAM Identity Center API calls with AWS CloudTrail 422 AWS IAM Identity Center User Guide CloudTrail use cases for IAM Identity Center The CloudTrail events that IAM Identity Center emits can be valuable for a variety of use cases. Organizations can use these event logs to monitor and audit the user access and activity within their AWS environment. This can help compliance use cases, as the logs capture details on who is accessing what resources and when. You can also use the CloudTrail data for incident investigations, allowing teams to analyze user actions and track suspicious behavior. Additionally, the event history can support troubleshooting eﬀorts, providing visibility into changes made to user permissions and conﬁgurations over time. The following sections describe the foundational use cases that inform your workﬂows such as audit, incident investigation, and troubleshooting. Identifying the user and session in IAM Identity Center user-initiated CloudTrail events IAM Identity Center emits two CloudTrail ﬁelds that enable you to identify the IAM Identity Center user behind the CloudTrail events, such as signing into IAM Identity Center or AWS CLI, and using the AWS access portal,
sso-ug-163	sso-ug.pdf	163	incident investigations, allowing teams to analyze user actions and track suspicious behavior. Additionally, the event history can support troubleshooting eﬀorts, providing visibility into changes made to user permissions and conﬁgurations over time. The following sections describe the foundational use cases that inform your workﬂows such as audit, incident investigation, and troubleshooting. Identifying the user and session in IAM Identity Center user-initiated CloudTrail events IAM Identity Center emits two CloudTrail ﬁelds that enable you to identify the IAM Identity Center user behind the CloudTrail events, such as signing into IAM Identity Center or AWS CLI, and using the AWS access portal, including managing MFA devices: • userId – The unique and immutable user identiﬁer from the Identity Store of an IAM Identity Center instance. • identityStoreArn – The Amazon Resource Name (ARN) of the Identity Store that contains the user. The userID and identityStoreArn ﬁelds display in the onBehalfOf element nested inside the userIdentity element as shown in the following example. This example shows these two ﬁelds on an event where the userIdentity type is "IdentityCenterUser". You can also include these ﬁelds on events for authenticated IAM Identity Center users where the userIdentity type is "Unknown". Your workﬂows should accept both type values. "userIdentity":{ "type":"IdentityCenterUser", "accountId":"111122223333", "onBehalfOf": { "userId": "544894e8-80c1-707f-60e3-3ba6510dfac1", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "90e292de-5eb8-446e-9602-90f7c45044f7" Logging IAM Identity Center API calls with AWS CloudTrail 423 AWS IAM Identity Center } Note User Guide We recommend you use userId and identityStoreArn for identifying the user behind IAM Identity Center CloudTrail events. Avoid using the ﬁelds userName or principalId under the userIdentity element when tracking the actions of an IAM Identity Center user who is signing in and using the AWS access portal. If your workﬂows, such as audit or incident response, depend on having access to the username, you have two options: • Retrieve the username from the IAM Identity Center directory as explained in Username in sign-in CloudTrail events. • Get the UserName that IAM Identity Center emits under the additionalEventData element in Sign-in. This option doesn't require access to the IAM Identity Center directory. For more information, see Username in sign-in CloudTrail events. To retrieve the details of a user, including the username ﬁeld, you query the Identity Store with user ID and Identity Store ID as parameters. You can perform this action through the DescribeUser API request or through the CLI. The following is an example CLI command. You can omit the region parameter if your IAM Identity Center instance is in the CLI default Region. aws identitystore describe-user \ --identity-store-id d-1234567890 \ --user-id 544894e8-80c1-707f-60e3-3ba6510dfac1 \ --region your-region-id To determine the Identity Store ID value for the CLI command in the previous example, you can extract the Identity Store ID from the identityStoreArn value. In the example ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890, the Identity Store ID is d-1234567890. Alternatively, you can locate the Identity Store ID by navigating to Identity Store tab in the Settings section of the IAM Identity Center console. If you're automating the lookup of users in the IAM Identity Center directory, we recommend that you estimate the frequency of user lookups, and consider the IAM Identity Center throttle limit on the Identity Store API. Caching retrieved user attributes can help you stay within the throttle limit. Logging IAM Identity Center API calls with AWS CloudTrail 424 AWS IAM Identity Center User Guide The credentialId value is set to the ID of the IAM Identity Center user’s session used to request the action. You can use this value to identify CloudTrail events initiated within the same authenticated IAM Identity Center user session except for sign-in events. Note The AuthWorkflowID ﬁeld emitted in sign-in events enables tracking all CloudTrail events associated with a sign-in sequence before the commencement of an IAM Identity Center user session. Correlating users between IAM Identity Center and external directories IAM Identity Center provides two user attributes that you can use to correlate a user in its directory to the same user in an external directory (for example, Microsoft Active Directory and Okta Universal Directory). • externalId – The external identiﬁer of an IAM Identity Center user. We recommend you map this identiﬁer to an immutable user identiﬁer in the external directory. Note that IAM Identity Center doesn't emit this value in CloudTrail. • username – A customer-provided value that users usually sign in with. The value can change (for example, with a SCIM update). Note that when the identity source is AWS Directory Service, the username that IAM Identity Center emits in CloudTrail matches the username that you enter to authenticate. The username doesn't need to be an exact match to the username in the IAM Identity Center directory. If you have access to the CloudTrail events but not the IAM Identity Center directory, you can use the username emitted under the additionalEventData
sso-ug-164	sso-ug.pdf	164	IAM Identity Center doesn't emit this value in CloudTrail. • username – A customer-provided value that users usually sign in with. The value can change (for example, with a SCIM update). Note that when the identity source is AWS Directory Service, the username that IAM Identity Center emits in CloudTrail matches the username that you enter to authenticate. The username doesn't need to be an exact match to the username in the IAM Identity Center directory. If you have access to the CloudTrail events but not the IAM Identity Center directory, you can use the username emitted under the additionalEventData element at sign-in. For more details about username in additionalEventData, refer to Username in sign-in CloudTrail events. The mapping of these two user attributes to corresponding user attributes in an external directory is deﬁned in IAM Identity Center when the identity source is the AWS Directory Service. For infomration, see Attribute mappings between IAM Identity Center and External Identity Providers directory. External IdPs that provision users with SCIM have their own mapping. Even if you use the IAM Identity Center directory as the identity source, you can use the externalId attribute to cross-reference security principals to your external directory. Logging IAM Identity Center API calls with AWS CloudTrail 425 AWS IAM Identity Center User Guide The following section explains how you can look up an IAM Identity Center user given the user’s username and externalId. Viewing an IAM Identity Center user by username and externalId You can retrieve user attributes from the IAM Identity Center directory for a known username by ﬁrst requesting a corresponding userId using the GetUserId API request, then issue a DescribeUser API request, as shown in the previous example. The following example demonstrates how you can retrieve a userId from the Identity Store for a speciﬁc username. You can omit the region parameter if your IAM Identity Center instance is in the default Region with the CLI. aws identitystore get-user-id \ --identity-store d-9876543210 \ --alternate-identifier '{ "UniqueAttribute": { "AttributePath": "username", "AttributeValue": "[email protected]" } }' \ --region your-region-id Similarly, you can use the same mechanism when you know the externalId. Update the attribute path in the previous example with the externalId value, and the attribute value with the speciﬁc externalId for which you're searching. Viewing a user’s Secure Identiﬁer (SID) in Microsoft Active Directory (AD) and externalId In certain cases, IAM Identity Center emits a user’s SID in the principalId ﬁeld of CloudTrail events, such as those that the AWS access portal and OIDC APIs emit. These cases are being phased out. We recommend your workﬂows use the AD attribute objectguid when you need a unique user identiﬁer from AD. You can ﬁnd this value in the externalId attribute in the IAM Identity Center directory. However, if your workﬂows require the use of SID, retrieve the value from AD as it’s not available through IAM Identity Center APIs. Correlating users between IAM Identity Center and external directories discusses how you can use the externalId and username ﬁelds to correlate an IAM Identity Center user to a matching user in an external directory. By default, IAM Identity Center maps externalId to the objectguid attribute in AD, and this mapping is ﬁxed. IAM Identity Center allows administrators the ﬂexibility to map username diﬀerently than its default mapping to userprincipalname in AD. Logging IAM Identity Center API calls with AWS CloudTrail 426 AWS IAM Identity Center User Guide You can view these mappings in the IAM Identity Center console. Navigate to the Identity Source tab of Settings, and choose Manage sync in the Actions menu. In the Manage Sync section, choose the View attribute mappings button. While you can use any unique AD user identiﬁer available in IAM Identity Center to look up a user in AD, we recommend using the objectguid in your queries because it's an immutable identiﬁer. The following example shows how to query Microsoft AD with Powershell to retrieve a user using the user’s objectguid value of 16809ecc-7225-4c20-ad98-30094aefdbca. A successful response to this query includes the user’s SID. Install-WindowsFeature -Name RSAT-AD-PowerShell Get-ADUser ` -Filter {objectGUID -eq [GUID]::Parse("16809ecc-7225-4c20-ad98-30094aefdbca")} ` -Properties * IAM Identity Center information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in IAM Identity Center, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail event history. Note For more information about how user identiﬁcation and tracking of user actions in CloudTrail events is evolving, refer to Important changes to CloudTrail events for IAM Identity Center in the AWS Security Blog. For an ongoing record of events in your AWS account, including events for IAM Identity Center, create a
sso-ug-165	sso-ug.pdf	165	the account. When activity occurs in IAM Identity Center, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail event history. Note For more information about how user identiﬁcation and tracking of user actions in CloudTrail events is evolving, refer to Important changes to CloudTrail events for IAM Identity Center in the AWS Security Blog. For an ongoing record of events in your AWS account, including events for IAM Identity Center, create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following topics in the AWS CloudTrail User Guide: • Overview for creating a trail Logging IAM Identity Center API calls with AWS CloudTrail 427 AWS IAM Identity Center User Guide • CloudTrail supported services and integrations • Conﬁguring Amazon SNS notiﬁcations for CloudTrail • Receiving CloudTrail log ﬁles from multiple Regions and Receiving CloudTrail log ﬁles from multiple accounts When CloudTrail logging is enabled in your AWS account, API calls made to IAM Identity Center actions are tracked in log ﬁles. IAM Identity Center records are written together with other AWS service records in a log ﬁle. CloudTrail determines when to create and write to a new ﬁle based on a time period and ﬁle size. CloudTrail events for supported IAM Identity Center APIs The following sections provide information about the CloudTrail events associated with the following APIs that IAM Identity Center supports: • IAM Identity Center API • Identity Store API • OIDC API • AWS access portal API CloudTrail events of IAM Identity Center API operations The following list contains the CloudTrail events that the public IAM Identity Center operations emit with the sso.amazonaws.com event source. For more information about the public IAM Identity Center API operations, see the IAM Identity Center API Reference. You might ﬁnd additional events in CloudTrail for IAM Identity Center console API operations that the console relies on. For more information about these console APIs, see the Service Authorization Reference. • AttachCustomerManagedPolicyReferenceToPermissionSet • • AttachManagedPolicyToPermissionSet CreateAccountAssignment • CreateApplication Logging IAM Identity Center API calls with AWS CloudTrail 428 AWS IAM Identity Center User Guide CreateApplicationAssignment CreateInstance • • • CreateInstanceAccessControlAttributeConﬁguration • CreatePermissionSet • CreateTrustedTokenIssuer • DeleteAccountAssignment • DeleteApplication • DeleteApplicationAccessScope • DeleteApplicationAssignment • DeleteApplicationAuthenticationMethod • • • • • • • • DeleteApplicationGrant DeleteInlinePolicyFromPermissionSet DeleteInstance DeleteInstanceAccessControlAttributeConﬁguration DeletePermissionsBoundaryFromPermissionSet DeletePermissionSet DeleteTrustedTokenIssuer Logging IAM Identity Center API calls with AWS CloudTrail 429 AWS IAM Identity Center User Guide DescribeAccountAssignmentCreationStatus s DescribeAccountAssignmentDeletionStatus DescribeApplication DescribeApplicationAssignment DescribeApplicationProvider DescribeInstance DescribeInstanceAccessControlAttributeConﬁguration DescribePermissionSet DescribePermissionSetProvisioningStatus DescribeTrustedTokenIssuer DetachCustomerManagedPolicyReferenceFromPermissionSet DetachManagedPolicyFromPermissionSet GetApplicationAccessScope GetApplicationAssignmentConﬁguration GetApplicationAuthenticationMethod • • • • • • • • • • • • • • • Logging IAM Identity Center API calls with AWS CloudTrail 430 AWS IAM Identity Center GetApplicationGrant User Guide GetInlinePolicyForPermissionSet GetPermissionsBoundaryForPermissionSet ListAccountAssignmentCreationStatus ListAccountAssignmentDeletionStatus ListAccountAssignments ListAccountAssignmentsForPrincipal ListAccountsForProvisionedPermissionSet ListApplicationAccessScopes ListApplicationAssignments ListApplicationAssignmentsForPrincipal ListApplicationAuthenticationMethods ListApplicationGrants ListApplicationProviders ListApplications • • • • • • • • • • • • • • • ListCustomerManagedPolicyReferencesInPermissionSet Logging IAM Identity Center API calls with AWS CloudTrail 431 AWS IAM Identity Center User Guide • • • • • • • • • • • • • • • ListInstances ListManagedPoliciesInPermissionSet ListPermissionSetProvisioningStatus ListPermissionSets ListPermissionSetsProvisionedToAccount ListTagsForResource ListTrustedTokenIssuers ProvisionPermissionSet PutApplicationAccessScope PutApplicationAssignmentConﬁguration PutApplicationAuthenticationMethod PutApplicationGrant PutInlinePolicyToPermissionSet PutPermissionsBoundaryToPermissionSet TagResource Logging IAM Identity Center API calls with AWS CloudTrail 432 AWS IAM Identity Center User Guide • • • • • • UntagResource UpdateApplication UpdateInstance UpdateInstanceAccessControlAttributeConﬁguration UpdatePermissionSet UpdateTrustedTokenIssuer CloudTrail events of Identity Store API operations The following list contains the CloudTrail events that the public Identity Store operations emit with the identitystore.amazonaws.com event source. For more information about the public Identity Store API operations, see the Identity Store API Reference. You might see additional events in CloudTrail for the Identity Store console API operations with the sso-directory.amazonaws.com event source. These APIs support the console and AWS access portal. If you need to detect the occurrence of a particular operation, such as adding member to a group, we recommend you consider both public and console API operations. For more information about these console APIs, see the Service Authorization Reference. • CreateGroup • CreateGroupMembership • CreateUser • DeleteGroup • DeleteGroupMembership • DeleteUser • DescribeGroup • DescribeGroupMembership • DescribeUser • GetGroupId Logging IAM Identity Center API calls with AWS CloudTrail 433 User Guide AWS IAM Identity Center • GetGroupMembershipId • GetUserId • IsMemberInGroups • ListGroupMemberships • ListGroupMembershipsForMember
sso-ug-166	sso-ug.pdf	166	with the sso-directory.amazonaws.com event source. These APIs support the console and AWS access portal. If you need to detect the occurrence of a particular operation, such as adding member to a group, we recommend you consider both public and console API operations. For more information about these console APIs, see the Service Authorization Reference. • CreateGroup • CreateGroupMembership • CreateUser • DeleteGroup • DeleteGroupMembership • DeleteUser • DescribeGroup • DescribeGroupMembership • DescribeUser • GetGroupId Logging IAM Identity Center API calls with AWS CloudTrail 433 User Guide AWS IAM Identity Center • GetGroupMembershipId • GetUserId • IsMemberInGroups • ListGroupMemberships • ListGroupMembershipsForMember • ListGroups • ListUsers • UpdateGroup • UpdateUser CloudTrail events of OIDC API operations The following list contains the CloudTrail events that the public OIDC operations emit. For more information about the public OIDC API operations, see the OIDC API Reference. • CreateToken (event source sso.amazonaws.com) • CreateTokenWithIAM (event source sso-oauth.amazonaws.com) CloudTrail events of AWS access portal API operations The following list contains the CloudTrail events that the AWS access portal API operations emit with the sso.amazonaws.com event source. The API operations noted as being unavailable in the public API support the operations of the AWS access portal. Using the AWS CLI can lead to the emission of CloudTrail events of both the public AWS access portal API operations and those that are unavailable in the public API. For more information about public AWS access portal API operations, see the AWS access portal API Reference. • Authenticate (Not available in the public API. Provides login to the AWS access portal.) • Federate (Not available in the public API. Provides federation into applications.) • ListAccountRoles • ListAccounts • ListApplications (Not available in the public API. Provides users’ assigned resources for display in the AWS access portal.) • ListProﬁlesForApplication (Not available in the public API. Provides application metadata for display in the AWS access portal.) Logging IAM Identity Center API calls with AWS CloudTrail 434 AWS IAM Identity Center • GetRoleCredentials • Logout User Guide Identity information in IAM Identity Center CloudTrail events Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root user or AWS Identity and Access Management (IAM) user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. • Whether the request was made by an IAM Identity Center user. If so, the userId and identityStoreArn ﬁelds are available in the CloudTrail events to identify the IAM Identity Center user who initiated the request. For more information, see Identifying the user and session in IAM Identity Center user-initiated CloudTrail events . For more information, see the CloudTrail userIdentity element. Note Currently, IAM Identity Center doesn't emit CloudTrail events for the following actions: • User sign-in to AWS managed web applications (for example, Amazon SageMaker AI Studio) with the OIDC API. These web applications are a subset of the broader set of the section called “AWS managed applications”, which also include non-web applications such as Amazon Athena SQL and Amazon S3 Access Grants. • Retrieval of user and group attributes by AWS managed applications with the Identity Store API. Understanding CloudTrail events for IAM Identity Center A trail is a conﬁguration that enables delivery of events to an Amazon S3 bucket that you specify. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail events aren't an Logging IAM Identity Center API calls with AWS CloudTrail 435 AWS IAM Identity Center User Guide ordered stack trace of the public API calls, so they don't appear in any speciﬁc order. Learn about the contents of a CloudTrail record in the CloudTrail User Guide. The following example shows a CloudTrail log entry for an administrator ([email protected]) that took place in the IAM Identity Center console: { "Records":[ { "eventVersion":"1.05", "userIdentity":{ "type":"IAMUser", "principalId":"AIDAJAIENLMexample", "arn":"arn:aws:iam::08966example:user/samadams", "accountId":"111122223333", "accessKeyId":"AKIAIIJM2K4example", "userName":"samadams" }, "eventTime":"2017-11-29T22:39:43Z", "eventSource":"sso.amazonaws.com", "eventName":"DescribePermissionsPolicies", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36", "requestParameters":{ "permissionSetId":"ps-79a0dde74b95ed05" }, "responseElements":null, "requestID":"319ac6a1-d556-11e7-a34f-69a333106015", "eventID":"a93a952b-13dd-4ae5-a156-d3ad6220b071", "readOnly":true, "resources":[ ], "eventType":"AwsApiCall", "recipientAccountId":"111122223333" } ] } The following example shows a CloudTrail log entry for an end-user ([email protected]) action that took place in the AWS access portal: Logging IAM Identity Center API calls with AWS CloudTrail 436 User Guide AWS IAM Identity Center { "Records":[ { "eventVersion":"1.05", "userIdentity":{ "type":"Unknown", "principalId":"example.com// S-1-5-21-1122334455-3652759393-4233131409-1126", "accountId":"111122223333", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84775435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "cdee2490-82ed-43b3-96ee-b75fbf0b97a5" }, "eventTime":"2017-11-29T18:48:28Z", "eventSource":"sso.amazonaws.com", "eventName":"ListApplications", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36", "requestParameters":null, "responseElements":null, "requestID":"de6c0435-ce4b-49c7-9bcc-bc5ed631ce04", "eventID":"e6e1f3df-9528-4c6d-a877-6b2b895d1f91", "eventType":"AwsApiCall", "recipientAccountId":"111122223333" } ] } The following
sso-ug-167	sso-ug.pdf	167	}, "responseElements":null, "requestID":"319ac6a1-d556-11e7-a34f-69a333106015", "eventID":"a93a952b-13dd-4ae5-a156-d3ad6220b071", "readOnly":true, "resources":[ ], "eventType":"AwsApiCall", "recipientAccountId":"111122223333" } ] } The following example shows a CloudTrail log entry for an end-user ([email protected]) action that took place in the AWS access portal: Logging IAM Identity Center API calls with AWS CloudTrail 436 User Guide AWS IAM Identity Center { "Records":[ { "eventVersion":"1.05", "userIdentity":{ "type":"Unknown", "principalId":"example.com// S-1-5-21-1122334455-3652759393-4233131409-1126", "accountId":"111122223333", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84775435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "cdee2490-82ed-43b3-96ee-b75fbf0b97a5" }, "eventTime":"2017-11-29T18:48:28Z", "eventSource":"sso.amazonaws.com", "eventName":"ListApplications", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36", "requestParameters":null, "responseElements":null, "requestID":"de6c0435-ce4b-49c7-9bcc-bc5ed631ce04", "eventID":"e6e1f3df-9528-4c6d-a877-6b2b895d1f91", "eventType":"AwsApiCall", "recipientAccountId":"111122223333" } ] } The following example shows a CloudTrail log entry for an end-user ([email protected]) action that took place in IAM Identity Center OIDC: { "eventVersion": "1.05", "userIdentity": { "type": "Unknown", "principalId": "example.com//S-1-5-21-1122334455-3652759393-4233131409-1126", "accountId": "111122223333", Logging IAM Identity Center API calls with AWS CloudTrail 437 AWS IAM Identity Center User Guide "userName": "[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84775435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "cdee2490-82ed-43b3-96ee-b75fbf0b97a5" }, "eventTime": "2020-06-16T01:31:15Z", "eventSource": "sso.amazonaws.com", "eventName": "CreateToken", "awsRegion": "us-east-1", "sourceIPAddress": "203.0.113.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36", "requestParameters": { "clientId": "clientid1234example", "clientSecret": "HIDDEN_DUE_TO_SECURITY_REASONS", "grantType": "urn:ietf:params:oauth:grant-type:device_code", "deviceCode": "devicecode1234example" }, "responseElements": { "accessToken": "HIDDEN_DUE_TO_SECURITY_REASONS", "tokenType": "Bearer", "expiresIn": 28800, "refreshToken": "HIDDEN_DUE_TO_SECURITY_REASONS", "idToken": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "eventID": "09a6e1a9-50e5-45c0-9f08-e6ef5089b262", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "IdentityStoreId", "ARN": "d-1234567890" } ], "eventType": "AwsApiCall", "recipientAccountId": "111122223333" } Logging IAM Identity Center API calls with AWS CloudTrail 438 AWS IAM Identity Center User Guide Understanding IAM Identity Center sign-in events AWS CloudTrail records successful and unsuccessful sign-in events for all IAM Identity Center identity sources. IAM Identity Center and Active Directory (AD Connector and AWS Managed Microsoft AD) sourced identities include additional sign-in events that are captured each time a user is prompted to solve a speciﬁc credential challenge or factor, in addition to the status of that particular credential veriﬁcation request. Only after a user has completed all required credential challenges will the user be signed in, which will result in a UserAuthentication event being logged. The following table captures each of the IAM Identity Center sign-in CloudTrail event names, their purpose, and applicability to diﬀerent identity sources. Event name Event purpose Identity source applicability CredentialChallenge Used to notify that IAM Identity Center has requested Native IAM Identity Center users, AD Connector, and the user to solve a speciﬁc AWS Managed Microsoft AD credential challenge and speciﬁes the Credentia lType that was required (For example, PASSWORD or TOTP). CredentialVerifica tion Used to notify that the user has attempted to Native IAM Identity Center users, AD Connector, and solve a speciﬁc Credentia AWS Managed Microsoft AD UserAuthentication lChallenge and speciﬁes whether that request credential succeeded or failed. Used to notify that all authentication requireme nts the user was challenge d with have been successfu lly completed and that the user was successfully signed All identity sources Logging IAM Identity Center API calls with AWS CloudTrail 439 AWS IAM Identity Center User Guide Event name Event purpose Identity source applicability in. Users failing to successfu lly complete the required credential challenges will result in no UserAuthe ntication event being logged. The following table captures additional useful event data ﬁelds contained within speciﬁc sign-in CloudTrail events. Field Event purpose Sign-in event applicability Example values AuthWorkflowID Used to correlate all events emitted across an entire sign- Credentia lChalleng e , Credentia "AuthWorkﬂowID": "9de74b32-8362-4a0 1-a524-de21df59fd8 in sequence. For each user sign-in, lVerifica tion , UserAuthe 3" multiple events may ntication CredentialType be emitted by IAM Identity Center. Used to specify the credential or factor that was challenge d. UserAuthe ntication events will include all of the CredentialType values that were successfully veriﬁed across the user's sign- in sequence. Credentia lChalleng e , Credentia lVerifica tion , UserAuthe ntication CredentialType": "PASSWORD" or "CredentialType": "PASSWORD ,TOTP" (possible values include: PASSWORD, TOTP, WEBAUTHN, EXTERNAL_IDP, RESYNC_TOTP, EMAIL_OTP) Logging IAM Identity Center API calls with AWS CloudTrail 440 AWS IAM Identity Center User Guide Field Event purpose Sign-in event applicability Example values DeviceEnr ollmentRe quired LoginTo Used to specify that the user was UserAuthe ntication "DeviceEnrollmentR equired": "true" required to register an MFA device during sign-in, and that the user successfu lly completed that request. Used to specify the redirect location following a successful sign-in sequence. UserAuthe ntication "LoginTo": "https:// mydirectory.awsapp s.com/start/....." CloudTrail events in the IAM Identity Center sign-in ﬂows The following diagram describes the sign-in ﬂow and the CloudTrail events that Sign-in emits Logging IAM Identity Center API calls with AWS CloudTrail 441 AWS IAM Identity Center User Guide The diagram shows a password sign-in ﬂow and a federated sign-in ﬂow. The password sign-in ﬂow, which consists of steps 1–8, demonstrates the steps during the username and password sign-in process. IAM Identity Center sets userIdentity.additionalEventData.CredentialType to "PASSWORD", and IAM Identity Center goes through the credentials challenge-response cycle,
sso-ug-168	sso-ug.pdf	168	redirect location following a successful sign-in sequence. UserAuthe ntication "LoginTo": "https:// mydirectory.awsapp s.com/start/....." CloudTrail events in the IAM Identity Center sign-in ﬂows The following diagram describes the sign-in ﬂow and the CloudTrail events that Sign-in emits Logging IAM Identity Center API calls with AWS CloudTrail 441 AWS IAM Identity Center User Guide The diagram shows a password sign-in ﬂow and a federated sign-in ﬂow. The password sign-in ﬂow, which consists of steps 1–8, demonstrates the steps during the username and password sign-in process. IAM Identity Center sets userIdentity.additionalEventData.CredentialType to "PASSWORD", and IAM Identity Center goes through the credentials challenge-response cycle, retrying as needed. The number of steps depends on the type of login and the presence of the multi-factor authentication (MFA). The initial process results in three or ﬁve CloudTrail events with UserAuthentication ending the sequence for a successful authentication. Unsuccessful password authentication attempts result in additional CloudTrail events as the IAM Identity Center re-issues CredentialChallenge for regular or, if enabled, MFA authentication. The password sign-in ﬂow also covers the scenario where an IAM Identity Center user newly- created with a CreateUser API call signs in with a one-time password (OTP). The credential type in this scenario is “EMAIL_OTP”. The federated sign-in ﬂow, consisting of steps 1a, 2a, and 8, demonstrates the main steps during the federated authentication process where a SAML assertion is provided by an identity provider, validated by IAM Identity Center, and if successful, results in UserAuthentication. IAM Identity Logging IAM Identity Center API calls with AWS CloudTrail 442 AWS IAM Identity Center User Guide Center doesn't invoke the internal MFA authentication sequence in steps 3 – 7 because an external, federated identity provider is responsible for all user credential authentication. Username in sign-in CloudTrail events IAM Identity Center emits the UserName ﬁeld under the additionalEventData element once per successful sign-in of an IAM Identity Center user. The following list describes the two sign-in events in scope, and the conditions under which this can happen. Only one of the conditions can be true when a user is signing in. • CredentialChallenge • When CredentialType is "PASSWORD" – applies to password authentication with AWS Directory Service or IAM Identity Center directory. • When CredentialType is "EMAIL_OTP" – applies only to the IAM Identity Center directory when a user created with a CreateUser API call attempts to sign in for the ﬁrst time, and the user receives a one-time password to sign in with that password once. • UserAuthentication • When CredentialType is "EXTERNAL_IDP" – applies to authentication with an external IdP. The value of UserName is as follows for successful authentications: • When the identity source is an external IdP, the value is equal to the nameID value in the incoming SAML assertion. This value is equal to the UserName ﬁeld in the IAM Identity Center directory. • When the identity source is an IAM Identity Center directory, the value emitted is equal to the UserName ﬁeld in this directory. • When the identity source is the AWS Directory Service, the value emitted is equal to the username that the user enters during authentication. For example, a user who has the username [email protected], can authenticate with anyuser, [email protected], or company.com/anyuser, and in each case the entered value is emitted in CloudTrail respectively. Note We recommend you use userId and identityStoreArn for identifying the user behind IAM Identity Center CloudTrail events. If you need to use the userName ﬁeld, we Logging IAM Identity Center API calls with AWS CloudTrail 443 AWS IAM Identity Center User Guide recommend you use the userName under the additionalEventData element, and avoid using the userName ﬁeld under the userIdentity element. For additional information on how you can use the UserName ﬁeld, refer to Correlating users between IAM Identity Center and external directories. Example events for IAM Identity Center sign-in scenarios The following examples show the expected sequence of CloudTrail events for diﬀerent sign-in scenarios. Topics • Successful sign-in when authenticating with only a password • Successful sign-in when authenticating with an external identity provider • Successful sign-in when authenticating with a password and a TOTP authenticator app • Successful sign-in when authenticating with a password and forced MFA registration is required • Failed sign-in when authenticating with only a password Successful sign-in when authenticating with only a password The following sequence of events captures an example of a successful password only sign-in. CredentialChallenge (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, Logging IAM Identity Center API calls with AWS CloudTrail 444 AWS IAM Identity Center User Guide "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-07T20:33:58Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialChallenge", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"9de74b32-8362-4a01-a524-de21df59fd83", "UserName":"[email protected]", "CredentialType":"PASSWORD" }, "requestID":"5be44ffb-6946-4f47-acaf-1adebd4afead", "eventID":"27ea7725-c1fd-4355-bdba-d0e628e0e604", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "serviceEventDetails":{ "CredentialChallenge":"Success"
sso-ug-169	sso-ug.pdf	169	when authenticating with only a password Successful sign-in when authenticating with only a password The following sequence of events captures an example of a successful password only sign-in. CredentialChallenge (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, Logging IAM Identity Center API calls with AWS CloudTrail 444 AWS IAM Identity Center User Guide "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-07T20:33:58Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialChallenge", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"9de74b32-8362-4a01-a524-de21df59fd83", "UserName":"[email protected]", "CredentialType":"PASSWORD" }, "requestID":"5be44ffb-6946-4f47-acaf-1adebd4afead", "eventID":"27ea7725-c1fd-4355-bdba-d0e628e0e604", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "serviceEventDetails":{ "CredentialChallenge":"Success" } } Successful CredentialVeriﬁcation (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, Logging IAM Identity Center API calls with AWS CloudTrail 445 AWS IAM Identity Center User Guide "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-07T20:34:09Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialVerification", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"9de74b32-8362-4a01-a524-de21df59fd83", "CredentialType":"PASSWORD" }, "requestID":"f3cf52ad-fd3d-4889-8c15-f18d1a7c7393", "eventID":"c49640f6-0c8a-43d3-a6e0-900e3bb188d4", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialVerification":"Success" } } Successful UserAuthentication (Password Only) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, Logging IAM Identity Center API calls with AWS CloudTrail 446 AWS IAM Identity Center User Guide "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-07T20:34:09Z", "eventSource":"signin.amazonaws.com", "eventName":"UserAuthentication", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"9de74b32-8362-4a01-a524-de21df59fd83", "LoginTo":"https://d-1234567890.awsapps.com/start/? state=QVlBQmVGMHFiS0wzWlp1SFgrR25BRnFobU5nQUlnQUJBQk5FWVhSaFVHeGhibVZUZEdGMFpWQmhjbUZ0QUFsUVpYSmxaM0pwYm1VQUFRQUhZWGR6TFd0dGN3QkxZWEp1T21GM2N6cHJiWE02ZFhNdFpXRnpkQzB4T2pjNE9ETTJNVFUxTWpnM056cHJaWGt2TjJOa056Um1PR1l0TnpNME5TMDBabUUxTFdFeU5Ea3RZV0kwTVRreE9UTmhOakkxQUxnQkFnRUFlTDJaOW85cm0xUHNKME05RjZtemdJSXczVU81a0trQy8yZktUWHNUbkx4b0FldytIdzFCK1NuM2NVWitsbncxdGdBQUFBQitNSHdHQ1NxR1NJYjNEUUVIQnFCdk1HMENBUUF3YUFZSktvWklodmNOQVFjQk1CNEdDV0NHU0FGbEF3UUJMakFSQkF5TFJxUDNsUUR6b0txUmlKQUNBUkNBTzRhalR4UUM3cUMvUG1ZUHBJWnRLS2ZlQkRHdmVsNXVJS1REdTkvekRNd2JxRFcxcVBTMDRkZUxST2NGYk96K2xzeGdTdUlKZTVYdiswZWdBZ0FBQUFBTUFBQVFBQUFBQUFBQUFBQUFBQUFBQVB5NEdEdUtWYnBzZWRTYTgvL3MrdEQvLy8vL0FBQUFBUUFBQUFBQUFBQUFBQUFBQVFBQUFGTXNzY3Q2V1QrZjg4N3AvbnlXQUNuQzFweGZaVGZvSjNSVWdhREJOKzNjK2F2NEI5WENxRDM2NkxmcTBzaDIrM3RDQ2J0N2VzMmw0Y1lDcXhwRFM3Y1JnRUxxMjQrVGdZSndvZXZkWW83eFV1bG9sVkJkTWFhcVBSenFyb2ZzNGpFR1FjUT0%3D&auth_code=11OawSqh1qmg4ePRn3DGfmBkWhJ5kYC4t6eFTprUDe8A_h_E75G3iwMNuAvLOs73v5vOaP_xA_PYJikGpt9UJ8kX92vRBCZPubpGegAoz__1fHKwL207gI6MVYEQvMKb2xfMf4qCKedRe0i- BshlIc5OBAA6ftz73M6LsfLWDlfOxviO2K3wet946lC30f_iWdilx- zv__4pSHf7mcUIs&wdc_csrf_token=srAzW1jK4GPYYoR452ruZ38DxEsDY9x81q1tVRSnno5pUjISvP7TqziOLiBLBUSxEjOmQk2XoLlcYolXjOMdiaBoVVBL482Q6iShpDgQcm271KWlODotVsoVADe1tixLr694N70foOPUAuIdi6RxxBSteidgAU7SBZDdfAxeJdqTg45kc4XpnCTKlQiIsrdFShisDnocFsj6EQRDTtEggww2MCXuJBByhpCfUIwg14znJwpR4F9wBw76xyTBBQOv&organization=d-9067230c03&region=us- east-1", "CredentialType":"PASSWORD" }, "requestID":"f3cf52ad-fd3d-4889-8c15-f18d1a7c7393", "eventID":"e959a95a-2b33-478d-906c-4fe303e8a9f1", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "UserAuthentication":"Success" } } Successful sign-in when authenticating with an external identity provider The following sequence of events captures an example of a successful sign-in when authenticated through the SAML protocol using an external identity provider. Successful UserAuthentication (External Identity Provider) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", Logging IAM Identity Center API calls with AWS CloudTrail 447 AWS IAM Identity Center "arn":"", "accountId":"111122223333", "accessKeyId":"", "onBehalfOf": { User Guide "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-07T20:34:09Z", "eventSource":"signin.amazonaws.com", "eventName":"UserAuthentication", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"9de74b32-8362-4a01-a524-de21df59fd83", "LoginTo":"https://d-1234567890.awsapps.com/start/? state=QVlBQmVGMHFiS0wzWlp1SFgrR25BRnFobU5nQUlnQUJBQk5FWVhSaFVHeGhibVZUZEdGMFpWQmhjbUZ0QUFsUVpYSmxaM0pwYm1VQUFRQUhZWGR6TFd0dGN3QkxZWEp1T21GM2N6cHJiWE02ZFhNdFpXRnpkQzB4T2pjNE9ETTJNVFUxTWpnM056cHJaWGt2TjJOa056Um1PR1l0TnpNME5TMDBabUUxTFdFeU5Ea3RZV0kwTVRreE9UTmhOakkxQUxnQkFnRUFlTDJaOW85cm0xUHNKME05RjZtemdJSXczVU81a0trQy8yZktUWHNUbkx4b0FldytIdzFCK1NuM2NVWitsbncxdGdBQUFBQitNSHdHQ1NxR1NJYjNEUUVIQnFCdk1HMENBUUF3YUFZSktvWklodmNOQVFjQk1CNEdDV0NHU0FGbEF3UUJMakFSQkF5TFJxUDNsUUR6b0txUmlKQUNBUkNBTzRhalR4UUM3cUMvUG1ZUHBJWnRLS2ZlQkRHdmVsNXVJS1REdTkvekRNd2JxRFcxcVBTMDRkZUxST2NGYk96K2xzeGdTdUlKZTVYdiswZWdBZ0FBQUFBTUFBQVFBQUFBQUFBQUFBQUFBQUFBQVB5NEdEdUtWYnBzZWRTYTgvL3MrdEQvLy8vL0FBQUFBUUFBQUFBQUFBQUFBQUFBQVFBQUFGTXNzY3Q2V1QrZjg4N3AvbnlXQUNuQzFweGZaVGZvSjNSVWdhREJOKzNjK2F2NEI5WENxRDM2NkxmcTBzaDIrM3RDQ2J0N2VzMmw0Y1lDcXhwRFM3Y1JnRUxxMjQrVGdZSndvZXZkWW83eFV1bG9sVkJkTWFhcVBSenFyb2ZzNGpFR1FjUT0%3D&auth_code=11OawSqh1qmg4ePRn3DGfmBkWhJ5kYC4t6eFTprUDe8A_h_E75G3iwMNuAvLOs73v5vOaP_xA_PYJikGpt9UJ8kX92vRBCZPubpGegAoz__1fHKwL207gI6MVYEQvMKb2xfMf4qCKedRe0i- BshlIc5OBAA6ftz73M6LsfLWDlfOxviO2K3wet946lC30f_iWdilx- zv__4pSHf7mcUIs&wdc_csrf_token=srAzW1jK4GPYYoR452ruZ38DxEsDY9x81q1tVRSnno5pUjISvP7TqziOLiBLBUSxEjOmQk2XoLlcYolXjOMdiaBoVVBL482Q6iShpDgQcm271KWlODotVsoVADe1tixLr694N70foOPUAuIdi6RxxBSteidgAU7SBZDdfAxeJdqTg45kc4XpnCTKlQiIsrdFShisDnocFsj6EQRDTtEggww2MCXuJBByhpCfUIwg14znJwpR4F9wBw76xyTBBQOv&organization=d-9067230c03&region=us- east-1", "CredentialType":"EXTERNAL_IDP", "UserName":"[email protected]" }, "requestID":"f3cf52ad-fd3d-4889-8c15-f18d1a7c7393", "eventID":"e959a95a-2b33-478d-906c-4fe303e8a9f1", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "UserAuthentication":"Success" } } Logging IAM Identity Center API calls with AWS CloudTrail 448 AWS IAM Identity Center User Guide Successful sign-in when authenticating with a password and a TOTP authenticator app The following sequence of events captures an example where multi-factor authentication was required during sign-in and the user successfully signed in using a password and a TOTP authenticator app. CredentialChallenge (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-08T20:40:13Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialChallenge", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"303486b5-fce1-4d59-ba1d-eb3acb790729", "CredentialType":"PASSWORD", "UserName":"[email protected]" }, "requestID":"e454ea66-1027-4d00-9912-09c0589649e1", "eventID":"d89cc0b5-a23a-4b88-843a-89329aeaef2e", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, Logging IAM Identity Center API calls with AWS CloudTrail 449 AWS IAM Identity Center User Guide "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialChallenge":"Success" } } Successful CredentialVeriﬁcation (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-08T20:40:20Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialVerification", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"303486b5-fce1-4d59-ba1d-eb3acb790729", "CredentialType":"PASSWORD" }, "requestID":"92c4ac90-0d9b-452d-95d5-728487612f5e", "eventID":"4533fd49-6669-4d0b-b272-a0b2139309a8", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, Logging IAM Identity Center API calls with AWS CloudTrail 450 AWS IAM Identity Center User Guide "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialVerification":"Success" } } CredentialChallenge (TOTP) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-08T20:40:20Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialChallenge", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"303486b5-fce1-4d59-ba1d-eb3acb790729", "CredentialType":"TOTP" }, "requestID":"92c4ac90-0d9b-452d-95d5-728487612f5e", "eventID":"29202f08-f240-40cc-b789-c0cea8a27847", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, Logging IAM Identity Center API calls with AWS CloudTrail 451 AWS IAM Identity Center User Guide "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialChallenge":"Success" } } Successful CredentialVeriﬁcation (TOTP) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-08T20:40:27Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialVerification", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"303486b5-fce1-4d59-ba1d-eb3acb790729", "CredentialType":"TOTP" }, "requestID":"c40a691f-eeb1-4352-b286-5e909f96f318", "eventID":"e889ff1d-fcaf-454f-805d-7132cf2362a4", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, Logging IAM Identity Center API calls with AWS CloudTrail 452 AWS IAM Identity Center User Guide "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialVerification":"Success" } } Successful UserAuthentication (Password + TOTP) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-08T20:40:27Z", "eventSource":"signin.amazonaws.com", "eventName":"UserAuthentication", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"303486b5-fce1-4d59-ba1d-eb3acb790729", "LoginTo":"https://d-1234567890.awsapps.com/start/?state \u003dQVlBQmVLeFhWeDRmZFJmMmxHcWYwdzhZck5RQUlnQUJBQk5FWVhSaFVHeGhibVZUZEdGMFpWQmhjbUZ0QUFsUVpYSmxaM0pwYm1VQUFRQUhZWGR6TFd0dGN3QkxZWEp1T21GM2N6cHJiWE02ZFhNdFpXRnpkQzB4T2pjNE9ETTJNVFUxTWpnM056cHJaWGt2TjJOa056Um1PR1l0TnpNME5TMDBabUUxTFdFeU5Ea3RZV0kwTVRreE9UTmhOakkxQUxnQkFnRUFlTDJaOW85cm0xUHNKME05RjZtemdJSXczVU81a0trQy8yZktUWHNUbkx4b0FjT3lLZ2RQUFBTRzN6d2l0WmJOSFVRQUFBQitNSHdHQ1NxR1NJYjNEUUVIQnFCdk1HMENBUUF3YUFZSktvWklodmNOQVFjQk1CNEdDV0NHU0FGbEF3UUJMakFSQkF3aHFPL1ZoaFU4bmJFaEoxZ0NBUkNBTzJYZ0xpem12MlJoM3lnRGJaQ2dUcUZlbk5iWGN2ZWVzUjV6WmpLeXZUVnBwTjk2ZGVUZ3plcURod3hRMmNTR1pkTnBVd1RWWWFxbGp2akRBZ0FBQUFBTUFBQVFBQUFBQUFBQUFBQUFBQUFBQUxhZjZTVnRvMlFKWWt0Q0crWjd6NnIvLy8vL0FBQUFBUUFBQUFBQUFBQUFBQUFBQVFBQUFGUFhUR3dad0NheXAwUlZBQjJOelZsZnJ1aEdEOUNPeDNqMENBakdseU9DSWxFejlnZWRqcUZxUHZnUzIrN1ltZE84R1BvN21FQ0sybnBqdm13enozWEdBdnJFcVNzZ2RVQVBReXFpcS9oWTdFaUxhZHBYclhYZDlKeUkxZGJ4K3k3Wk80WT0%3D \u0026auth_code \u003d11Fir1mCVJ-4Y5UY6RI10UCXvRePCHd6195xvYg1rwo1Pj7B-7UGIGlYUUVe31Nkzd7ihxKn6DMdnFfO01O8qc3RFR8FUd1w8Z91Txh_4i9y47- Sx-pjBXKG_jUcvBk_UILdGytV4o1u97h42B- TA_6uwdmJiw1dcCz_Rv44d_BS0PkulW-5LVJy1oeP1H0FPPMeheyuk5Uy48d5of9-c\u0026wdc_csrf_token Logging IAM Identity Center API calls with AWS CloudTrail 453 AWS IAM Identity Center User Guide \u003dNMlui44guoVnxRd0qu2tYJIdyyFPX6SDRNTspIScfMM0AgFbho1nvvCaxPTghHbgHCRIXdffFtzH0sL1ow419BobnmqBsnJNx17h3kujsGzt9DJFaJCgbZQOF7pSbr1pHVMGg1MOOvniFekN6YmJ2CB1FeKUBbfNAz2bGZYnXrXQe6bTenIh5f0Pu9lhZJZ5KDQVka7afWFqOaQCzLEFwgATcJ44N6YcmmZBJbKHx3gyEDMzkwRuNJrwjoVpkmDH \u0026organization\u003dd-9067230c03\u0026region\u003dus-east-1",
sso-ug-170	sso-ug.pdf	170	}, "requestID":"c40a691f-eeb1-4352-b286-5e909f96f318", "eventID":"e889ff1d-fcaf-454f-805d-7132cf2362a4", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, Logging IAM Identity Center API calls with AWS CloudTrail 452 AWS IAM Identity Center User Guide "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialVerification":"Success" } } Successful UserAuthentication (Password + TOTP) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-08T20:40:27Z", "eventSource":"signin.amazonaws.com", "eventName":"UserAuthentication", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"303486b5-fce1-4d59-ba1d-eb3acb790729", "LoginTo":"https://d-1234567890.awsapps.com/start/?state \u003dQVlBQmVLeFhWeDRmZFJmMmxHcWYwdzhZck5RQUlnQUJBQk5FWVhSaFVHeGhibVZUZEdGMFpWQmhjbUZ0QUFsUVpYSmxaM0pwYm1VQUFRQUhZWGR6TFd0dGN3QkxZWEp1T21GM2N6cHJiWE02ZFhNdFpXRnpkQzB4T2pjNE9ETTJNVFUxTWpnM056cHJaWGt2TjJOa056Um1PR1l0TnpNME5TMDBabUUxTFdFeU5Ea3RZV0kwTVRreE9UTmhOakkxQUxnQkFnRUFlTDJaOW85cm0xUHNKME05RjZtemdJSXczVU81a0trQy8yZktUWHNUbkx4b0FjT3lLZ2RQUFBTRzN6d2l0WmJOSFVRQUFBQitNSHdHQ1NxR1NJYjNEUUVIQnFCdk1HMENBUUF3YUFZSktvWklodmNOQVFjQk1CNEdDV0NHU0FGbEF3UUJMakFSQkF3aHFPL1ZoaFU4bmJFaEoxZ0NBUkNBTzJYZ0xpem12MlJoM3lnRGJaQ2dUcUZlbk5iWGN2ZWVzUjV6WmpLeXZUVnBwTjk2ZGVUZ3plcURod3hRMmNTR1pkTnBVd1RWWWFxbGp2akRBZ0FBQUFBTUFBQVFBQUFBQUFBQUFBQUFBQUFBQUxhZjZTVnRvMlFKWWt0Q0crWjd6NnIvLy8vL0FBQUFBUUFBQUFBQUFBQUFBQUFBQVFBQUFGUFhUR3dad0NheXAwUlZBQjJOelZsZnJ1aEdEOUNPeDNqMENBakdseU9DSWxFejlnZWRqcUZxUHZnUzIrN1ltZE84R1BvN21FQ0sybnBqdm13enozWEdBdnJFcVNzZ2RVQVBReXFpcS9oWTdFaUxhZHBYclhYZDlKeUkxZGJ4K3k3Wk80WT0%3D \u0026auth_code \u003d11Fir1mCVJ-4Y5UY6RI10UCXvRePCHd6195xvYg1rwo1Pj7B-7UGIGlYUUVe31Nkzd7ihxKn6DMdnFfO01O8qc3RFR8FUd1w8Z91Txh_4i9y47- Sx-pjBXKG_jUcvBk_UILdGytV4o1u97h42B- TA_6uwdmJiw1dcCz_Rv44d_BS0PkulW-5LVJy1oeP1H0FPPMeheyuk5Uy48d5of9-c\u0026wdc_csrf_token Logging IAM Identity Center API calls with AWS CloudTrail 453 AWS IAM Identity Center User Guide \u003dNMlui44guoVnxRd0qu2tYJIdyyFPX6SDRNTspIScfMM0AgFbho1nvvCaxPTghHbgHCRIXdffFtzH0sL1ow419BobnmqBsnJNx17h3kujsGzt9DJFaJCgbZQOF7pSbr1pHVMGg1MOOvniFekN6YmJ2CB1FeKUBbfNAz2bGZYnXrXQe6bTenIh5f0Pu9lhZJZ5KDQVka7afWFqOaQCzLEFwgATcJ44N6YcmmZBJbKHx3gyEDMzkwRuNJrwjoVpkmDH \u0026organization\u003dd-9067230c03\u0026region\u003dus-east-1", "CredentialType":"PASSWORD,TOTP" }, "requestID":"c40a691f-eeb1-4352-b286-5e909f96f318", "eventID":"7a8c8725-db2f-488d-a43e-788dc6c73a4a", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "UserAuthentication":"Success" } } Successful sign-in when authenticating with a password and forced MFA registration is required The following sequence of events captures an example of a successful password sign in, but the user was required and successfully completed registering an MFA device before completing their sign-in. CredentialChallenge (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-09T01:24:02Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialChallenge", Logging IAM Identity Center API calls with AWS CloudTrail 454 AWS IAM Identity Center "awsRegion":"us-east-1", User Guide "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"76d8a26d-ad9c-41a4-90c3-d607cdd7155c", "CredentialType":"PASSWORD", "UserName":"[email protected]" }, "requestID":"321f4b13-42b5-4005-a0f7-826cad26d159", "eventID":"8c707b0f-e45a-4a9c-bee2-ff68638d2f1b", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialChallenge":"Success" } } Successful CredentialVeriﬁcation (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-09T01:24:09Z", "eventSource":"signin.amazonaws.com", Logging IAM Identity Center API calls with AWS CloudTrail 455 AWS IAM Identity Center User Guide "eventName":"CredentialVerification", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"76d8a26d-ad9c-41a4-90c3-d607cdd7155c", "CredentialType":"PASSWORD" }, "requestID":"12b57efa-0a92-4479-91a3-5b6641817c21", "eventID":"783b0c89-7142-4942-8b84-6ee0de1b992e", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialVerification":"Success" } } Successful UserAuthentication (Password + MFA Registration Required) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", "onBehalfOf": { "userId": "94d00cd8-e9e6-4810-b177-b08e84725435", "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/ d-1234567890" }, "credentialId" : "8f761cae-883d-4a3d-af67-3abf46488f71" }, "eventTime":"2020-12-09T01:24:14Z", "eventSource":"signin.amazonaws.com", Logging IAM Identity Center API calls with AWS CloudTrail 456 AWS IAM Identity Center User Guide "eventName":"UserAuthentication", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"76d8a26d-ad9c-41a4-90c3-d607cdd7155c", "LoginTo":"https://d-1234567890.awsapps.com/start/?state \u003dQVlBQmVGQ3VqdHF5aW9CUDdrNXRTVTJUaWNnQUlnQUJBQk5FWVhSaFVHeGhibVZUZEdGMFpWQmhjbUZ0QUFsUVpYSmxaM0pwYm1VQUFRQUhZWGR6TFd0dGN3QkxZWEp1T21GM2N6cHJiWE02ZFhNdFpXRnpkQzB4T2pjNE9ETTJNVFUxTWpnM056cHJaWGt2TjJOa056Um1PR1l0TnpNME5TMDBabUUxTFdFeU5Ea3RZV0kwTVRreE9UTmhOakkxQUxnQkFnRUFlTDJaOW85cm0xUHNKME05RjZtemdJSXczVU81a0trQy8yZktUWHNUbkx4b0FSOVdDcXQ5bUxQeUJ2dFhJNTNFaGhvQUFBQitNSHdHQ1NxR1NJYjNEUUVIQnFCdk1HMENBUUF3YUFZSktvWklodmNOQVFjQk1CNEdDV0NHU0FGbEF3UUJMakFSQkF6Y0FYakw5TE1mdjh5a3owc0NBUkNBT3p5cTd4TXdzTFh3WnJ4dFNvVUF0MXVEU3J1WVBPWGc0UGFhNTNZQWxqamI2VFVyOGRYNjhpRDVoRCs3VVIrWVZUck1YOThsRGJCMmNHNHpBZ0FBQUFBTUFBQVFBQUFBQUFBQUFBQUFBQUFBQU03N1hhMlp4R1MzRUppT2xSY3ZRUnYvLy8vL0FBQUFBUUFBQUFBQUFBQUFBQUFBQVFBQUFGTVNpc3RSRGR6c0FmZmgwbHhsYks2RjZSNTg1NmdOZTRsaWxsT2x1QmVKZVRSRGtrVkVJRVl0Y0t4eFliRDJoV0JsUG9VbElCb01UYy9XbVNyRE1WU2JzcEl0ZXFMMVdxN2MrT2RRUXZFWEdHRUdkRXFpNHFpdmlmQmJhU2V1bGtmSERBOD0%3D \u0026auth_code \u003d11eZ80S_maUsZ7ABETjeQhyWfvIHYz52rgR28sYAKN1oEk2G07czrwzXvE9HLlN2K9De8LyBEV83SFeDQfrWpkwXfaBc2kNR125q_9JkiAeID3_5NkgvDEastjRV_mpFk0sf__0jRcr8vRm- FJyJqkoGrt_w6rm_MpAn0uyrVq8udY EgU3fhOL3QWvWiquYnDPMyPmmy_qkZgR9rz__BI \u0026wdc_csrf_token \u003dJih9U62o5LQDtYLNqCK8a6xj0gJg5BRWq2tbl75y8vAmwZhAqrgrgbxXat2M646UZGp93krw7WYQdHIgi5OYI9QSckf4aovh0maPetDfTj5twOa6FcUKKzMSMBkhJEwiMKgQ1ncaZTPRhdV8o53cyzTYPtZNp0KgrmxlLyZVscVnECUKogJxllWy67XU7po8K68iFqOCq5IGuAbv6zdblbQpaIR2OjgdHZgCjrPNFTUhaabhpOFtXdQNPDArJna1\u0026organization \u003dd-9067230c03\u0026region\u003dus-east-1", "CredentialType":"PASSWORD", "DeviceEnrollmentRequired":"true" }, "requestID":"74d24604-a365-4237-8c4a-350795494b92", "eventID":"a15bf257-7f37-46c0-b67c-fea5fa6166be", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "UserAuthentication":"Success" } } Failed sign-in when authenticating with only a password The following sequence of events captures an example of a failed password only sign-in. CredentialChallenge (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", Logging IAM Identity Center API calls with AWS CloudTrail 457 AWS IAM Identity Center User Guide "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", }, "eventTime":"2020-12-08T18:56:15Z", "eventSource":"signin.amazonaws.com", "eventName":"CredentialChallenge", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"adbf67c4-8188-4e2b-8527-fe539e328fa7", "CredentialType":"PASSWORD", "UserName":"[email protected]" }, "requestID":"f54848ea-b1aa-402f-bf0d-a54561a2ffcc", "eventID":"d96f1d6c-dbd9-4a0b-9a45-6a2b66078c78", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialChallenge":"Success" } } Failed CredentialVeriﬁcation (Password) { "eventVersion":"1.08", "userIdentity":{ "type":"Unknown", "principalId":"111122223333", "arn":"", "accountId":"111122223333", "accessKeyId":"", "userName":"[email protected]", }, "eventTime":"2020-12-08T18:56:21Z", Logging IAM Identity Center API calls with AWS CloudTrail 458 AWS IAM Identity Center User Guide "eventSource":"signin.amazonaws.com", "eventName":"CredentialVerification", "awsRegion":"us-east-1", "sourceIPAddress":"203.0.113.0", "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "requestParameters":null, "responseElements":null, "additionalEventData":{ "AuthWorkflowID":"adbf67c4-8188-4e2b-8527-fe539e328fa7", "CredentialType":"PASSWORD" }, "requestID":"04528c82-a678-4a1f-a56d-ea2c6445a72a", "eventID":"9160fe06-fc2a-474f-9b78-000ee067a09d", "readOnly":false, "eventType":"AwsServiceEvent", "managementEvent":true, "eventCategory":"Management", "recipientAccountId":"111122223333", "serviceEventDetails":{ "CredentialVerification":"Failure" } } Logging IAM Identity Center SCIM API calls with AWS CloudTrail IAM Identity Center SCIM is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures API calls for SCIM as events. Using the information collected by CloudTrail, you can determine the information about the requested action, the date and time of the action, request parameters, and so on. To learn more about CloudTrail, see AWS CloudTrail User Guide. Note CloudTrail is enabled on your AWS account when you create the account. However, you may need to rotate your access token to be able to see events from SCIM, if your token was created prior to September 2024. For more information, see Rotate an access token. SCIM supports logging for the following operations as events in CloudTrail: Logging IAM Identity Center SCIM with AWS CloudTrail 459 User Guide AWS IAM Identity Center • CreateGroup • CreateUser • DeleteGroup • DeleteUser • GetGroup • GetSchema • GetUser • ListGroups • ListResourceTypes • ListSchemas • ListUsers • PatchGroup • PatchUser • PutUser • ServiceProviderConﬁg Examples The following are some examples of CloudTrail events. Example 1: Event from a successful CreateUser call. { "eventVersion": "1.10", "userIdentity": { "type": "WebIdentityUser", "accountId": "123456789012", "accessKeyId": "xxxx" }, "eventTime": "xxxx", "eventSource": "identitystore-scim.amazonaws.com", "eventName": "CreateUser", "awsRegion": "us-east-1", "sourceIPAddress": "xx.xxx.xxx.xxx", "userAgent": "Go-http-client/2.0", "requestParameters": { "httpBody": { Logging IAM Identity Center SCIM with AWS CloudTrail 460 AWS IAM Identity Center User Guide "displayName": "HIDDEN_DUE_TO_SECURITY_REASONS", "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "name": { "familyName": "HIDDEN_DUE_TO_SECURITY_REASONS",
sso-ug-171	sso-ug.pdf	171	CreateGroup • CreateUser • DeleteGroup • DeleteUser • GetGroup • GetSchema • GetUser • ListGroups • ListResourceTypes • ListSchemas • ListUsers • PatchGroup • PatchUser • PutUser • ServiceProviderConﬁg Examples The following are some examples of CloudTrail events. Example 1: Event from a successful CreateUser call. { "eventVersion": "1.10", "userIdentity": { "type": "WebIdentityUser", "accountId": "123456789012", "accessKeyId": "xxxx" }, "eventTime": "xxxx", "eventSource": "identitystore-scim.amazonaws.com", "eventName": "CreateUser", "awsRegion": "us-east-1", "sourceIPAddress": "xx.xxx.xxx.xxx", "userAgent": "Go-http-client/2.0", "requestParameters": { "httpBody": { Logging IAM Identity Center SCIM with AWS CloudTrail 460 AWS IAM Identity Center User Guide "displayName": "HIDDEN_DUE_TO_SECURITY_REASONS", "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "name": { "familyName": "HIDDEN_DUE_TO_SECURITY_REASONS", "givenName": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "active": true, "userName": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "tenantId": "xxxx" }, "responseElements": { "meta" : { "created" : "Oct 10, 2024, 1:23:45 PM", "lastModified" : "Oct 10, 2024, 1:23:45 PM", "resourceType" : "User" }, "displayName" : "HIDDEN_DUE_TO_SECURITY_REASONS", "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "name": { "familyName": "HIDDEN_DUE_TO_SECURITY_REASONS", "givenName": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "active": true, "id" : "c4488478-a0e1-700e-3d75-96c6bb641596", "userName": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "requestID": "xxxx", "eventID": "xxxx", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management", "tlsDetails": { "clientProvidedHostHeader": "scim.us-east-1.amazonaws.com" } } Logging IAM Identity Center SCIM with AWS CloudTrail 461 AWS IAM Identity Center User Guide Example 2: Event from PatchGroup resulting in Missing path in PATCH request error message due to missing path. { "eventVersion": "1.10", "userIdentity": { "type": "Unknown", "accountId": "123456789012", "accessKeyId": "xxxx" }, "eventTime": "xxxx", "eventSource": "identitystore-scim.amazonaws.com", "eventName": "PatchGroup", "awsRegion": "us-east-1", "sourceIPAddress": "xxx.xxx.xxx.xxx", "userAgent": "Go-http-client/2.0", "errorCode": "ValidationException", "errorMessage": "Missing path in PATCH request", "requestParameters": { "httpBody": { "operations": [ { "op": "REMOVE", "value": "HIDDEN_DUE_TO_SECURITY_REASONS" } ], "schemas": [ "HIDDEN_DUE_TO_SECURITY_REASONS" ] }, "tenantId": "xxxx", "id": "xxxx" }, "responseElements": null, "requestID": "xxxx", "eventID": "xxxx", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management", "tlsDetails": { "clientProvidedHostHeader": "scim.us-east-1.amazonaws.com" Logging IAM Identity Center SCIM with AWS CloudTrail 462 AWS IAM Identity Center } } User Guide Example 3: Event from CreateGroup call resulting in Duplicate GroupDisplayName error message as the name of the group that's trying to be created exists. { "eventVersion": "1.10", "userIdentity": { "type": "Unknown", "accountId": "123456789012", "accessKeyId": "xxxx" }, "eventTime": "xxxx", "eventSource": "identitystore-scim.amazonaws.com", "eventName": "CreateGroup", "awsRegion": "us-east-1", "sourceIPAddress": "xxx.xxx.xxx.xxx", "userAgent": "Go-http-client/2.0", "errorCode": "ConflictException", "errorMessage": "Duplicate GroupDisplayName", "requestParameters": { "httpBody": { "displayName": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "tenantId": "xxxx" }, "responseElements": null, "requestID": "xxxx", "eventID": "xxxx", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management", "tlsDetails": { "clientProvidedHostHeader": "scim.us-east-1.amazonaws.com" } } Example 4: Event from PatchUser call resulting in an List attribute emails exceeds allowed limit of 1 error error message. Users can only have one email address. Logging IAM Identity Center SCIM with AWS CloudTrail 463 AWS IAM Identity Center User Guide { "eventVersion": "1.10", "userIdentity": { "type": "Unknown", "accountId": "123456789012", "accessKeyId": "xxxx" }, "eventTime": "xxxx", "eventSource": "identitystore-scim.amazonaws.com", "eventName": "PatchUser", "awsRegion": "us-east-1", "sourceIPAddress": "xxx.xxx.xxx.xxx", "userAgent": "Go-http-client/2.0", "errorCode": "ValidationException", "errorMessage": "List attribute emails exceeds allowed limit of 1", "requestParameters": { "httpBody": { "operations": [ { "op": "REPLACE", "path": "emails", "value": "HIDDEN_DUE_TO_SECURITY_REASONS" } ], "schemas": [ "HIDDEN_DUE_TO_SECURITY_REASONS" ] }, "tenantId": "xxxx", "id": "xxxx" }, "responseElements": null, "requestID": "xxxx", "eventID": "xxxx", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management", "tlsDetails": { "clientProvidedHostHeader": "scim.us-east-1.amazonaws.com" } } Logging IAM Identity Center SCIM with AWS CloudTrail 464 AWS IAM Identity Center Common Error Messages User Guide The following are common validation error messages you can receive in CloudTrail events for IAM Identity Center SCIM API calls: • List attribute email exceeds allowed limit of 1 • List attribute addresses allowed limit of 1 • 1 validation errors detected: Value at 'name.familyName' failed to satisfy constraint: Member must satisfy regular expression pattern: [\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+ • 2 validation errors detected: Value at 'name.familyName' failed to satisfy constraint: Member must have length greater than or equal to 1; Value at 'name.familyName' failed to satisfy constraint: Member must satisfy regular expression pattern: [\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t \\n\\r ]+ • 2 validation errors detected: Value at 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.value' failed to satisfy constraint: Member must have length greater than or equal to 1; Value at 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.value' failed to satisfy constraint: Member must satisfy regular expression pattern: [\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t \\n\\r ]+", • Invalid JSON from RequestBody • Invalid Filter format For more information on troubleshooting IAM Identity Center SCIM provisioning errors, see this AWS re:Post article. Connect application components with Amazon EventBridge You can integrate IAM Identity Center with Amazon EventBridge to raise events that initiate administrative notiﬁcations or invoke automated workﬂows in response to speciﬁc IAM Identity Center actions recorded in CloudTrail events. For example, you might conﬁgure EventBridge rules to detect when a user deletes an application or when IAM Identity Center creates a new group. Depending on your use case, you can route these events to an Amazon SNS topic to notify administrators or invoke additional automation using AWS Lambda, Step Functions, or other EventBridge-supported services. Amazon EventBridge 465 AWS IAM Identity Center User Guide Logging conﬁgurable AD sync errors You can enable logging on your
sso-ug-172	sso-ug.pdf	172	Amazon EventBridge to raise events that initiate administrative notiﬁcations or invoke automated workﬂows in response to speciﬁc IAM Identity Center actions recorded in CloudTrail events. For example, you might conﬁgure EventBridge rules to detect when a user deletes an application or when IAM Identity Center creates a new group. Depending on your use case, you can route these events to an Amazon SNS topic to notify administrators or invoke additional automation using AWS Lambda, Step Functions, or other EventBridge-supported services. Amazon EventBridge 465 AWS IAM Identity Center User Guide Logging conﬁgurable AD sync errors You can enable logging on your conﬁgurable Active Directory (AD) sync conﬁgurations to receive logs with information about errors that can occur during the sync process. With these logs, you can monitor if there is an issue with your conﬁgurable AD sync and take action if applicable. You can send your logs to an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Data Firehose with cross account delivery supported for Amazon S3 buckets and Firehose. For more information about limitations, permissions, and vended logs, see Enabling logging from AWS services. Note You are charged for logging. For more information, see Vended Logs on the Amazon CloudWatch Pricing page. To enable conﬁgurable AD sync error logs 1. Sign in to the IAM Identity Center console. 2. Choose Settings. 3. On the Settings page, choose the Identity source tab, choose Actions, and then choose Manage logs. 4. Choose Add log delivery and one of the following destination types. a. Choose To Amazon CloudWatch Logs. Then choose or enter the destination log group. b. Choose To Amazon S3. Then choose or enter the destination bucket. c. Choose To Firehose. Then choose or enter the destination delivery stream. 5. Choose Submit. To disable conﬁgurable AD sync error logs 1. Sign in to the IAM Identity Center console. 2. Choose Settings. Logging conﬁgurable AD sync errors 466 AWS IAM Identity Center User Guide 3. On the Settings page, choose the Identity source tab, choose Actions, and then choose Manage logs. 4. Choose Remove for the destination that you want to remove. 5. Choose Submit. Conﬁgurable AD sync error log ﬁelds See the following list for possible error log ﬁelds. sync_profile_name The name of the sync proﬁle. error_code The error code that represents what type of error has occurred. error_message A message that contains detailed information about the error that occurred. sync_source The sync source is where entities are being synced from. For IAM Identity Center, this is an Active Directory (AD) managed by AWS Directory Service. The sync source contains the domain and ARN of the directory aﬀected. sync_target The sync target is the destination where entities are being saved. For IAM Identity Center, this is an Identity Store. The sync target contains the Identity Store ARN aﬀected. source_entity_id A unique identiﬁer for the entity that is causing the error. For IAM Identity Center, this is the SID of the entity. source_entity_type The type of entity causing the error. The value can be USER or GROUP. eventTimestamp The timestamp when the error occurred. Logging conﬁgurable AD sync errors 467 AWS IAM Identity Center User Guide Conﬁgurable AD sync error log examples Example 1: An error log for an expired password for an AD directory { "sync_profile_name": "EXAMPLE-PROFILE-NAME", "error" : { "error_code": "InvalidDirectoryCredentials", "error_message": "The password for your AD directory has expired. Please reset the password to allow Identity Sync to access the directory." }, "sync_source": { "arn": "arn:aws:ds:us-east-1:123456789:directory/d-123456", "domain": "EXAMPLE.com" }, "eventTimestamp": "1683355579981" } Example 2: An error log for a user with a non-unique username { "sync_profile_name": "EXAMPLE-PROFILE-NAME", "error" : { "error_code": "ConflictError", "error_message": "The source entity has a username conflict with the sync target. Please verify that the source identity has a unique username in the target." }, "sync_source": { "arn": "arn:aws:ds:us-east-1:111122223333:directory/d-123456", "domain": "EXAMPLE.com" }, "sync_target": { "arn": "arn:aws:identitystore::111122223333:identitystore/d-123456" }, "source_entity_id": "SID-1234", "source_entity_type": "USER", "eventTimestamp": "1683355579981" } Logging conﬁgurable AD sync errors 468 AWS IAM Identity Center User Guide Compliance validation for IAM Identity Center Third-party auditors assess the security and compliance of AWS services such as AWS IAM Identity Center as part of multiple AWS compliance programs. To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations
sso-ug-173	sso-ug.pdf	173	an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious Compliance validation 469 AWS IAM Identity Center User Guide activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Supported compliance standards IAM Identity Center has undergone auditing for the following standards and is eligible for use as part of solutions for which you need to obtain compliance certiﬁcation. AWS has expanded its Health Insurance Portability and Accountability Act (HIPAA) compliance program to include IAM Identity Center as a HIPAA eligible service. AWS oﬀers a HIPAA-focused whitepaper for customers who want to learn more about how they can use AWS services to process and store health information. For more information, see HIPAA compliance. The Information Security Registered Assessors Program (IRAP) enables Australian Government customers to ensure that appropriate compliance controls are in place and determine the appropriate responsibility model for addressing the requirements of the Australian Government Information Security Manual (ISM) produced by the Australian Cyber Security Centre (ACSC). For more information, see IRAP Resources. IAM Identity Center has an Attestation of Compliance for Payment Card Industry (PCI) Data Security Standard (DSS) version 3.2 at Service Provider Level 1. Customers who use AWS products and services to store, process, or transmit cardholder data can use the following identity sources in IAM Identity Center to manage their own PCI DSS compliance certiﬁcation: Supported compliance standards 470 AWS IAM Identity Center User Guide • Active Directory • External identity provider The IAM Identity Center identity source is currently not compliant with PCI DSS. For more information about PCI DSS, including how to request a copy of the AWS PCI Compliance Package, see PCI DSS level 1. System & Organization Control (SOC) Reports are independent, third-party examination reports that demonstrate how IAM Identity Center achieves key compliance controls and objectives. These reports help you and your auditors to understand how controls support operations and compliance. There are three types of SOC reports: • AWS SOC 1 Report - Download with AWS Artifact • AWS SOC 2: Security, Availability, & Conﬁdentiality Report - Download with AWS Artifact • AWS SOC 3: Security, Availability, & Conﬁdentiality Report IAM Identity Center is in scope for AWS SOC 1, SOC 2, and SOC 3 reports. For more information, see SOC Compliance. Resilience in IAM Identity Center The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Resilience 471 AWS IAM Identity Center User Guide Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information
sso-ug-174	sso-ug.pdf	174	SOC 1, SOC 2, and SOC 3 reports. For more information, see SOC Compliance. Resilience in IAM Identity Center The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Resilience 471 AWS IAM Identity Center User Guide Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS global infrastructure. To learn more about AWS IAM Identity Center resiliency, see Resiliency design and Regional behavior. Infrastructure security in IAM Identity Center As a managed service, AWS IAM Identity Center is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access IAM Identity Center through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Infrastructure security 472 AWS IAM Identity Center User Guide Tagging AWS IAM Identity Center resources A tag is a custom attribute label that you add to an AWS resource to make it easier to identify, organize, and search for resources. Each tag has two parts: • A tag key (for example, CostCenter, Environment, or Project). Tag keys can be up to 128 characters in length and are case sensitive. • A tag value (for example, 111122223333 or Production). Tag values can be up to 256 characters in length, and like tag keys, are case sensitive. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string. Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from diﬀerent services to indicate that the resources are related. For example, you can assign the same tag to a speciﬁc permission set in your instance of IAM Identity Center. For more information about tagging strategies, see Tagging AWS Resources in the AWS General Reference Guide and Tagging Best Practices. In addition to identifying, organizing, and tracking your AWS resources with tags, you can use tags in IAM policies to help control who can view and interact with your resources. To learn more about using tags to control access, see Controlling access to AWS resources using tags in the IAM User Guide. For example, you can allow a user to update an IAM Identity Center permission set, but only if the IAM Identity Center permission set has an owner tag with a value of that user's name. You can apply tags to permission sets only. You can't apply tags to the corresponding roles that IAM Identity Center creates in AWS accounts. You can use the IAM Identity Center console, AWS CLI or the IAM Identity Center APIs to add, edit, or delete tags for a permission set. The following sections provide more information about tags for IAM Identity Center. Topics • Tag restrictions • Manage tags by using the IAM Identity Center console • AWS CLI examples • Manage tags using the IAM Identity Center API 473 AWS IAM Identity Center Tag restrictions User Guide The following basic restrictions apply to tags on IAM Identity Center resources: • The maximum number of tags that you can assign to a resource is 50. • The maximum key length is 128 Unicode characters. • The maximum value length is 256 Unicode characters. • Valid characters for a tag key and value are: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ • Keys and values are case sensitive. • Don't use aws: as a preﬁx for keys; it's reserved for AWS use Manage tags by using the IAM Identity Center console You can use the IAM Identity Center console to add, edit, and remove tags that are associated with your instance or permission sets.
sso-ug-175	sso-ug.pdf	175	is 50. • The maximum key length is 128 Unicode characters. • The maximum value length is 256 Unicode characters. • Valid characters for a tag key and value are: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ • Keys and values are case sensitive. • Don't use aws: as a preﬁx for keys; it's reserved for AWS use Manage tags by using the IAM Identity Center console You can use the IAM Identity Center console to add, edit, and remove tags that are associated with your instance or permission sets. To manage permission sets tags for an IAM Identity Center console 1. Open the IAM Identity Center console. 2. Choose Permission sets. 3. Choose the name of the permission set that has the tags you want to manage. 4. On the Permissions tab, under Tags, do one of the following, and then proceed to the next step: a. b. If tags are already assigned for this permission set, choose Edit tags. If no tags are assigned to this permission set, choose Add tags. 5. For each new tag, type the values in the Key and Value (optional) columns. When you're ﬁnished, choose Save changes. To remove a tag, choose the X in the Remove column next to the tag that you want to remove. To manage tags for an instance of IAM Identity Center 1. Open the IAM Identity Center console. Tag restrictions 474 AWS IAM Identity Center 2. Choose Settings. 3. Choose the Tags tab. User Guide 4. For each tag, type the values in the Key and Value (optional) ﬁelds. When you're ﬁnished, choose the Add new tag button. To remove a tag, choose the Remove button next to the tag that you want to remove. AWS CLI examples The AWS CLI provides commands that you can use to manage the tags that you assign to your permission set. Assigning tags Use the following commands to assign tags to your permission set. Example tag-resource Command for a permission set Assign tags to a permission set by using tag-resource within the sso set of commands: $ aws sso-admin tag-resource \ > --instance-arn sso-instance-arn \ > --resource-arn sso-resource-arn \ > --tags Stage=Test This command includes the following parameters: • instance-arn – The Amazon Resource Name (ARN) of the IAM Identity Center instance under which the operation will run. • resource-arn – The ARN of the resource with the tags to be listed. • tags – The key-value pairs of the tags. To assign multiple tags at once, specify them in a comma-separated list: $ aws sso-admin tag-resource \ > --instance-arn sso-instance-arn \ > --resource-arn sso-resource-arn \ AWS CLI examples 475 AWS IAM Identity Center User Guide > --tags Stage=Test,CostCenter=80432,Owner=SysEng Viewing tags Use the following commands to view the tags that you have assigned to your permission set. Example list-tags-for-resource Command for a permission set View the tags that are assigned to a permission set by using list-tags-for-resource within the sso set of commands: $ aws sso-admin list-tags-for-resource --resource-arn sso-resource-arn Removing tags Use the following commands to remove tags from a permission set. Example untag-resource Command for a permission set Remove tags from a permission set by using untag-resource within the sso set of commands: $ aws sso-admin untag-resource \ > --instance-arn sso-instance-arn \ > --resource-arn sso-resource-arn \ > --tag-keys Stage CostCenter Owner For the --tag-keys parameter, specify one or more tag keys, and don't include the tag values. Applying tags when you create a permission set Use the following commands to assign tags at the moment you create a permission set. Example create-permission-set Command with tags When you create a permission set by using the create-permission-set command, you can specify tags with the --tags parameter: $ aws sso-admin create-permission-set \ > --instance-arn sso-instance-arn \ > --name permission=set-name \ Viewing tags 476 AWS IAM Identity Center User Guide > --tags Stage=Test,CostCenter=80432,Owner=SysEng Manage tags using the IAM Identity Center API Use the following API actions to assign, view, and remove tags for a permission set or instance of IAM Identity Center. • TagResource • ListTagsForResource • UntagResource • CreatePermissionSet • CreateInstance API actions 477 AWS IAM Identity Center User Guide Integrating AWS CLI with IAM Identity Center AWS Command Line Interface (CLI) version 2 integration with IAM Identity Center simpliﬁes the sign-in process. Developers can sign in directly to the AWS CLI using the same Active Directory or IAM Identity Center credentials that they normally use to sign in to IAM Identity Center, and access their assigned accounts and roles. For example, after an administrator conﬁgures IAM Identity Center to use Active Directory for authentication, a developer can sign into the AWS CLI directly using their Active Directory credentials. AWS CLI integration with IAM Identity Center oﬀers the following beneﬁts: • Enterprises
sso-ug-176	sso-ug.pdf	176	CLI with IAM Identity Center AWS Command Line Interface (CLI) version 2 integration with IAM Identity Center simpliﬁes the sign-in process. Developers can sign in directly to the AWS CLI using the same Active Directory or IAM Identity Center credentials that they normally use to sign in to IAM Identity Center, and access their assigned accounts and roles. For example, after an administrator conﬁgures IAM Identity Center to use Active Directory for authentication, a developer can sign into the AWS CLI directly using their Active Directory credentials. AWS CLI integration with IAM Identity Center oﬀers the following beneﬁts: • Enterprises can enable their developers to sign in using credentials from IAM Identity Center or Active Directory by connecting IAM Identity Center to their Active Directory using AWS Directory Service. • Developers can sign in from the CLI for faster access. • Developers can list and switch between accounts and roles to which they have assigned access. • Developers can generate and save named role proﬁles in their CLI conﬁguration automatically and reference them in the CLI to run commands in desired accounts and roles. • The CLI manages short-term credentials automatically so developers can start in and stay in the CLI securely without interruption, and run long running scripts. How to integrate AWS CLI with IAM Identity Center To use the AWS CLI integration with IAM Identity Center, download, install, and conﬁgure AWS Command Line Interface version 2. For detailed steps on how to download and integrate the AWS CLI with IAM Identity Center, see Conﬁguring the AWS CLI to use IAM Identity Center in the AWS Command Line Interface User Guide. How to integrate AWS CLI with IAM Identity Center 478 AWS IAM Identity Center User Guide Considerations for AWS Management Console Private Access If your organization uses the AWS Management Console Private Access feature, you should consider how your users will sign-in to IAM Identity Center. A VPC endpoint policy restricts sign-in to the management console, which prevents your users from signing in to AWS accounts they're not authorized to access. For more information, see AWS Management Console Private Access in the AWS Management Console Getting Started Guide. VPC endpoints block sign-in to the IAM Identity Center It's important to note that using VPC endpoints will block sign-in to the IAM Identity Center. This happens when a user is already logged into the management console through the VPC endpoint. To ensure your users can continue to sign-in to IAM Identity Center, they must use the public endpoint for AWS sign-in, rather than the VPC endpoint. 479 AWS IAM Identity Center User Guide Quotas and limits in IAM Identity Center The following tables describe quotas within IAM Identity Center. Quota increase requests must come from a management or delegated administrator account. To increase a quota, see Requesting a quota increase. Note We recommend using the AWS CLI and APIs to administer IAM Identity Center if you have more than 50,000 users, 10,000 groups, or 500 permission sets. For more information about the CLI, see Integrating AWS CLI with IAM Identity Center. For more information about APIs, see Welcome to the IAM Identity Center API Reference. Application quotas Resource Default quota Can be increased File size of service provider SAML certiﬁcates (in PEM 2 KB format) SAML assertion limit 50,000 characters File size limit of the IdP certiﬁcate uploaded to IAM Identity Center 2500 (UTF-8) characters Access scopes per application 25 No No No No Application quotas 480 AWS IAM Identity Center AWS account quotas User Guide Resource Default quota Can be increased Number of permission sets allowed in IAM Identity 2000 Center Number of provisioned permission sets allowed per 500 AWS account Number of inline policies per permission set 1 Number of AWS managed and customer managed policies per permission set 201 Maximum size of inline policy per permission set 32,768 bytes. Maximum size of non-white space characters in the inline policy per permission set is 10,240 bytes. Number of IAM roles (permissi on sets) in the AWS account that can be updated at a time 1 Yes Yes No No No No 1AWS Identity and Access Management (IAM) sets a quota of 10 managed policies per role. To take advantage of this quota, request an increase to the IAM quota Managed policies attached to an IAM role in the Service Quotas console for each AWS account where you want to deploy the permission set. AWS account quotas 481 AWS IAM Identity Center Note User Guide Manage AWS accounts with permission sets are provisioned in AWS accounts as IAM roles, or use existing IAM roles in AWS accounts, and therefore follow IAM quotas. For more information about quotas that are associated with IAM roles, see IAM and STS quotas. Active Directory quotas Resource Default quota Can be increased Number
sso-ug-177	sso-ug.pdf	177	take advantage of this quota, request an increase to the IAM quota Managed policies attached to an IAM role in the Service Quotas console for each AWS account where you want to deploy the permission set. AWS account quotas 481 AWS IAM Identity Center Note User Guide Manage AWS accounts with permission sets are provisioned in AWS accounts as IAM roles, or use existing IAM roles in AWS accounts, and therefore follow IAM quotas. For more information about quotas that are associated with IAM roles, see IAM and STS quotas. Active Directory quotas Resource Default quota Can be increased Number of connected directories that you can have at a time 1 No IAM Identity Center identity store quotas Resource Default quota Can be increased Number of users supported in IAM Identity Center 100000 Number of groups supported in IAM Identity Center 100000 Number of unique groups that can be used to evaluate the permissions for a user 1000 Yes No No IAM Identity Center throttle limits Resource Default quota IAM Identity Center APIs IAM Identity Center APIs have a collective throttle maximum of 20 transactions per Active Directory quotas 482 AWS IAM Identity Center Resource Identity Store APIs SCIM APIs User Guide Default quota second (TPS). You can open a support case to request an increase. The CreateAccountAssig nment has a maximum rate of 15 outstanding async calls and this limit cannot be increased. Identity Store APIs have a collective throttle maximum of 20 transactions per second (TPS). You can open a support case to request an increase. SCIM APIs have a collective throttle maximum of 20 transactions per second (TPS). You can open a support case to request an increase. Additional quotas Resource Default quota Can be increased Total number of AWS accounts or applications that 3000 can be conﬁgured * ** Total number of instances of IAM Identity Center per 1 account Total number of trusted token issuers 10 Yes No No * For example, you might conﬁgure 2750 accounts and 250 applications, resulting in a total of 3000 accounts and applications. ** TheProvisionPermissionSet API operation can provision a permission set using the option ALL_PROVISIONED_ACCOUNTS to, at most, 3500 AWS accounts. If you need to provision a permission set to more than 3500 AWS accounts, you can use the ProvisionPermissionSet Additional quotas 483 AWS IAM Identity Center User Guide API operation with the AWS_ACCOUNT option, which provisions the permission set in a single AWS account. You can make up to three concurrent calls to ProvisionPermissionSet. Additional quotas 484 AWS IAM Identity Center User Guide Troubleshooting IAM Identity Center issues The following can help you troubleshoot some common issues you might encounter while setting up or using the IAM Identity Center console. Issues creating an account instance of IAM Identity Center Several restrictions might apply when creating an account instance of IAM Identity Center. If you're unable to create an account instance through the IAM Identity Center console, or the setup experience of a supported AWS managed application, verify the following use cases: • Check other AWS Regions in the AWS account in which you are attempting to create the account instance. You are limited to one instance of IAM Identity Center per AWS account. To enable the application, either switch to the AWS Region with the instance of IAM Identity Center or switch to an account without an instance of IAM Identity Center. • If your organization enabled IAM Identity Center before September 14, 2023, your administrator might need to opt-in to account instance creation. Work with your administrator to enable account instance creation from the IAM Identity Center console in the management account. • Your administrator might have created a Service Control Policy to limit creation of account instances of IAM Identity Center. Work with your administrator add your account to the allow list. You receive an error when you attempt to view the list of cloud applications that are preconﬁgured to work with IAM Identity Center This following error occurs when you have a policy that allows sso:ListApplications but not other IAM Identity Center APIs. Update your policy to address this error. The ListApplications permission authorizes multiple APIs: • The ListApplications API. • An internal API similar to the ListApplicationProviders API used in the IAM Identity Center console. Issues creating an account instance of IAM Identity Center 485 AWS IAM Identity Center User Guide To help resolve duplication, the internal API now also authorizes using the ListApplicationProviders action. To allow the public ListApplications API but deny the internal API, your policy must include a statement denying the ListApplicationProviders action: "Statement": [ { "Effect": "Deny", "Action": "sso:ListApplicationProviders", "Resource": "" }, { "Effect": "Allow", "Action": "sso:ListApplications", "Resource": "<instanceArn>" // (or "" for all instances) } ] To allow the internal API but deny ListApplications, the policy needs to
sso-ug-178	sso-ug.pdf	178	similar to the ListApplicationProviders API used in the IAM Identity Center console. Issues creating an account instance of IAM Identity Center 485 AWS IAM Identity Center User Guide To help resolve duplication, the internal API now also authorizes using the ListApplicationProviders action. To allow the public ListApplications API but deny the internal API, your policy must include a statement denying the ListApplicationProviders action: "Statement": [ { "Effect": "Deny", "Action": "sso:ListApplicationProviders", "Resource": "" }, { "Effect": "Allow", "Action": "sso:ListApplications", "Resource": "<instanceArn>" // (or "" for all instances) } ] To allow the internal API but deny ListApplications, the policy needs to allow only ListApplicationProviders. The ListApplications API is denied if not explicitly allowed. "Statement": [ { "Effect": "Allow", "Action": "sso:ListApplicationProviders", "Resource": "*" } ] When your policies are updated, contact Support to have this proactive measure removed. Issues regarding contents of SAML assertions created by IAM Identity Center IAM Identity Center provides a web-based debug experience for the SAML assertions created and sent by IAM Identity Center, including attributes within these assertions, when accessing AWS Issues regarding contents of SAML assertions created by IAM Identity Center 486 AWS IAM Identity Center User Guide accounts and SAML applications from the AWS access portal. To see the details of a SAML assertion that IAM Identity Center generates, use the following steps. 1. Sign in to the AWS access portal. 2. While you are signed into the portal, hold the Shift key down, choose the application tile, and then release the Shift key. 3. Examine the information on the page titled You are now in administrator mode. To keep this information for future reference, choose Copy XML, and paste the contents elsewhere. 4. Choose Send to <application> to continue. This option sends the assertion to the service provider. Note Some browser conﬁgurations and operating systems may not support this procedure. This procedure has been tested on Windows 10 using Firefox, Chrome, and Edge browsers. Speciﬁc users fail to synchronize into IAM Identity Center from an external SCIM provider If your Identity Provider (IdP) is conﬁgured to provision users into IAM Identity Center using SCIM synchronization, you may encounter synchronization failures during the user provisioning process. This may indicate that the user conﬁguration in your IdP is not compatible with the IAM Identity Center requirements. When this happens, the IAM Identity Center SCIM APIs will return error messages that provide insights into the root cause of the issue. You can locate these error messages in your IdP's logs or UI. Alternatively, you may ﬁnd more detailed information about the provisioning failures in the AWS CloudTrail logs. For more information on the IAM Identity Center SCIM implementations, including the speciﬁcations of required, optional, and unsupported parameters and operations for user objects, see IAM Identity Center SCIM Implementation Developer Guide in the SCIM Developer Guide The following are a couple of common reasons for this error: 1. The user object in the IdP lacks a ﬁrst (given) name, a last (family) name, and/or a display name. Speciﬁc users fail to synchronize into IAM Identity Center from an external SCIM provider 487 AWS IAM Identity Center User Guide Error Message: "2 validation errors detected: Value at 'name.givenName' failed to satisfy constraint: Member must satisfy regular expression pattern: [\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\ \t\\n\\r ]+; Value at 'name.givenName' failed to satisfy constraint: Member must have length greater than or equal to 1" • Solution: Add a ﬁrst (given), last (family), and display name for the user object. In addition, ensure that the SCIM provisioning mappings for user objects at your IdP are conﬁgured to send nonempty values for all of these attributes. 2. More than one value for a single attribute is being sent for the user (also known as “multi- value attributes”). For example, the user may have both a work and a home phone number speciﬁed in the IdP, or multiple emails or physical addresses, and your IdP is conﬁgured to try to synchronize multiple or all values for that attribute. Error Message: "List attribute emails exceeds allowed limit of 1" • Solution options: i. Update your SCIM provisioning mappings for user objects at your IdP to send only a single value for a given attribute. For example, conﬁgure a mapping that sends only the work phone number for each user. ii. If the additional attributes can safely be removed from the user object at the IdP, you can remove the additional values, leaving either one or zero values set for that attribute for the user. iii. If the attribute is not needed for any actions in AWS, remove the mapping for that attribute from the SCIM provisioning mappings for user objects at your IdP. 3. Your IdP is trying to match users in the target (IAM Identity Center, in this case) based on multiple attributes. Since user names are guaranteed
sso-ug-179	sso-ug.pdf	179	that sends only the work phone number for each user. ii. If the additional attributes can safely be removed from the user object at the IdP, you can remove the additional values, leaving either one or zero values set for that attribute for the user. iii. If the attribute is not needed for any actions in AWS, remove the mapping for that attribute from the SCIM provisioning mappings for user objects at your IdP. 3. Your IdP is trying to match users in the target (IAM Identity Center, in this case) based on multiple attributes. Since user names are guaranteed unique within a given IAM Identity Center instance, you only need to specify username as the attribute used for matching. • Solution: Ensure that your SCIM conﬁguration in your IdP is using only a single attribute for matching with users in IAM Identity Center. For example, mapping username or userPrincipalName in the IdP to the userName attribute in SCIM for provisioning to IAM Identity Center will be correct and suﬃcient for most implementations. Speciﬁc users fail to synchronize into IAM Identity Center from an external SCIM provider 488 AWS IAM Identity Center User Guide Duplicate user or group error when provisioning users or groups with an external identity provider If you experience IAM Identity Center synchronization issues when provisioning users or groups in an external identity provider (IdP), it could be due to your external IdP users or groups not having unique attribute values. You may receive the following error messages in your external IdP: Refused to create a new, duplicate resource You can experience this problem in the following scenarios: • Scenario 1 • You're using customized non-unique attributes in your external IdP for attributes that must be unique in IAM Identity Center. Existing IAM Identity Center users or groups fail to synchronize to your IdP. • Scenario 2 • You attempt to create users that have duplicate attributes for attributes that must be unique in IAM Identity Center. • For example, you create or have an existing IAM Identity Center user with the following attributes: • Username: Jane Doe • Primary Email Address: [email protected] • Then you attempt to create another user in your external IdP with the following attributes: • Username: Richard Doe • Primary Email Address: [email protected] • The external IdP attempts to synchronize and create the user in IAM Identity Center. However, these actions fail as both users have duplicate values for a primary email address which must be unique. The username, primary email address, and externalID must be unique in order for your external IdP users to successfully synchronize to IAM Identity Center. Similarly, the group name must be unique for your external IdP groups to successfully synchronize to IAM Identity Center. The solution is to review your identity source's attributes and ensure they are unique. Duplicate user or group error when provisioning users or groups with an external identity provider 489 AWS IAM Identity Center User Guide Users can’t sign in when their user name is in UPN format Users might not be able to sign in to the AWS access portal based on the format they use to enter in their user name on the sign in page. For the most part, users can sign in to the user portal using either their plain user name, their down-level logon name (DOMAIN\UserName) or their UPN logon name ([email protected]). The exception to this is when IAM Identity Center is using a connected directory that has been enabled with MFA and the veriﬁcation mode has been set to either Context-aware or Always-on. In this scenario, users must sign in with their down-level logon name (DOMAIN\UserName). For more information, see Multi-factor authentication for Identity Center users. For general information about user name formats used to sign in to Active Directory, see User Name Formats on the Microsoft documentation website. I get a ‘Cannot perform the operation on the protected role' error when modifying an IAM role When reviewing IAM Roles in an account, you may notice role names beginning with ‘AWSReservedSSO_’. These are the roles which the IAM Identity Center service has created in the account, and they came from assigning a permission set to the account. Attempting to modify these roles from within the IAM console will result in the following error: 'Cannot perform the operation on the protected role 'AWSReservedSSO_RoleName_Here' - this role is only modifiable by AWS' These roles can only be modiﬁed from the IAM Identity Center Administrator console, which is in the management account of AWS Organizations. Once modiﬁed, you can then push the changes down to the AWS accounts that it is assigned to. Directory users cannot reset their password When a directory user resets their password using the Forgot Password? option during sign- in of the AWS access portal,
sso-ug-180	sso-ug.pdf	180	account. Attempting to modify these roles from within the IAM console will result in the following error: 'Cannot perform the operation on the protected role 'AWSReservedSSO_RoleName_Here' - this role is only modifiable by AWS' These roles can only be modiﬁed from the IAM Identity Center Administrator console, which is in the management account of AWS Organizations. Once modiﬁed, you can then push the changes down to the AWS accounts that it is assigned to. Directory users cannot reset their password When a directory user resets their password using the Forgot Password? option during sign- in of the AWS access portal, their new password must adhere to the default password policy as described in Password requirements when managing identities in IAM Identity Center. If a user enters a password that adheres to the policy and then receives the error We couldn't update your password, check to see if AWS CloudTrail recorded the failure. This can be done by searching in the Event History console of CloudTrail using the following ﬁlter: Users can’t sign in when their user name is in UPN format 490 AWS IAM Identity Center "UpdatePassword" User Guide If the message states the following, then you may need to contact support: "errorCode": "InternalFailure", "errorMessage": "An unknown error occurred“ Another possible cause of this issue is in the naming convention that was applied to the user name value. Naming conventions must follow speciﬁc patterns such as 'surname.givenName'. However, some user names can be quite long, or contain special characters, and this can cause characters to be dropped in the API call, thereby resulting in an error. You may want to attempt a password reset with a test user in the same manner to verify if this is the case. If the issue persists, contact the AWS Support Center. My user is referenced in a permission set but can’t access the assigned accounts or applications This issue can occur if you’re using System for Cross-domain Identity Management (SCIM) for Automatic Provisioning with an external identity provider. Speciﬁcally, when a user, or the group the user was a member of, is deleted then re-created using the same user name (for users) or name (for groups) in the identity provider, a new unique internal identiﬁer is created for the new user or group in IAM Identity Center. However, IAM Identity Center still has a reference to the old identiﬁer in its permission database, such that the name of the user or group still appears in the UI, but access fails. This is because the underlying user or group ID to which the UI refers no longer exists. To restore AWS account access in this case, you can remove access for the old user or group from the AWS account(s) where it was originally assigned, and then reassign access back to the user or group. This updates the permission set with the correct identiﬁer for the new user or group. Similarly, to restore application access, you can remove access for the user or group from the assigned users list for that application, then add the user or group back again. You can also check to see if AWS CloudTrail recorded the failure by searching your CloudTrail logs for SCIM synchronization events that reference the name of the user or group in question. My user is referenced in a permission set but can’t access the assigned accounts or applications 491 AWS IAM Identity Center User Guide I can't get my application from the application catalog conﬁgured correctly If you added an application from the application catalog in IAM Identity Center, be aware that each service provider provides their own detailed documentation. You can access this information from the Conﬁguration tab for the application in the IAM Identity Center console. If the problem is related to setting up the trust between the service provider's application and IAM Identity Center, make sure to check the instruction manual for troubleshooting steps. Error 'An unexpected error has occurred' when a user tries to sign in using an external identity provider This error may occur for multiple reasons, but one common reason is a mis-match between the user information carried in the SAML request, and the information for the user in IAM Identity Center. In order for an IAM Identity Center user to sign in successfully when using an external IdP as the identity source, the following must be true: • The SAML nameID format (conﬁgured at your identity provider) must be ‘email’ • The nameID value must be a properly (RFC2822)-formatted string ([email protected]) • The nameID value must exactly match the user name of an existing user in IAM Identity Center (it doesn’t matter if the email address in IAM Identity Center matches or not – the inbound match is based on username) • The IAM Identity Center implementation
sso-ug-181	sso-ug.pdf	181	in IAM Identity Center. In order for an IAM Identity Center user to sign in successfully when using an external IdP as the identity source, the following must be true: • The SAML nameID format (conﬁgured at your identity provider) must be ‘email’ • The nameID value must be a properly (RFC2822)-formatted string ([email protected]) • The nameID value must exactly match the user name of an existing user in IAM Identity Center (it doesn’t matter if the email address in IAM Identity Center matches or not – the inbound match is based on username) • The IAM Identity Center implementation of SAML 2.0 federation supports only 1 assertion in the SAML response between the identity provider and IAM Identity Center. It does not support encrypted SAML assertions. • The following statements apply if Attributes for access control is enabled in your IAM Identity Center account: • The number of attributes mapped in the SAML request must be 50 or less. • The SAML request must not contain multi-valued attributes. • The SAML request must not contain multiple attributes with the same name. • The attribute must not contain structured XML as the value. • The Name format must be a SAML speciﬁed format, not generic format. I can't get my application from the application catalog conﬁgured correctly 492 AWS IAM Identity Center Note User Guide IAM Identity Center does not perform “just in time” creation of users or groups for new users or groups via SAML federation. This means that the user must be pre-created in IAM Identity Center, either manually or via automatic provisioning, in order to sign in to IAM Identity Center. This error can also occur when the Assertion Consumer Service (ACS) endpoint conﬁgured in your identity provider does not match the ACS URL provided by your IAM Identity Center instance. Ensure that these two values match exactly. Additionally, you can troubleshoot external identity provider sign-in failures further by going to AWS CloudTrail and ﬁltering on the event name ExternalIdPDirectoryLogin. Error 'Attributes for access control failed to enable' This error may occur if the user enabling ABAC does not have the iam:UpdateAssumeRolePolicy permissions required to enable Attributes for access control. I get a 'Browser not supported' message when I attempt to register a device for MFA WebAuthn is currently supported in Google Chrome, Mozilla Firefox, Microsoft Edge and Apple Safari web browsers, as well as Windows 10 and Android platforms. Some components of WebAuthn support may be varied, such as platform authenticator support across macOS and iOS browsers. If users attempt to register WebAuthn devices on an unsupported browser or platform, they will see certain options greyed out that are not supported, or they will receive an error that all supported methods are not supported. In these cases, please refer to FIDO2: Web Authentication (WebAuthn) for more information about browser/platform support. For more information about WebAuthn in IAM Identity Center, see FIDO2 authenticators. Active Directory “Domain Users” group does not properly sync into IAM Identity Center The Active Directory Domain Users group is the default “primary group” for AD user objects. Active Directory primary groups and their memberships cannot be read by IAM Identity Center. Error 'Attributes for access control failed to enable' 493 AWS IAM Identity Center User Guide When assigning access to IAM Identity Center resources or applications, use groups other than the Domain Users group (or other groups assigned as primary groups) to have group membership properly reﬂected in the IAM Identity Center identity store. Invalid MFA credentials error This error can occur when a user attempts to sign in to IAM Identity Center using an account from an external identity provider (for example, Okta or Microsoft Entra ID) before their account is fully provisioned to IAM Identity Center using the SCIM protocol. After the user account is provisioned to IAM Identity Center, this issue should be resolved. Conﬁrm that the account has been provisioned to IAM Identity Center. If not, check the provisioning logs in the external identity provider. I get a 'An unexpected error has occurred' message when I attempt to register or sign in using an authenticator app Time-based one-time password (TOTP) systems, such as those used by IAM Identity Center in combination with code-based authenticator apps, rely on time synchronization between the client and the server. Ensure that the device where your authenticator app is installed is correctly synchronized to a reliable time source, or manually set the time on your device to match a reliable source, such as NIST (https://www.time.gov/) or other local/regional equivalents. I get an 'It's not you, it's us' error when attempting to sign in to IAM Identity Center This error indicates there is a setup problem with your instance of IAM Identity Center or the external identity provider (IdP) IAM Identity Center is using as
sso-ug-182	sso-ug.pdf	182	in combination with code-based authenticator apps, rely on time synchronization between the client and the server. Ensure that the device where your authenticator app is installed is correctly synchronized to a reliable time source, or manually set the time on your device to match a reliable source, such as NIST (https://www.time.gov/) or other local/regional equivalents. I get an 'It's not you, it's us' error when attempting to sign in to IAM Identity Center This error indicates there is a setup problem with your instance of IAM Identity Center or the external identity provider (IdP) IAM Identity Center is using as its identity source. We recommend you verify the following: • Verify the date and time settings on the device you're using to sign in. We recommend that you set the date and time to be set automatically. If that is not available, we recommend syncing your date and time to a known Network Time Protocol (NTP) server. • Verify that the IdP certiﬁcate uploaded to IAM Identity Center is the same as what was provided by your IdP. You can check the certiﬁcate from the IAM Identity Center console by navigating to Settings. In the Identity Source tab choose Action and then choose Manage Authentication. If the IdP and IAM Identity Center certiﬁcates do not match, import a new certiﬁcate to IAM Identity Center. Invalid MFA credentials error 494 AWS IAM Identity Center User Guide • Ensure the NameID format in your identity provider's metadata ﬁle is the following: • urn:oasis:name:tc:SAML:1.1:nameid-format:emailAddress • If you are using AD Connector from AWS Directory Service as your identity provider, verify that the credentials for the service account are correct and have not expired. See Update your AD Connector service account credentials in AWS Directory Service for more information. My users are not receiving emails from IAM Identity Center All emails sent by the IAM Identity Center service will come from either the address no- [email protected] or [email protected]. Your mail system must be conﬁgured so that it accepts emails from these sender email addresses and doesn't handle them as junk or spam. Error: You can't delete/modify/remove/assign access to permission sets provisioned in the management account This message indicates that the Delegated administration feature has been enabled and that the operation you previously attempted can only be successfully performed by someone who has management account permissions in AWS Organizations. To resolve this issue, sign in as a user who has these permissions and try performing the task again or assign this task to someone who has the correct permissions. For more information, see Register a member account. Error: Session token not found or invalid This error can occur when a client, such as a web browser, AWS Toolkit, or AWS CLI, tries to use a session that's revoked or invalidated on the server side. To correct this issue, return to the client application or website and try again, including logging in again if prompted. This might sometimes require you to also cancel pending requests, such as a pending connection attempt from the AWS Toolkit within your IDE. My users are not receiving emails from IAM Identity Center 495 AWS IAM Identity Center User Guide Document history The following table describes important additions to the AWS IAM Identity Center documentation. We also update the documentation frequently to address the feedback that you send us. • Latest major documentation update: September 23, 2022 Change Description Date Depreciate IAM Identity Center AD Sync April 17, 2025 You can no longer provision Active Directory users with IAM Identity Center AD Sync. Instead, you can use IAM Identity Center conﬁgurable AD Sync. Update to Authenticated session Update to IAM Identity Center session durations when user April 2, 2025 session is deleted. Updates for AWS managed policy Updated permissions for the February 11, 2025 AWSSSOServiceRoleP olicy AWS managed policy. IAM Identity Center enablement workﬂow improved Updates for IAM Identity Center enablement February 11, 2025 October 10, 2024 Updated workﬂow for enabling organization and account instances of IAM Identity Center. Updated contents and procedures for enabling organization and account instances of IAM Identity Center. Updates for AWS managed policy Updated permissions for the October 2, 2024 AWSIAMIdentityCent 496 AWS IAM Identity Center User Guide Updates for AWS managed policy Updates for AWS managed policy erAllowListForIden tityContext AWS managed policy. Updated permissions for the September 26, 2024 AWSSSOMasterAccoun tAdministrator AWS managed policy. Updated permissions for the September 4, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updates to the "What is IAM Identity Center?" topic Updated the content that describes the beneﬁts and August 19, 2024 Updates for AWS managed policy Updates for AWS managed policy Updates for AWS managed policy capabilities of IAM Identity Center. Updated permissions for the July 12, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the June
sso-ug-183	sso-ug.pdf	183	User Guide Updates for AWS managed policy Updates for AWS managed policy erAllowListForIden tityContext AWS managed policy. Updated permissions for the September 26, 2024 AWSSSOMasterAccoun tAdministrator AWS managed policy. Updated permissions for the September 4, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updates to the "What is IAM Identity Center?" topic Updated the content that describes the beneﬁts and August 19, 2024 Updates for AWS managed policy Updates for AWS managed policy Updates for AWS managed policy capabilities of IAM Identity Center. Updated permissions for the July 12, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the June 27, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the May 17, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. 497 AWS IAM Identity Center User Guide Updates for AWS managed policy Updates for AWS managed policy Updates for AWS managed policy Updated permissions for the April 30, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the April 26, 2024 AWSSSOMasterAccoun tAdministrator AWS managed policy. Updated permissions for the April 26, 2024 AWSSSOMemberAccoun tAdministrator AWS managed policy. Updates for AWS managed policy Updated permissions for the April 26, 2024 AWSSSOReadOnly AWS managed policy. Updates for AWS managed policy Updates for AWS managed policy Updates for AWS managed policy Updated permissions for the April 26, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the April 24, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the April 19, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. 498 AWS IAM Identity Center User Guide Updates for AWS managed policy Updates for AWS managed policy New AWS managed policy topic Updated permissions for the April 11, 2024 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Updated permissions for the November 26, 2023 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Added details for the November 15, 2023 AWSIAMIdentityCent erAllowListForIden tityContext AWS managed policy. Enhanced guidance for getting started with IAM Added new content for getting started with IAM Identity Center Identity Center and creating an administrative user September 23, 2022 Updated users and groups in the Identity Center API This update includes references to the new Create, August 31, 2022 Reference Update and Delete APIs in the Identity Center API Reference Guide. 499 AWS IAM Identity Center User Guide AWS Single Sign-On (AWS SSO) renamed to AWS IAM AWS introduces AWS IAM Identity Center. IAM Identity July 26, 2022 Identity Center Center expands the capabilit ies of AWS Identity and Access Management (IAM) to help you centrally manage account and access to applications for your workforce users. IAM Identity Center features include application assignmen ts, multi-account permissions, and an AWS access portal. Support for permissions boundaries and customer Added content for using AWS managed and customer July 14, 2022 managed policies in permissio managed AWS Identity and n sets Access Management (IAM) policies with permission sets. Support for manually enabled AWS Regions Added content for using IAM Identity Center in manually June 15, 2022 Updates for AWS managed policies Support for delegated administration enabled Regions. Updated permissions for the May 11, 2022 AWSSSOServiceRoleP olicy AWS managed policy. Added content for the delegated administration feature. May 11, 2022 500 AWS IAM Identity Center User Guide Updates for AWS managed policies Updated permissions for the April 28, 2022 AWSSSOMasterAccoun tAdministrator , AWSSSOMemberAccoun tAdministrator , and AWSSSOReadOnly AWS managed policies. Support for conﬁgurable AD sync Added content for the conﬁgurable AD sync feature. April 14, 2022 New AWS managed policy topic Added details for the August 4, 2021 AWSSSOMasterAccoun tAdministrator AWS managed policy. Updates for quotas Adjustments to quota tables. December 21, 2020 New example policies Added new customer managed policy examples and updates to the permissions required section. December 21, 2020 Support for attribute-based access control (ABAC) Added content for ABAC feature. November 24, 2020 Support for MFA forced enrollment Updates to require users to enroll an MFA device at sign- November 23, 2020 in. Support for WebAuthn Added content for new WebAuthn feature. November 20, 2020 Support for Ping Identity Added content to integrate with Ping Identity products as a supported external identity provider. October 26, 2020 501 AWS IAM Identity Center Support for OneLogin Support for Okta Added content to integrate with OneLogin as a supported external identity provider. July 31, 2020 Added content to integrate with Okta as a supported external identity provider. May 28, 2020 User Guide Support for external identity providers Changed references from directory to identity source, November 26, 2019 New MFA settings added content to support external identity providers. Removed two-step veriﬁcat ion topic and added new MFA topic in its place. October 24, 2019 New setting to add two-step veriﬁcation Added content on how to enable two-step veriﬁcation January 16, 2019 for users. Support for session duration on AWS accounts Added content on how to set
sso-ug-184	sso-ug.pdf	184	OneLogin as a supported external identity provider. July 31, 2020 Added content to integrate with Okta as a supported external identity provider. May 28, 2020 User Guide Support for external identity providers Changed references from directory to identity source, November 26, 2019 New MFA settings added content to support external identity providers. Removed two-step veriﬁcat ion topic and added new MFA topic in its place. October 24, 2019 New setting to add two-step veriﬁcation Added content on how to enable two-step veriﬁcation January 16, 2019 for users. Support for session duration on AWS accounts Added content on how to set the session duration for an October 30, 2018 AWS account. New option to use Identity Center directory Added content for choosing either Identity Center October 17, 2018 directory or connecting to an existing directory in Active Directory. Support for relay state and session duration on applicati ons Added content about relay state and session duration for applications. October 10, 2018 502 AWS IAM Identity Center User Guide Additional support for new applications Added 4me, BambooHR, Bonusly, Citrix ShareFile, August 3, 2018 ClickTime, Convo, Deputy, Deskpro, Dome9, DruvaInSy nc, Egnyte, Engagedly , Expensify, Freshdesk , IdeaScale, Igloo, Jitbit, Kudos, LiquidFiles, Lucidchar t, PurelyHR, Samanage, ScreenSteps, Sli.do, SmartSheet, Syncplicity, TalentLMS, Trello, UserVoice , Zoho, OpsGenie, DigiCert, WeekDone, ProdPad, and UserEcho to the application catalog. Support for multi-account access to management Added content about how to delegate multi-account access July 9, 2018 accounts to users in a management Support for new applications Get temporary credentials for CLI access New guide account. Added DocuSign, Keeper Security, and SugarCRM to the application catalog. Added information about how to get temporary credentials to run AWS CLI commands. This is the ﬁrst release of the IAM Identity Center User Guide. March 16, 2018 February 22, 2018 December 7, 2017 503 AWS IAM Identity Center User Guide AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. 504
ssooidc-api-001	ssooidc-api.pdf	1	OIDC API Reference AWS IAM Identity Center API Version 2019-06-10 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS IAM Identity Center OIDC API Reference AWS IAM Identity Center: OIDC API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS IAM Identity Center Table of Contents OIDC API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateToken ................................................................................................................................................... 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 5 Response Elements ................................................................................................................................. 6 Errors .......................................................................................................................................................... 7 See Also ..................................................................................................................................................... 8 CreateTokenWithIAM ................................................................................................................................. 10 Request Syntax ...................................................................................................................................... 10 URI Request Parameters ...................................................................................................................... 10 Request Body ......................................................................................................................................... 10 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 15 See Also .................................................................................................................................................. 17 RegisterClient .............................................................................................................................................. 18 Request Syntax ...................................................................................................................................... 18 URI Request Parameters ...................................................................................................................... 18 Request Body ......................................................................................................................................... 18 Response Syntax ................................................................................................................................... 20 Response Elements ............................................................................................................................... 20 Errors ....................................................................................................................................................... 21 See Also .................................................................................................................................................. 22 StartDeviceAuthorization .......................................................................................................................... 23 Request Syntax ...................................................................................................................................... 23 URI Request Parameters ...................................................................................................................... 23 Request Body ......................................................................................................................................... 23 Response Syntax ................................................................................................................................... 24 Response Elements ............................................................................................................................... 24 Errors ....................................................................................................................................................... 25 See Also .................................................................................................................................................. 26 API Version 2019-06-10 iii AWS IAM Identity Center OIDC API Reference Data Types ..................................................................................................................................... 27 AwsAdditionalDetails ................................................................................................................................. 28 Contents .................................................................................................................................................. 28 See Also .................................................................................................................................................. 28 Common Parameters ..................................................................................................................... 29 Common Errors .............................................................................................................................. 32 API Version 2019-06-10 iv AWS IAM Identity Center Welcome OIDC API Reference AWS IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center. API namespaces IAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center OpenID Connect uses the sso-oidc namespace. Considerations for using this guide Before you begin using this guide, we recommend that you ﬁrst review the following important information about how the IAM Identity Center OIDC service works. • The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single sign-on authentication with the AWS CLI. • With older versions of the AWS CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC ﬂow that supports token refresh and doesn’t require re-authentication, update to the latest AWS CLI version (1.27.10 for AWS CLI V1 and 2.9.0 for AWS CLI V2) with support for OIDC token refresh and conﬁgurable IAM Identity Center session durations. For more information, see Conﬁgure AWS access portal session duration . • The access tokens provided by this service grant access to all AWS account entitlements assigned to an IAM Identity Center user, not just a particular application. • The documentation in this guide does not describe the mechanism to convert the access token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference Guide. For general information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide. This document was last published on May 21, 2025. API Version 2019-06-10 1 OIDC API Reference AWS IAM Identity Center Actions The following actions are supported: • CreateToken • CreateTokenWithIAM • RegisterClient • StartDeviceAuthorization API Version 2019-06-10 2 AWS IAM Identity Center CreateToken OIDC API Reference Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication. Request Syntax POST /token HTTP/1.1 Content-type: application/json { "clientId": "string", "clientSecret": "string", "code": "string", "codeVerifier": "string", "deviceCode": "string", "grantType": "string", "redirectUri": "string", "refreshToken": "string", "scope": [ "string" ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientId The unique identiﬁer string for the client or application. This value comes from the result of the RegisterClient API. Type: String Required: Yes CreateToken API Version 2019-06-10 3 AWS IAM Identity Center clientSecret OIDC API Reference A secret string generated for the client. This value should come from the persisted result of the RegisterClient API. Type: String Required:
ssooidc-api-002	ssooidc-api.pdf	2	"clientSecret": "string", "code": "string", "codeVerifier": "string", "deviceCode": "string", "grantType": "string", "redirectUri": "string", "refreshToken": "string", "scope": [ "string" ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientId The unique identiﬁer string for the client or application. This value comes from the result of the RegisterClient API. Type: String Required: Yes CreateToken API Version 2019-06-10 3 AWS IAM Identity Center clientSecret OIDC API Reference A secret string generated for the client. This value should come from the persisted result of the RegisterClient API. Type: String Required: Yes code Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request. Type: String Required: No codeVeriﬁer Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time. Type: String Required: No deviceCode Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API. Type: String Required: No grantType Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want: * Authorization Code - authorization_code * Device Code - urn:ietf:params:oauth:grant-type:device_code Request Body API Version 2019-06-10 4 AWS IAM Identity Center OIDC API Reference * Refresh Token - refresh_token Type: String Required: Yes redirectUri Used only when calling this API for the Authorization Code grant type. This value speciﬁes the location of the client or application that has registered to receive the authorization code. Type: String Required: No refreshToken Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference. Type: String Required: No scope The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not speciﬁed, IAM Identity Center authorizes all scopes that are conﬁgured for the client during the call to RegisterClient. Type: Array of strings Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { Response Syntax API Version 2019-06-10 5 AWS IAM Identity Center OIDC API Reference "accessToken": "string", "expiresIn": number, "idToken": "string", "refreshToken": "string", "tokenType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accessToken A bearer token to access AWS accounts and applications assigned to a user. Type: String expiresIn Indicates the time in seconds when an access token will expire. Type: Integer idToken The idToken is not implemented or supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference. A JSON Web Token (JWT) that identiﬁes who is associated with the issued access token. Type: String refreshToken A token that, if present, can be used to refresh a previously issued access token that might have expired. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference. Type: String Response Elements API Version 2019-06-10 6 AWS IAM Identity Center tokenType OIDC API Reference Used to notify the client that the returned token is an access token. The supported token type is Bearer. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 AuthorizationPendingException Indicates that a request to authorize a client with an access user session token is pending. HTTP Status Code: 400 ExpiredTokenException Indicates that the token issued by the service is expired and is no longer valid. HTTP Status Code: 400 InternalServerException Indicates that an error from the service occurred while trying to process a request. HTTP Status Code: 500 InvalidClientException Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret. HTTP Status Code: 401 InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type. Errors API Version 2019-06-10 7 AWS IAM Identity Center HTTP Status
ssooidc-api-003	ssooidc-api.pdf	3	by the service is expired and is no longer valid. HTTP Status Code: 400 InternalServerException Indicates that an error from the service occurred while trying to process a request. HTTP Status Code: 500 InvalidClientException Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret. HTTP Status Code: 401 InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type. Errors API Version 2019-06-10 7 AWS IAM Identity Center HTTP Status Code: 400 InvalidRequestException OIDC API Reference Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 InvalidScopeException Indicates that the scope provided in the request is invalid. HTTP Status Code: 400 SlowDownException Indicates that the client is making the request too frequently and is more than the service can handle. HTTP Status Code: 400 UnauthorizedClientException Indicates that the client is not currently authorized to make the request. This can happen when a clientId is not issued for a public client. HTTP Status Code: 400 UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2019-06-10 8 AWS IAM Identity Center • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 OIDC API Reference See Also API Version 2019-06-10 9 AWS IAM Identity Center OIDC API Reference CreateTokenWithIAM Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. An IAM entity can be any IAM entity like a service role or user. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication. Note This API is used with Signature Version 4. For more information, see AWS Signature Version 4 for API Requests. Request Syntax POST /token?aws_iam=t HTTP/1.1 Content-type: application/json { "assertion": "string", "clientId": "string", "code": "string", "codeVerifier": "string", "grantType": "string", "redirectUri": "string", "refreshToken": "string", "requestedTokenType": "string", "scope": [ "string" ], "subjectToken": "string", "subjectTokenType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. CreateTokenWithIAM API Version 2019-06-10 10 AWS IAM Identity Center assertion OIDC API Reference Used only when calling this API for the JWT Bearer grant type. This value speciﬁes the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, conﬁgure the JWT Bearer GrantOptions for the application. Type: String Required: No clientId The unique identiﬁer string for the client or application. This value is an application ARN that has OAuth grants conﬁgured. Type: String Required: Yes code Used only when calling this API for the Authorization Code grant type. This short-lived code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application. Type: String Required: No codeVeriﬁer Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time. Type: String Required: No grantType Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want: Request Body API Version 2019-06-10 11 AWS IAM Identity Center OIDC API Reference * Authorization Code - authorization_code * Refresh Token - refresh_token * JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer * Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange Type: String Required: Yes redirectUri Used only when calling this API for the Authorization Code grant type. This value speciﬁes the location of the client or application that has registered to receive the authorization code. Type: String Required: No refreshToken Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference. Type: String Required: No requestedTokenType Used only when calling this API for the Token Exchange grant type.
ssooidc-api-004	ssooidc-api.pdf	4	grant type. This value speciﬁes the location of the client or application that has registered to receive the authorization code. Type: String Required: No refreshToken Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference. Type: String Required: No requestedTokenType Used only when calling this API for the Token Exchange grant type. This value speciﬁes the type of token that the requester can receive. The following values are supported: * Access Token - urn:ietf:params:oauth:token-type:access_token * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token Type: String Request Body API Version 2019-06-10 12 AWS IAM Identity Center Required: No scope OIDC API Reference The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If the value is not speciﬁed, IAM Identity Center authorizes all scopes conﬁgured for the application, including the following default scopes: openid, aws, sts:identity_context. Type: Array of strings Required: No subjectToken Used only when calling this API for the Token Exchange grant type. This value speciﬁes the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a diﬀerent client or application. The access token must have authorized scopes that indicate the requested application as a target audience. Type: String Required: No subjectTokenType Used only when calling this API for the Token Exchange grant type. This value speciﬁes the type of token that is passed as the subject of the exchange. The following value is supported: * Access Token - urn:ietf:params:oauth:token-type:access_token Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "accessToken": "string", "awsAdditionalDetails": { Response Syntax API Version 2019-06-10 13 AWS IAM Identity Center OIDC API Reference "identityContext": "string" }, "expiresIn": number, "idToken": "string", "issuedTokenType": "string", "refreshToken": "string", "scope": [ "string" ], "tokenType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accessToken A bearer token to access AWS accounts and applications assigned to a user. Type: String awsAdditionalDetails A structure containing information from AWS IAM Identity Center managed user and group information. Type: AwsAdditionalDetails object expiresIn Indicates the time in seconds when an access token will expire. Type: Integer idToken A JSON Web Token (JWT) that identiﬁes the user associated with the issued access token. Type: String issuedTokenType Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported: Response Elements API Version 2019-06-10 14 AWS IAM Identity Center OIDC API Reference * Access Token - urn:ietf:params:oauth:token-type:access_token * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token Type: String refreshToken A token that, if present, can be used to refresh a previously issued access token that might have expired. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference. Type: String scope The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted. Type: Array of strings tokenType Used to notify the requester that the returned token is an access token. The supported token type is Bearer. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 AuthorizationPendingException Indicates that a request to authorize a client with an access user session token is pending. Errors API Version 2019-06-10 15 AWS IAM Identity Center HTTP Status Code: 400 ExpiredTokenException OIDC API Reference Indicates that the token issued by the service is expired and is no longer valid. HTTP Status Code: 400 InternalServerException Indicates that an error from the service occurred while trying to process a request. HTTP Status Code: 500 InvalidClientException Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret. HTTP Status Code: 401 InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type. HTTP Status Code: 400 InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 InvalidRequestRegionException Indicates that a token provided as input to the request was issued by and is only usable by calling IAM Identity Center endpoints in another region.
ssooidc-api-005	ssooidc-api.pdf	5	can occur when a client sends an incorrect clientId or an expired clientSecret. HTTP Status Code: 401 InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type. HTTP Status Code: 400 InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 InvalidRequestRegionException Indicates that a token provided as input to the request was issued by and is only usable by calling IAM Identity Center endpoints in another region. HTTP Status Code: 400 InvalidScopeException Indicates that the scope provided in the request is invalid. HTTP Status Code: 400 Errors API Version 2019-06-10 16 AWS IAM Identity Center SlowDownException OIDC API Reference Indicates that the client is making the request too frequently and is more than the service can handle. HTTP Status Code: 400 UnauthorizedClientException Indicates that the client is not currently authorized to make the request. This can happen when a clientId is not issued for a public client. HTTP Status Code: 400 UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-06-10 17 AWS IAM Identity Center RegisterClient OIDC API Reference Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant. Request Syntax POST /client/register HTTP/1.1 Content-type: application/json { "clientName": "string", "clientType": "string", "entitledApplicationArn": "string", "grantTypes": [ "string" ], "issuerUrl": "string", "redirectUris": [ "string" ], "scopes": [ "string" ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientName The friendly name of the client. Type: String Required: Yes clientType The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service. Type: String RegisterClient API Version 2019-06-10 18 AWS IAM Identity Center Required: Yes entitledApplicationArn OIDC API Reference This IAM Identity Center application ARN is used to deﬁne administrator-managed conﬁguration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource. Type: String Required: No grantTypes The list of OAuth 2.0 grant types that are deﬁned by the client. This list is used to restrict the token granting ﬂows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token. * Authorization Code - authorization_code * Device Code - urn:ietf:params:oauth:grant-type:device_code * Refresh Token - refresh_token Type: Array of strings Required: No issuerUrl The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client. Type: String Required: No redirectUris The list of redirect URI that are deﬁned by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to. Type: Array of strings Required: No Request Body API Version 2019-06-10 19 AWS IAM Identity Center scopes OIDC API Reference The list of scopes that are deﬁned by the client. Upon authorization, this list is used to restrict permissions when granting an access token. Type: Array of strings Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "authorizationEndpoint": "string", "clientId": "string", "clientIdIssuedAt": number, "clientSecret": "string", "clientSecretExpiresAt": number, "tokenEndpoint": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. authorizationEndpoint An endpoint that the client can use to request authorization. Type: String clientId The unique identiﬁer string for each client. This client uses this identiﬁer to get authenticated by the service in subsequent calls. Type: String Response Syntax API Version 2019-06-10 20 AWS IAM Identity Center clientIdIssuedAt OIDC API Reference Indicates the time at which the clientId and clientSecret were issued. Type: Long clientSecret A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls. Type: String clientSecretExpiresAt Indicates the time at which the clientId and clientSecret will become invalid. Type: Long tokenEndpoint An endpoint that the client can use
ssooidc-api-006	ssooidc-api.pdf	6	String clientId The unique identiﬁer string for each client. This client uses this identiﬁer to get authenticated by the service in subsequent calls. Type: String Response Syntax API Version 2019-06-10 20 AWS IAM Identity Center clientIdIssuedAt OIDC API Reference Indicates the time at which the clientId and clientSecret were issued. Type: Long clientSecret A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls. Type: String clientSecretExpiresAt Indicates the time at which the clientId and clientSecret will become invalid. Type: Long tokenEndpoint An endpoint that the client can use to create tokens. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException Indicates that an error from the service occurred while trying to process a request. HTTP Status Code: 500 InvalidClientMetadataException Indicates that the client information sent in the request during registration is invalid. HTTP Status Code: 400 InvalidRedirectUriException Indicates that one or more redirect URI in the request is not supported for this operation. HTTP Status Code: 400 Errors API Version 2019-06-10 21 AWS IAM Identity Center InvalidRequestException OIDC API Reference Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 InvalidScopeException Indicates that the scope provided in the request is invalid. HTTP Status Code: 400 UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-06-10 22 AWS IAM Identity Center OIDC API Reference StartDeviceAuthorization Initiates device authorization by requesting a pair of veriﬁcation codes from the authorization service. Request Syntax POST /device_authorization HTTP/1.1 Content-type: application/json { "clientId": "string", "clientSecret": "string", "startUrl": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientId The unique identiﬁer string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation. Type: String Required: Yes clientSecret A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation. Type: String Required: Yes StartDeviceAuthorization API Version 2019-06-10 23 AWS IAM Identity Center startUrl OIDC API Reference The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide. Type: String Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "deviceCode": "string", "expiresIn": number, "interval": number, "userCode": "string", "verificationUri": "string", "verificationUriComplete": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. deviceCode The short-lived code that is used by the device when polling for a session token. Type: String expiresIn Indicates the number of seconds in which the veriﬁcation code will become invalid. Type: Integer Response Syntax API Version 2019-06-10 24 AWS IAM Identity Center interval OIDC API Reference Indicates the number of seconds the client must wait between attempts when polling for a session. Type: Integer userCode A one-time user veriﬁcation code. This is needed to authorize an in-use device. Type: String veriﬁcationUri The URI of the veriﬁcation page that takes the userCode to authorize the device. Type: String veriﬁcationUriComplete An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the veriﬁcation page and enters their code. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException Indicates that an error from the service occurred while trying to process a request. HTTP Status Code: 500 InvalidClientException Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret. HTTP Status Code: 401 InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range. Errors API Version 2019-06-10 25 AWS IAM Identity Center HTTP Status Code: 400 SlowDownException OIDC API Reference Indicates that the client is making the request too frequently and is more than the service can handle. HTTP Status Code: 400 UnauthorizedClientException Indicates
ssooidc-api-007	ssooidc-api.pdf	7	Status Code: 500 InvalidClientException Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret. HTTP Status Code: 401 InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range. Errors API Version 2019-06-10 25 AWS IAM Identity Center HTTP Status Code: 400 SlowDownException OIDC API Reference Indicates that the client is making the request too frequently and is more than the service can handle. HTTP Status Code: 400 UnauthorizedClientException Indicates that the client is not currently authorized to make the request. This can happen when a clientId is not issued for a public client. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-06-10 26 AWS IAM Identity Center Data Types OIDC API Reference The AWS IAM Identity Center API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AwsAdditionalDetails API Version 2019-06-10 27 AWS IAM Identity Center OIDC API Reference AwsAdditionalDetails This structure contains AWS-speciﬁc parameter extensions and the identity context. Contents identityContext The trusted context assertion is signed and encrypted by AWS STS. It provides access to sts:identity_context claim in the idToken without JWT parsing Identity context comprises information that AWS services use to make authorization decisions when they receive requests. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AwsAdditionalDetails API Version 2019-06-10 28 AWS IAM Identity Center OIDC API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2019-06-10 29 AWS IAM Identity Center OIDC API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2019-06-10 30 AWS IAM Identity Center
ssooidc-api-008	ssooidc-api.pdf	8	a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2019-06-10 30 AWS IAM Identity Center Type: string Required: Conditional X-Amz-SignedHeaders OIDC API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2019-06-10 31 AWS IAM Identity Center OIDC API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2019-06-10 32 AWS IAM Identity Center HTTP Status Code: 403 RequestAbortedException OIDC API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2019-06-10 33 AWS IAM Identity Center UnknownOperationException OIDC API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2019-06-10 34
ssoportal-api-001	ssoportal-api.pdf	1	Portal API Reference AWS IAM Identity Center API Version 2019-06-10 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS IAM Identity Center Portal API Reference AWS IAM Identity Center: Portal API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS IAM Identity Center Table of Contents Portal API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 GetRoleCredentials ....................................................................................................................................... 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 3 Response Elements ................................................................................................................................. 4 Errors .......................................................................................................................................................... 4 See Also ..................................................................................................................................................... 5 ListAccountRoles ........................................................................................................................................... 6 Request Syntax ........................................................................................................................................ 6 URI Request Parameters ........................................................................................................................ 6 Request Body ........................................................................................................................................... 6 Response Syntax ...................................................................................................................................... 7 Response Elements ................................................................................................................................. 7 Errors .......................................................................................................................................................... 7 See Also ..................................................................................................................................................... 8 ListAccounts ................................................................................................................................................... 9 Request Syntax ........................................................................................................................................ 9 URI Request Parameters ........................................................................................................................ 9 Request Body ........................................................................................................................................... 9 Response Syntax ...................................................................................................................................... 9 Response Elements ............................................................................................................................... 10 Errors ....................................................................................................................................................... 10 See Also .................................................................................................................................................. 11 Logout ........................................................................................................................................................... 12 Request Syntax ...................................................................................................................................... 12 URI Request Parameters ...................................................................................................................... 12 Request Body ......................................................................................................................................... 12 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 13 See Also .................................................................................................................................................. 13 API Version 2019-06-10 iii AWS IAM Identity Center Portal API Reference Data Types ..................................................................................................................................... 15 AccountInfo .................................................................................................................................................. 16 Contents .................................................................................................................................................. 16 See Also .................................................................................................................................................. 16 RoleCredentials ........................................................................................................................................... 17 Contents .................................................................................................................................................. 17 See Also .................................................................................................................................................. 18 RoleInfo ........................................................................................................................................................ 19 Contents .................................................................................................................................................. 19 See Also .................................................................................................................................................. 19 Common Parameters ..................................................................................................................... 20 Common Errors .............................................................................................................................. 23 API Version 2019-06-10 iv AWS IAM Identity Center Welcome Portal API Reference AWS IAM Identity Center Portal is a web service that you can use to assign your users access to IAM Identity Center resources such as the AWS access portal. The AWS access portal provides your users with single sign-on access to their assigned AWS accounts and applications. For information about how to assign your users access to AWS accounts and applications, see the IAM Identity Center User Guide. Note IAM Identity Center uses the sso and identitystore API namespaces. This reference guide describes the AWS access portal operations that you can call programatically, and it includes detailed information about data types and errors. Note AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to programmatically access IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services. This document was last published on May 21, 2025. API Version 2019-06-10 1 Portal API Reference AWS IAM Identity Center Actions The following actions are supported: • GetRoleCredentials • ListAccountRoles • ListAccounts • Logout API Version 2019-06-10 2 AWS IAM Identity Center Portal API Reference GetRoleCredentials Returns the STS short-term credentials for a given role name that is assigned to the user. Request Syntax GET /federation/credentials?account_id=accountId&role_name=roleName HTTP/1.1 x-amz-sso_bearer_token: accessToken URI Request Parameters The request uses the following URI parameters. accessToken The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide. Required: Yes accountId The identiﬁer for the AWS account that is assigned to the user. Required: Yes roleName The friendly name of the role that is assigned to the user. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { GetRoleCredentials API Version 2019-06-10 3 AWS IAM Identity Center Portal API Reference "roleCredentials": { "accessKeyId": "string", "expiration": number, "secretAccessKey": "string", "sessionToken": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. roleCredentials The credentials for the role that is assigned to the user. Type: RoleCredentials object Errors For information about the errors that are common to all actions, see Common Errors. InvalidRequestException Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 ResourceNotFoundException The speciﬁed resource doesn't exist. HTTP Status Code: 404 TooManyRequestsException Indicates that the request is being made too frequently and is more than what the server can handle. HTTP Status Code: 429 Response Elements API Version 2019-06-10 4 AWS IAM Identity Center UnauthorizedException Portal API Reference Indicates that the request is not authorized.
ssoportal-api-002	ssoportal-api.pdf	2	Type: RoleCredentials object Errors For information about the errors that are common to all actions, see Common Errors. InvalidRequestException Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 ResourceNotFoundException The speciﬁed resource doesn't exist. HTTP Status Code: 404 TooManyRequestsException Indicates that the request is being made too frequently and is more than what the server can handle. HTTP Status Code: 429 Response Elements API Version 2019-06-10 4 AWS IAM Identity Center UnauthorizedException Portal API Reference Indicates that the request is not authorized. This can happen due to an invalid access token in the request. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-06-10 5 AWS IAM Identity Center ListAccountRoles Portal API Reference Lists all roles that are assigned to the user for a given AWS account. Request Syntax GET /assignment/roles?account_id=accountId&max_result=maxResults&next_token=nextToken HTTP/1.1 x-amz-sso_bearer_token: accessToken URI Request Parameters The request uses the following URI parameters. accessToken The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide. Required: Yes accountId The identiﬁer for the AWS account that is assigned to the user. Required: Yes maxResults The number of items that clients can request per page. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The page token from the previous response output when you request subsequent pages. Request Body The request does not have a request body. ListAccountRoles API Version 2019-06-10 6 Portal API Reference AWS IAM Identity Center Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "roleList": [ { "accountId": "string", "roleName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The page token client that is used to retrieve the list of accounts. Type: String roleList A paginated response with the list of roles and the next token if more results are available. Type: Array of RoleInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidRequestException Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range. Response Syntax API Version 2019-06-10 7 AWS IAM Identity Center HTTP Status Code: 400 ResourceNotFoundException The speciﬁed resource doesn't exist. HTTP Status Code: 404 TooManyRequestsException Portal API Reference Indicates that the request is being made too frequently and is more than what the server can handle. HTTP Status Code: 429 UnauthorizedException Indicates that the request is not authorized. This can happen due to an invalid access token in the request. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-06-10 8 AWS IAM Identity Center ListAccounts Portal API Reference Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the IAM Identity Center User Guide. This operation returns a paginated response. Request Syntax GET /assignment/accounts?max_result=maxResults&next_token=nextToken HTTP/1.1 x-amz-sso_bearer_token: accessToken URI Request Parameters The request uses the following URI parameters. accessToken The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide. Required: Yes maxResults This is the number of items clients can request per page. Valid Range: Minimum value of 1. Maximum value of 100. nextToken (Optional) When requesting subsequent pages, this is the page token from the previous response output. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListAccounts API Version 2019-06-10 9 AWS IAM Identity Center Portal API Reference Content-type: application/json { "accountList": [ { "accountId": "string", "accountName": "string", "emailAddress": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in
ssoportal-api-003	ssoportal-api.pdf	3	is the number of items clients can request per page. Valid Range: Minimum value of 1. Maximum value of 100. nextToken (Optional) When requesting subsequent pages, this is the page token from the previous response output. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListAccounts API Version 2019-06-10 9 AWS IAM Identity Center Portal API Reference Content-type: application/json { "accountList": [ { "accountId": "string", "accountName": "string", "emailAddress": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accountList A paginated response with the list of account information and the next token if more results are available. Type: Array of AccountInfo objects nextToken The page token client that is used to retrieve the list of accounts. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InvalidRequestException Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 Response Elements API Version 2019-06-10 10 AWS IAM Identity Center ResourceNotFoundException The speciﬁed resource doesn't exist. HTTP Status Code: 404 TooManyRequestsException Portal API Reference Indicates that the request is being made too frequently and is more than what the server can handle. HTTP Status Code: 429 UnauthorizedException Indicates that the request is not authorized. This can happen due to an invalid access token in the request. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-06-10 11 AWS IAM Identity Center Logout Portal API Reference Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session. Note If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as speciﬁed in the corresponding IAM Identity Center permission set. More speciﬁcally, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client. After user logout, any existing IAM role sessions that were created by using IAM Identity Center permission sets continue based on the duration conﬁgured in the permission set. For more information, see User authentications in the IAM Identity Center User Guide. Request Syntax POST /logout HTTP/1.1 x-amz-sso_bearer_token: accessToken URI Request Parameters The request uses the following URI parameters. accessToken The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide. Required: Yes Request Body The request does not have a request body. Logout API Version 2019-06-10 12 AWS IAM Identity Center Response Syntax HTTP/1.1 200 Response Elements Portal API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidRequestException Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range. HTTP Status Code: 400 TooManyRequestsException Indicates that the request is being made too frequently and is more than what the server can handle. HTTP Status Code: 429 UnauthorizedException Indicates that the request is not authorized. This can happen due to an invalid access token in the request. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Response Syntax API Version 2019-06-10 13 AWS IAM Identity Center • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Portal API Reference See Also API Version 2019-06-10 14 AWS IAM Identity Center Data Types Portal API Reference The AWS IAM Identity Center API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is
ssoportal-api-004	ssoportal-api.pdf	4	API Version 2019-06-10 13 AWS IAM Identity Center • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Portal API Reference See Also API Version 2019-06-10 14 AWS IAM Identity Center Data Types Portal API Reference The AWS IAM Identity Center API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountInfo • RoleCredentials • RoleInfo API Version 2019-06-10 15 Portal API Reference AWS IAM Identity Center AccountInfo Provides information about your AWS account. Contents accountId The identiﬁer of the AWS account that is assigned to the user. Type: String Required: No accountName The display name of the AWS account that is assigned to the user. Type: String Required: No emailAddress The email address of the AWS account that is assigned to the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AccountInfo API Version 2019-06-10 16 AWS IAM Identity Center RoleCredentials Portal API Reference Provides information about the role credentials that are assigned to the user. Contents accessKeyId The identiﬁer used for the temporary security credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM Identity Center User Guide. Type: String Required: No expiration The date on which temporary security credentials expire. Type: Long Required: No secretAccessKey The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM Identity Center User Guide. Type: String Required: No sessionToken The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM Identity Center User Guide User Guide. Type: String Required: No RoleCredentials API Version 2019-06-10 17 AWS IAM Identity Center See Also Portal API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-06-10 18 AWS IAM Identity Center RoleInfo Provides information about the role that is assigned to the user. Portal API Reference Contents accountId The identiﬁer of the AWS account assigned to the user. Type: String Required: No roleName The friendly name of the role that is assigned to the user. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RoleInfo API Version 2019-06-10 19 AWS IAM Identity Center Portal API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2019-06-10 20 AWS IAM Identity Center Portal API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date
ssoportal-api-005	ssoportal-api.pdf	5	20 AWS IAM Identity Center Portal API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2019-06-10 21 AWS IAM Identity Center Type: string Required: Conditional X-Amz-SignedHeaders Portal API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2019-06-10 22 AWS IAM Identity Center Portal API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2019-06-10 23 AWS IAM Identity Center HTTP Status Code: 403 RequestAbortedException Portal API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2019-06-10 24 AWS IAM Identity Center UnknownOperationException Portal API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2019-06-10 25
step-functions-api-001	step-functions-api.pdf	1	API Reference AWS Step Functions API Version 2016-11-23 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Step Functions API Reference AWS Step Functions: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Step Functions Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateActivity ................................................................................................................................................ 4 Request Syntax ........................................................................................................................................ 4 Request Parameters ................................................................................................................................ 5 Response Syntax ...................................................................................................................................... 6 Response Elements ................................................................................................................................. 6 Errors .......................................................................................................................................................... 6 See Also ..................................................................................................................................................... 8 CreateStateMachine ..................................................................................................................................... 9 Request Syntax ........................................................................................................................................ 9 Request Parameters .............................................................................................................................. 10 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 14 See Also .................................................................................................................................................. 16 CreateStateMachineAlias .......................................................................................................................... 18 Request Syntax ...................................................................................................................................... 18 Request Parameters .............................................................................................................................. 19 Response Syntax ................................................................................................................................... 20 Response Elements ............................................................................................................................... 20 Errors ....................................................................................................................................................... 20 See Also .................................................................................................................................................. 21 DeleteActivity .............................................................................................................................................. 23 Request Syntax ...................................................................................................................................... 23 Request Parameters .............................................................................................................................. 23 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 24 DeleteStateMachine ................................................................................................................................... 25 Request Syntax ...................................................................................................................................... 25 Request Parameters .............................................................................................................................. 26 Response Elements ............................................................................................................................... 26 Errors ....................................................................................................................................................... 26 API Version 2016-11-23 iii AWS Step Functions API Reference See Also .................................................................................................................................................. 26 DeleteStateMachineAlias .......................................................................................................................... 28 Request Syntax ...................................................................................................................................... 28 Request Parameters .............................................................................................................................. 28 Response Elements ............................................................................................................................... 28 Errors ....................................................................................................................................................... 29 See Also .................................................................................................................................................. 29 DeleteStateMachineVersion ...................................................................................................................... 31 Request Syntax ...................................................................................................................................... 31 Request Parameters .............................................................................................................................. 31 Response Elements ............................................................................................................................... 32 Errors ....................................................................................................................................................... 32 See Also .................................................................................................................................................. 32 DescribeActivity .......................................................................................................................................... 34 Request Syntax ...................................................................................................................................... 34 Request Parameters .............................................................................................................................. 34 Response Syntax ................................................................................................................................... 34 Response Elements ............................................................................................................................... 35 Errors ....................................................................................................................................................... 36 See Also .................................................................................................................................................. 36 DescribeExecution ...................................................................................................................................... 38 Request Syntax ...................................................................................................................................... 38 Request Parameters .............................................................................................................................. 38 Response Syntax ................................................................................................................................... 39 Response Elements ............................................................................................................................... 40 Errors ....................................................................................................................................................... 45 See Also .................................................................................................................................................. 46 DescribeMapRun ......................................................................................................................................... 47 Request Syntax ...................................................................................................................................... 47 Request Parameters .............................................................................................................................. 47 Response Syntax ................................................................................................................................... 47 Response Elements ............................................................................................................................... 48 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 51 DescribeStateMachine ............................................................................................................................... 52 Request Syntax ...................................................................................................................................... 53 API Version 2016-11-23 iv AWS Step Functions API Reference Request Parameters .............................................................................................................................. 53 Response Syntax ................................................................................................................................... 54 Response Elements ............................................................................................................................... 55 Errors ....................................................................................................................................................... 58 See Also .................................................................................................................................................. 58 DescribeStateMachineAlias ....................................................................................................................... 60 Request Syntax ...................................................................................................................................... 60 Request Parameters .............................................................................................................................. 60 Response Syntax ................................................................................................................................... 60 Response Elements ............................................................................................................................... 61 Errors ....................................................................................................................................................... 62 See Also .................................................................................................................................................. 62 DescribeStateMachineForExecution ........................................................................................................ 64 Request Syntax ...................................................................................................................................... 64 Request Parameters .............................................................................................................................. 64 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 66 Errors ....................................................................................................................................................... 68 See Also .................................................................................................................................................. 69 GetActivityTask ........................................................................................................................................... 70 Request Syntax ...................................................................................................................................... 70 Request Parameters .............................................................................................................................. 70 Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 GetExecutionHistory .................................................................................................................................. 74 Request Syntax ...................................................................................................................................... 74 Request Parameters .............................................................................................................................. 74 Response Syntax ................................................................................................................................... 75 Response Elements ............................................................................................................................... 80 Errors ....................................................................................................................................................... 81 Examples ................................................................................................................................................. 82 See Also .................................................................................................................................................. 83 ListActivities ................................................................................................................................................. 85 Request Syntax ...................................................................................................................................... 85 API Version 2016-11-23 v AWS Step Functions API Reference Request Parameters .............................................................................................................................. 85 Response Syntax ................................................................................................................................... 86 Response Elements ............................................................................................................................... 86 Errors ....................................................................................................................................................... 87 See Also .................................................................................................................................................. 87 ListExecutions .............................................................................................................................................. 89 Request Syntax ...................................................................................................................................... 89 Request Parameters .............................................................................................................................. 89 Response Syntax ................................................................................................................................... 92 Response Elements ............................................................................................................................... 92 Errors ....................................................................................................................................................... 93 See Also .................................................................................................................................................. 93 ListMapRuns ................................................................................................................................................ 95 Request Syntax ...................................................................................................................................... 95 Request Parameters .............................................................................................................................. 95 Response Syntax ................................................................................................................................... 96 Response Elements ............................................................................................................................... 96 Errors ....................................................................................................................................................... 97 See Also .................................................................................................................................................. 97 ListStateMachineAliases ............................................................................................................................ 99 Request Syntax ...................................................................................................................................... 99 Request Parameters .............................................................................................................................. 99 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 101 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 ListStateMachines .................................................................................................................................... 103 Request Syntax .................................................................................................................................... 103 Request Parameters ........................................................................................................................... 103 Response Syntax ................................................................................................................................. 104 Response Elements ............................................................................................................................ 104 Errors ..................................................................................................................................................... 105 See Also ................................................................................................................................................ 105 ListStateMachineVersions ....................................................................................................................... 106 Request Syntax .................................................................................................................................... 106 Request Parameters ........................................................................................................................... 106 API Version 2016-11-23 vi AWS Step Functions API Reference Response Syntax ................................................................................................................................. 107 Response Elements ............................................................................................................................ 107 Errors ..................................................................................................................................................... 108 See Also ................................................................................................................................................ 108 ListTagsForResource ................................................................................................................................ 110 Request Syntax .................................................................................................................................... 110 Request Parameters ........................................................................................................................... 110 Response Syntax ................................................................................................................................. 110 Response Elements ............................................................................................................................ 111 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 111 PublishStateMachineVersion .................................................................................................................. 113 Request Syntax .................................................................................................................................... 113 Request Parameters ........................................................................................................................... 113 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 115 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 RedriveExecution ...................................................................................................................................... 117 Request Syntax .................................................................................................................................... 118 Request Parameters ........................................................................................................................... 118 Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 119 Errors ..................................................................................................................................................... 119 See Also ................................................................................................................................................ 120 SendTaskFailure ........................................................................................................................................ 121 Request Syntax .................................................................................................................................... 121 Request Parameters ........................................................................................................................... 121 Response Elements ............................................................................................................................ 122 Errors ..................................................................................................................................................... 122 See Also ................................................................................................................................................ 123 SendTaskHeartbeat .................................................................................................................................. 124 Request Syntax
step-functions-api-002	step-functions-api.pdf	2	.................................................................................................................................... 110 Request Parameters ........................................................................................................................... 110 Response Syntax ................................................................................................................................. 110 Response Elements ............................................................................................................................ 111 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 111 PublishStateMachineVersion .................................................................................................................. 113 Request Syntax .................................................................................................................................... 113 Request Parameters ........................................................................................................................... 113 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 115 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 RedriveExecution ...................................................................................................................................... 117 Request Syntax .................................................................................................................................... 118 Request Parameters ........................................................................................................................... 118 Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 119 Errors ..................................................................................................................................................... 119 See Also ................................................................................................................................................ 120 SendTaskFailure ........................................................................................................................................ 121 Request Syntax .................................................................................................................................... 121 Request Parameters ........................................................................................................................... 121 Response Elements ............................................................................................................................ 122 Errors ..................................................................................................................................................... 122 See Also ................................................................................................................................................ 123 SendTaskHeartbeat .................................................................................................................................. 124 Request Syntax .................................................................................................................................... 124 Request Parameters ........................................................................................................................... 124 Response Elements ............................................................................................................................ 125 Errors ..................................................................................................................................................... 125 API Version 2016-11-23 vii AWS Step Functions API Reference See Also ................................................................................................................................................ 125 SendTaskSuccess ...................................................................................................................................... 127 Request Syntax .................................................................................................................................... 127 Request Parameters ........................................................................................................................... 127 Response Elements ............................................................................................................................ 128 Errors ..................................................................................................................................................... 128 See Also ................................................................................................................................................ 129 StartExecution .......................................................................................................................................... 130 Request Syntax .................................................................................................................................... 131 Request Parameters ........................................................................................................................... 131 Response Syntax ................................................................................................................................. 134 Response Elements ............................................................................................................................ 134 Errors ..................................................................................................................................................... 134 See Also ................................................................................................................................................ 136 StartSyncExecution .................................................................................................................................. 138 Request Syntax .................................................................................................................................... 138 Request Parameters ........................................................................................................................... 138 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 141 Errors ..................................................................................................................................................... 143 See Also ................................................................................................................................................ 145 StopExecution ........................................................................................................................................... 146 Request Syntax .................................................................................................................................... 146 Request Parameters ........................................................................................................................... 146 Response Syntax ................................................................................................................................. 147 Response Elements ............................................................................................................................ 147 Errors ..................................................................................................................................................... 147 See Also ................................................................................................................................................ 148 TagResource .............................................................................................................................................. 150 Request Syntax .................................................................................................................................... 150 Request Parameters ........................................................................................................................... 150 Response Elements ............................................................................................................................ 151 Errors ..................................................................................................................................................... 151 See Also ................................................................................................................................................ 151 TestState .................................................................................................................................................... 153 Request Syntax .................................................................................................................................... 153 API Version 2016-11-23 viii AWS Step Functions API Reference Request Parameters ........................................................................................................................... 154 Response Syntax ................................................................................................................................. 156 Response Elements ............................................................................................................................ 156 Errors ..................................................................................................................................................... 158 See Also ................................................................................................................................................ 158 UntagResource .......................................................................................................................................... 160 Request Syntax .................................................................................................................................... 160 Request Parameters ........................................................................................................................... 160 Response Elements ............................................................................................................................ 160 Errors ..................................................................................................................................................... 161 See Also ................................................................................................................................................ 161 UpdateMapRun ......................................................................................................................................... 162 Request Syntax .................................................................................................................................... 162 Request Parameters ........................................................................................................................... 162 Response Elements ............................................................................................................................ 163 Errors ..................................................................................................................................................... 163 See Also ................................................................................................................................................ 164 UpdateStateMachine ............................................................................................................................... 165 Request Syntax .................................................................................................................................... 166 Request Parameters ........................................................................................................................... 167 Response Syntax ................................................................................................................................. 168 Response Elements ............................................................................................................................ 169 Errors ..................................................................................................................................................... 169 See Also ................................................................................................................................................ 171 UpdateStateMachineAlias ....................................................................................................................... 173 Request Syntax .................................................................................................................................... 173 Request Parameters ........................................................................................................................... 174 Response Syntax ................................................................................................................................. 175 Response Elements ............................................................................................................................ 175 Errors ..................................................................................................................................................... 175 See Also ................................................................................................................................................ 176 ValidateStateMachineDeﬁnition ............................................................................................................ 177 Request Syntax .................................................................................................................................... 177 Request Parameters ........................................................................................................................... 178 Response Syntax ................................................................................................................................. 179 Response Elements ............................................................................................................................ 179 API Version 2016-11-23 ix AWS Step Functions API Reference Errors ..................................................................................................................................................... 180 Examples ............................................................................................................................................... 180 See Also ................................................................................................................................................ 182 Data Types ................................................................................................................................... 183 ActivityFailedEventDetails ...................................................................................................................... 186 Contents ............................................................................................................................................... 186 See Also ................................................................................................................................................ 186 ActivityListItem ......................................................................................................................................... 187 Contents ............................................................................................................................................... 187 See Also ................................................................................................................................................ 188 ActivityScheduledEventDetails .............................................................................................................. 189 Contents ............................................................................................................................................... 189 See Also ................................................................................................................................................ 190 ActivityScheduleFailedEventDetails ...................................................................................................... 191 Contents ............................................................................................................................................... 191 See Also ................................................................................................................................................ 191 ActivityStartedEventDetails ................................................................................................................... 192 Contents ............................................................................................................................................... 192 See Also ................................................................................................................................................ 192 ActivitySucceededEventDetails .............................................................................................................. 193 Contents ............................................................................................................................................... 193 See Also ................................................................................................................................................ 193 ActivityTimedOutEventDetails ............................................................................................................... 194 Contents ............................................................................................................................................... 194 See Also ................................................................................................................................................ 194 AssignedVariablesDetails ........................................................................................................................ 195 Contents ............................................................................................................................................... 195 See Also ................................................................................................................................................ 195 BillingDetails ............................................................................................................................................. 196 Contents ............................................................................................................................................... 196 See Also ................................................................................................................................................ 196 CloudWatchEventsExecutionDataDetails ............................................................................................. 197 Contents ............................................................................................................................................... 197 See Also ................................................................................................................................................ 197 CloudWatchLogsLogGroup ..................................................................................................................... 198 Contents ............................................................................................................................................... 198 API Version 2016-11-23 x AWS Step Functions API Reference See Also ................................................................................................................................................ 198 EncryptionConﬁguration ........................................................................................................................ 199 Contents ............................................................................................................................................... 199 See Also ................................................................................................................................................ 200 EvaluationFailedEventDetails ................................................................................................................. 201 Contents ............................................................................................................................................... 201 See Also ................................................................................................................................................ 202 ExecutionAbortedEventDetails .............................................................................................................. 203 Contents ............................................................................................................................................... 203 See Also ................................................................................................................................................ 203 ExecutionFailedEventDetails .................................................................................................................. 204 Contents ............................................................................................................................................... 204 See Also ................................................................................................................................................ 204 ExecutionListItem ..................................................................................................................................... 205 Contents ............................................................................................................................................... 205 See Also ................................................................................................................................................ 208 ExecutionRedrivenEventDetails ............................................................................................................. 209 Contents ............................................................................................................................................... 209 See Also ................................................................................................................................................ 209 ExecutionStartedEventDetails ............................................................................................................... 210 Contents ............................................................................................................................................... 210 See Also ................................................................................................................................................ 211 ExecutionSucceededEventDetails .......................................................................................................... 212 Contents ............................................................................................................................................... 212 See Also ................................................................................................................................................ 212 ExecutionTimedOutEventDetails ........................................................................................................... 213 Contents ............................................................................................................................................... 213 See Also ................................................................................................................................................ 213 HistoryEvent .............................................................................................................................................. 214 Contents ............................................................................................................................................... 214 See Also ................................................................................................................................................ 220 HistoryEventExecutionDataDetails ....................................................................................................... 222 Contents ............................................................................................................................................... 222 See Also ................................................................................................................................................ 222 InspectionData .......................................................................................................................................... 223 Contents ............................................................................................................................................... 223 API Version 2016-11-23 xi AWS Step Functions API Reference See Also ................................................................................................................................................ 225 InspectionDataRequest ........................................................................................................................... 226 Contents ............................................................................................................................................... 226 See Also ................................................................................................................................................ 227 InspectionDataResponse ......................................................................................................................... 228 Contents ............................................................................................................................................... 228 See Also ................................................................................................................................................ 229 LambdaFunctionFailedEventDetails ..................................................................................................... 230 Contents ............................................................................................................................................... 230 See Also ................................................................................................................................................ 230 LambdaFunctionScheduledEventDetails ............................................................................................. 231 Contents ............................................................................................................................................... 231 See Also ................................................................................................................................................ 232 LambdaFunctionScheduleFailedEventDetails ..................................................................................... 233 Contents ............................................................................................................................................... 233 See Also ................................................................................................................................................ 233 LambdaFunctionStartFailedEventDetails ............................................................................................ 234 Contents ............................................................................................................................................... 234 See Also ................................................................................................................................................ 234 LambdaFunctionSucceededEventDetails ............................................................................................. 235 Contents ............................................................................................................................................... 235 See Also ................................................................................................................................................ 235 LambdaFunctionTimedOutEventDetails .............................................................................................. 236 Contents ............................................................................................................................................... 236 See Also ................................................................................................................................................ 236 LogDestination .......................................................................................................................................... 237 Contents ............................................................................................................................................... 237 See Also ................................................................................................................................................ 237 LoggingConﬁguration ............................................................................................................................. 238 Contents ............................................................................................................................................... 238 See Also ................................................................................................................................................ 238 MapIterationEventDetails ....................................................................................................................... 240 Contents ............................................................................................................................................... 240 See Also ................................................................................................................................................ 240 MapRunExecutionCounts ........................................................................................................................ 241 Contents ............................................................................................................................................... 241 API Version 2016-11-23 xii AWS Step Functions API Reference See Also ................................................................................................................................................ 243 MapRunFailedEventDetails .....................................................................................................................
step-functions-api-003	step-functions-api.pdf	3	............................................................................................. 231 Contents ............................................................................................................................................... 231 See Also ................................................................................................................................................ 232 LambdaFunctionScheduleFailedEventDetails ..................................................................................... 233 Contents ............................................................................................................................................... 233 See Also ................................................................................................................................................ 233 LambdaFunctionStartFailedEventDetails ............................................................................................ 234 Contents ............................................................................................................................................... 234 See Also ................................................................................................................................................ 234 LambdaFunctionSucceededEventDetails ............................................................................................. 235 Contents ............................................................................................................................................... 235 See Also ................................................................................................................................................ 235 LambdaFunctionTimedOutEventDetails .............................................................................................. 236 Contents ............................................................................................................................................... 236 See Also ................................................................................................................................................ 236 LogDestination .......................................................................................................................................... 237 Contents ............................................................................................................................................... 237 See Also ................................................................................................................................................ 237 LoggingConﬁguration ............................................................................................................................. 238 Contents ............................................................................................................................................... 238 See Also ................................................................................................................................................ 238 MapIterationEventDetails ....................................................................................................................... 240 Contents ............................................................................................................................................... 240 See Also ................................................................................................................................................ 240 MapRunExecutionCounts ........................................................................................................................ 241 Contents ............................................................................................................................................... 241 API Version 2016-11-23 xii AWS Step Functions API Reference See Also ................................................................................................................................................ 243 MapRunFailedEventDetails ..................................................................................................................... 244 Contents ............................................................................................................................................... 244 See Also ................................................................................................................................................ 244 MapRunItemCounts ................................................................................................................................. 245 Contents ............................................................................................................................................... 245 See Also ................................................................................................................................................ 247 MapRunListItem ....................................................................................................................................... 248 Contents ............................................................................................................................................... 248 See Also ................................................................................................................................................ 249 MapRunRedrivenEventDetails ................................................................................................................ 250 Contents ............................................................................................................................................... 250 See Also ................................................................................................................................................ 250 MapRunStartedEventDetails .................................................................................................................. 251 Contents ............................................................................................................................................... 251 See Also ................................................................................................................................................ 251 MapStateStartedEventDetails ................................................................................................................ 252 Contents ............................................................................................................................................... 252 See Also ................................................................................................................................................ 252 RoutingConﬁgurationListItem ............................................................................................................... 253 Contents ............................................................................................................................................... 253 See Also ................................................................................................................................................ 253 StateEnteredEventDetails ....................................................................................................................... 255 Contents ............................................................................................................................................... 255 See Also ................................................................................................................................................ 255 StateExitedEventDetails .......................................................................................................................... 257 Contents ............................................................................................................................................... 257 See Also ................................................................................................................................................ 258 StateMachineAliasListItem ..................................................................................................................... 259 Contents ............................................................................................................................................... 259 See Also ................................................................................................................................................ 259 StateMachineListItem .............................................................................................................................. 260 Contents ............................................................................................................................................... 260 See Also ................................................................................................................................................ 261 StateMachineVersionListItem ................................................................................................................ 262 Contents ............................................................................................................................................... 262 API Version 2016-11-23 xiii AWS Step Functions API Reference See Also ................................................................................................................................................ 262 Tag ............................................................................................................................................................... 263 Contents ............................................................................................................................................... 263 See Also ................................................................................................................................................ 263 TaskCredentials ......................................................................................................................................... 264 Contents ............................................................................................................................................... 264 See Also ................................................................................................................................................ 264 TaskFailedEventDetails ............................................................................................................................ 265 Contents ............................................................................................................................................... 265 See Also ................................................................................................................................................ 266 TaskScheduledEventDetails .................................................................................................................... 267 Contents ............................................................................................................................................... 267 See Also ................................................................................................................................................ 268 TaskStartedEventDetails ......................................................................................................................... 269 Contents ............................................................................................................................................... 269 See Also ................................................................................................................................................ 269 TaskStartFailedEventDetails ................................................................................................................... 270 Contents ............................................................................................................................................... 270 See Also ................................................................................................................................................ 271 TaskSubmitFailedEventDetails ............................................................................................................... 272 Contents ............................................................................................................................................... 272 See Also ................................................................................................................................................ 273 TaskSubmittedEventDetails ................................................................................................................... 274 Contents ............................................................................................................................................... 274 See Also ................................................................................................................................................ 275 TaskSucceededEventDetails ................................................................................................................... 276 Contents ............................................................................................................................................... 276 See Also ................................................................................................................................................ 277 TaskTimedOutEventDetails .................................................................................................................... 278 Contents ............................................................................................................................................... 278 See Also ................................................................................................................................................ 279 TracingConﬁguration ............................................................................................................................... 280 Contents ............................................................................................................................................... 280 See Also ................................................................................................................................................ 280 ValidateStateMachineDeﬁnitionDiagnostic ......................................................................................... 281 Contents ............................................................................................................................................... 282 API Version 2016-11-23 xiv AWS Step Functions API Reference See Also ................................................................................................................................................ 283 Common Parameters ................................................................................................................... 285 Common Errors ............................................................................................................................ 288 API Version 2016-11-23 xv AWS Step Functions Welcome API Reference With AWS Step Functions, you can create workﬂows, also called state machines, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines. Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses. With API calls, you can also manage other aspects of your workﬂow, such as tags, versions, and aliases. For more information about developing solutions with Step Functions, see the AWS Step Functions Developer Guide . Important If you use the Step Functions API actions using AWS SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn. This document was last published on May 21, 2025. API Version 2016-11-23 1 AWS Step Functions Actions The following actions are supported: • CreateActivity • CreateStateMachine • CreateStateMachineAlias • DeleteActivity • DeleteStateMachine • DeleteStateMachineAlias • DeleteStateMachineVersion • DescribeActivity • DescribeExecution • DescribeMapRun • DescribeStateMachine • DescribeStateMachineAlias • DescribeStateMachineForExecution • GetActivityTask • GetExecutionHistory • ListActivities • ListExecutions • ListMapRuns • ListStateMachineAliases • ListStateMachines • ListStateMachineVersions • ListTagsForResource • PublishStateMachineVersion • RedriveExecution • SendTaskFailure • SendTaskHeartbeat • SendTaskSuccess API Reference API Version 2016-11-23 2 AWS Step Functions • StartExecution • StartSyncExecution • StopExecution • TagResource • TestState • UntagResource • UpdateMapRun • UpdateStateMachine • UpdateStateMachineAlias • ValidateStateMachineDeﬁnition API Reference API Version 2016-11-23 3 AWS Step Functions CreateActivity API Reference Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identiﬁer for use in a state machine and when polling from the activity. Note This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. Note CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has diﬀerent tags values, Step Functions will ignore these diﬀerences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are diﬀerent. Request Syntax { "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string",
step-functions-api-004	step-functions-api.pdf	4	machine and when polling from the activity. Note This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. Note CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has diﬀerent tags values, Step Functions will ignore these diﬀerences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are diﬀerent. Request Syntax { "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string", "type": "string" }, "name": "string", "tags": [ { "key": "string", "value": "string" } ] } CreateActivity API Version 2016-11-23 4 AWS Step Functions Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. encryptionConﬁguration Settings to conﬁgure server-side encryption. Type: EncryptionConﬁguration object Required: No name The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. Required: Yes tags The list of tags to add to a resource. Request Parameters API Version 2016-11-23 5 AWS Step Functions API Reference An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. Type: Array of Tag objects Required: No Response Syntax { "activityArn": "string", "creationDate": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. activityArn The Amazon Resource Name (ARN) that identiﬁes the created activity. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. creationDate The date the activity is created. Type: Timestamp Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-23 6 AWS Step Functions ActivityAlreadyExists API Reference Activity already exists. EncryptionConfiguration may not be updated. HTTP Status Code: 400 ActivityLimitExceeded The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created. HTTP Status Code: 400 InvalidEncryptionConﬁguration Received when encryptionConfiguration is speciﬁed but various conditions exist which make the conﬁguration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the AWS KMS key is not symmetric or inactive. HTTP Status Code: 400 InvalidName The provided name is not valid. HTTP Status Code: 400 KmsAccessDeniedException Either your AWS KMS key policy or API caller does not have the required permissions. HTTP Status Code: 400 KmsThrottlingException Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller. HTTP Status Code: 400 TooManyTags You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide. HTTP Status Code: 400 Errors API Version 2016-11-23 7 AWS Step Functions See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 8 AWS Step Functions API Reference CreateStateMachine Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are speciﬁed using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the ﬁrst revision of the
step-functions-api-005	step-functions-api.pdf	5	SDK for Ruby V3 See Also API Version 2016-11-23 8 AWS Step Functions API Reference CreateStateMachine Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are speciﬁed using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the ﬁrst revision of the state machine. For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can conﬁgure a symmetric AWS KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine deﬁnition will be encrypted with the key applied to the State Machine. Note This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. Note CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a diﬀerent roleArn or tags, Step Functions will ignore these diﬀerences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are diﬀerent. Request Syntax { "definition": "string", CreateStateMachine API Version 2016-11-23 9 AWS Step Functions API Reference "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string", "type": "string" }, "loggingConfiguration": { "destinations": [ { "cloudWatchLogsLogGroup": { "logGroupArn": "string" } } ], "includeExecutionData": boolean, "level": "string" }, "name": "string", "publish": boolean, "roleArn": "string", "tags": [ { "key": "string", "value": "string" } ], "tracingConfiguration": { "enabled": boolean }, "type": "string", "versionDescription": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. deﬁnition The Amazon States Language deﬁnition of the state machine. See Amazon States Language. Type: String Request Parameters API Version 2016-11-23 10 AWS Step Functions API Reference Length Constraints: Minimum length of 1. Maximum length of 1048576. Required: Yes encryptionConﬁguration Settings to conﬁgure server-side encryption. Type: EncryptionConﬁguration object Required: No loggingConﬁguration Deﬁnes what execution history events are logged and where they are logged. Note By default, the level is set to OFF. For more information see Log Levels in the AWS Step Functions User Guide. Type: LoggingConﬁguration object Required: No name The name of the state machine. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. Request Parameters API Version 2016-11-23 11 AWS Step Functions Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 80. Required: Yes publish Set to true to publish the ﬁrst version of the state machine during creation. The default is false. Type: Boolean Required: No roleArn The Amazon Resource Name (ARN) of the IAM role to use for this state machine. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes tags Tags to be added when creating a state machine. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. Type: Array of Tag objects Required: No tracingConﬁguration Selects whether AWS X-Ray tracing is enabled. Type: TracingConﬁguration object Request Parameters API Version 2016-11-23 12 AWS Step Functions Required: No type API Reference Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created. Type: String Valid Values: STANDARD \| EXPRESS Required: No versionDescription Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException. Type: String Length Constraints: Maximum length of 256. Required: No Response Syntax { "creationDate": number, "stateMachineArn": "string", "stateMachineVersionArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following
step-functions-api-006	step-functions-api.pdf	6	The default is STANDARD. You cannot update the type of a state machine once it has been created. Type: String Valid Values: STANDARD \| EXPRESS Required: No versionDescription Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException. Type: String Length Constraints: Maximum length of 256. Required: No Response Syntax { "creationDate": number, "stateMachineArn": "string", "stateMachineVersionArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. creationDate The date the state machine is created. Response Syntax API Version 2016-11-23 13 AWS Step Functions Type: Timestamp stateMachineArn API Reference The Amazon Resource Name (ARN) that identiﬁes the created state machine. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. stateMachineVersionArn The Amazon Resource Name (ARN) that identiﬁes the created state machine version. If you do not set the publish parameter to true, this ﬁeld returns null value. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true. HTTP Status Code: 409 HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 InvalidDeﬁnition The provided Amazon States Language deﬁnition is not valid. HTTP Status Code: 400 Errors API Version 2016-11-23 14 AWS Step Functions InvalidEncryptionConﬁguration API Reference Received when encryptionConfiguration is speciﬁed but various conditions exist which make the conﬁguration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the AWS KMS key is not symmetric or inactive. HTTP Status Code: 400 InvalidLoggingConﬁguration Conﬁguration is not valid. HTTP Status Code: 400 InvalidName The provided name is not valid. HTTP Status Code: 400 InvalidTracingConﬁguration Your tracingConfiguration key does not match, or enabled has not been set to true or false. HTTP Status Code: 400 KmsAccessDeniedException Either your AWS KMS key policy or API caller does not have the required permissions. HTTP Status Code: 400 KmsThrottlingException Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller. HTTP Status Code: 400 StateMachineAlreadyExists A state machine with the same name but a diﬀerent deﬁnition or role ARN already exists. HTTP Status Code: 400 Errors API Version 2016-11-23 15 AWS Step Functions StateMachineDeleting The speciﬁed state machine is being deleted. HTTP Status Code: 400 StateMachineLimitExceeded API Reference The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created. HTTP Status Code: 400 StateMachineTypeNotSupported State machine type is not supported. HTTP Status Code: 400 TooManyTags You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2016-11-23 16 AWS Step Functions • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-23 17 AWS Step Functions API Reference CreateStateMachineAlias Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code. You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check
step-functions-api-007	step-functions-api.pdf	7	machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource. Related operations: • DescribeStateMachineAlias • ListStateMachineAliases • UpdateStateMachineAlias • DeleteStateMachineAlias Request Syntax { "description": "string", "name": "string", "routingConfiguration": [ { "stateMachineVersionArn": "string", CreateStateMachineAlias API Version 2016-11-23 18 AWS Step Functions "weight": number } ] } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. description A description for the state machine alias. Type: String Length Constraints: Maximum length of 256. Required: No name The name of the state machine alias. To avoid conﬂict with version ARNs, don't use an integer in the name of the alias. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. Pattern: ^(?=.*[a-zA-Z_\-\.])[a-zA-Z0-9_\-\.]+$ Required: Yes routingConﬁguration The routing conﬁguration of a state machine alias. The routing conﬁguration shifts execution traﬃc between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig. Type: Array of RoutingConﬁgurationListItem objects Request Parameters API Version 2016-11-23 19 AWS Step Functions API Reference Array Members: Minimum number of 1 item. Maximum number of 2 items. Required: Yes Response Syntax { "creationDate": number, "stateMachineAliasArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. creationDate The date the state machine alias was created. Type: Timestamp stateMachineAliasArn The Amazon Resource Name (ARN) that identiﬁes the created state machine alias. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true. Response Syntax API Version 2016-11-23 20 API Reference AWS Step Functions HTTP Status Code: 409 HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 InvalidName The provided name is not valid. HTTP Status Code: 400 ResourceNotFound Could not ﬁnd the referenced resource. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 402 HTTP Status Code: 400 StateMachineDeleting The speciﬁed state machine is being deleted. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-23 21 API Reference AWS Step Functions • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 22 API Reference AWS Step Functions DeleteActivity Deletes an activity. Request Syntax { "activityArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. activityArn The Amazon Resource Name (ARN) of the activity to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 DeleteActivity API Version 2016-11-23 23 AWS Step Functions See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ •
step-functions-api-008	step-functions-api.pdf	8	Maximum length of 256. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 DeleteActivity API Version 2016-11-23 23 AWS Step Functions See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 24 AWS Step Functions API Reference DeleteStateMachine Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated. A qualiﬁed state machine ARN can either refer to a Distributed Map state deﬁned within a state machine, a version ARN, or an alias ARN. The following are some examples of qualiﬁed and unqualiﬁed state machine ARNs: • The following qualiﬁed state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/ mapStateLabel Note If you provide a qualiﬁed state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. • The following unqualiﬁed state machine ARN refers to a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also deletes all versions and aliases associated with a state machine. Note For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called. Request Syntax { "stateMachineArn": "string" DeleteStateMachine API Version 2016-11-23 25 AWS Step Functions } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. stateMachineArn The Amazon Resource Name (ARN) of the state machine to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Request Parameters API Version 2016-11-23 26 API Reference AWS Step Functions • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 27 AWS Step Functions API Reference DeleteStateMachineAlias Deletes a state machine alias. After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. Related operations: • CreateStateMachineAlias • DescribeStateMachineAlias • ListStateMachineAliases • UpdateStateMachineAlias Request Syntax { "stateMachineAliasArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. stateMachineAliasArn The Amazon Resource Name (ARN) of the state machine alias to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteStateMachineAlias API Version 2016-11-23 28 AWS Step Functions Errors API Reference For information about the errors that are common to all actions, see Common Errors. ConﬂictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true. HTTP Status Code: 409 HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 ResourceNotFound Could not ﬁnd the referenced resource. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using
step-functions-api-009	step-functions-api.pdf	9	information about the errors that are common to all actions, see Common Errors. ConﬂictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true. HTTP Status Code: 409 HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 ResourceNotFound Could not ﬁnd the referenced resource. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Errors API Version 2016-11-23 29 AWS Step Functions • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-23 30 AWS Step Functions API Reference DeleteStateMachineVersion Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias. Note Deleting a state machine version won't terminate its in-progress executions. Note You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version. Related operations: • PublishStateMachineVersion • ListStateMachineVersions Request Syntax { "stateMachineVersionArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. stateMachineVersionArn The Amazon Resource Name (ARN) of the state machine version to delete. Type: String DeleteStateMachineVersion API Version 2016-11-23 31 AWS Step Functions API Reference Length Constraints: Minimum length of 1. Maximum length of 2000. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true. HTTP Status Code: 409 HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Response Elements API Version 2016-11-23 32 API Reference AWS Step Functions • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 33 AWS Step Functions DescribeActivity Describes an activity. Note API Reference This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. Request Syntax { "activityArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. activityArn The Amazon Resource Name (ARN) of the activity to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Syntax { "activityArn": "string", "creationDate": number, "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, DescribeActivity API Version 2016-11-23 34 AWS Step Functions API Reference "kmsKeyId": "string", "type": "string" }, "name": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. activityArn The Amazon Resource Name (ARN) that identiﬁes the activity. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. creationDate The date the activity is created. Type: Timestamp encryptionConﬁguration Settings for conﬁgured server-side encryption. Type: EncryptionConﬁguration object name The name of the activity. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) Response Elements API Version 2016-11-23 35 AWS Step Functions API Reference • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. Type: String
step-functions-api-010	step-functions-api.pdf	10	created. Type: Timestamp encryptionConﬁguration Settings for conﬁgured server-side encryption. Type: EncryptionConﬁguration object name The name of the activity. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) Response Elements API Version 2016-11-23 35 AWS Step Functions API Reference • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. Errors For information about the errors that are common to all actions, see Common Errors. ActivityDoesNotExist The speciﬁed activity does not exist. HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors API Version 2016-11-23 36 AWS Step Functions • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-23 37 AWS Step Functions DescribeExecution API Reference Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN. Note This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them. Request Syntax { "executionArn": "string", "includedData": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. executionArn The Amazon Resource Name (ARN) of the execution to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. DescribeExecution API Version 2016-11-23 38 AWS Step Functions Required: Yes includedData API Reference If your state machine deﬁnition is encrypted with a AWS KMS key, callers must have kms:Decrypt permission to decrypt the deﬁnition. Alternatively, you can call DescribeStateMachine API with includedData = METADATA_ONLY to get a successful response without the encrypted deﬁnition. Type: String Valid Values: ALL_DATA \| METADATA_ONLY Required: No Response Syntax { "cause": "string", "error": "string", "executionArn": "string", "input": "string", "inputDetails": { "included": boolean }, "mapRunArn": "string", "name": "string", "output": "string", "outputDetails": { "included": boolean }, "redriveCount": number, "redriveDate": number, "redriveStatus": "string", "redriveStatusReason": "string", "startDate": number, "stateMachineAliasArn": "string", "stateMachineArn": "string", "stateMachineVersionArn": "string", "status": "string", "stopDate": number, "traceHeader": "string" Response Syntax API Version 2016-11-23 39 API Reference AWS Step Functions } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. cause The cause string if the state machine execution failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 32768. error The error string if the state machine execution failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. executionArn The Amazon Resource Name (ARN) that identiﬁes the execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. input The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. Type: String Length Constraints: Maximum length of 262144. inputDetails Provides details about execution input or output. Response Elements API Version 2016-11-23 40 AWS Step Functions API Reference Type: CloudWatchEventsExecutionDataDetails object mapRunArn The Amazon Resource Name (ARN) that identiﬁes a Map Run, which dispatched this execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. name The name of the execution. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, -
step-functions-api-011	step-functions-api.pdf	11	mapRunArn The Amazon Resource Name (ARN) that identiﬁes a Map Run, which dispatched this execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. name The name of the execution. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. output The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. Note This ﬁeld is set only if the execution succeeds. If the execution fails, this ﬁeld is null. Type: String Response Elements API Version 2016-11-23 41 AWS Step Functions API Reference Length Constraints: Maximum length of 262144. outputDetails Provides details about execution input or output. Type: CloudWatchEventsExecutionDataDetails object redriveCount The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution. Type: Integer redriveDate The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null. The redriveDate is unavailable if you redrive a Map Run that starts child workﬂow executions of type EXPRESS. Type: Timestamp redriveStatus Indicates whether or not an execution can be redriven at a given point in time. • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error. • For a Distributed Map that includes child workﬂows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workﬂow executions. • For a Distributed Map that includes child workﬂows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workﬂow executions. You can redrive failed or timed out EXPRESS workﬂows only if they're a part of a Map Run. When you redrive the Map Run, these workﬂows are restarted using the StartExecution API action. Type: String Valid Values: REDRIVABLE \| NOT_REDRIVABLE \| REDRIVABLE_BY_MAP_RUN Response Elements API Version 2016-11-23 42 AWS Step Functions redriveStatusReason API Reference When redriveStatus is NOT_REDRIVABLE, redriveStatusReason speciﬁes the reason why an execution cannot be redriven. • For executions of type STANDARD, or for a Distributed Map that includes child workﬂows of type STANDARD, redriveStatusReason can include one of the following reasons: • State machine is in DELETING status. • Execution is RUNNING and cannot be redriven. • Execution is SUCCEEDED and cannot be redriven. • Execution was started before the launch of RedriveExecution. • Execution history event limit exceeded. • Execution has exceeded the max execution time. • Execution redrivable period exceeded. • For a Distributed Map that includes child workﬂows of type EXPRESS, redriveStatusReason is only returned if the child workﬂows are not redrivable. This happens when the child workﬂow executions have completed successfully. Type: String Length Constraints: Maximum length of 262144. startDate The date the execution is started. Type: Timestamp stateMachineAliasArn The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD. If you start an execution from a StartExecution request with a state machine version ARN, this ﬁeld will be null. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Response Elements API Version 2016-11-23 43 AWS Step Functions stateMachineArn API Reference The Amazon Resource Name (ARN) of the executed stated machine. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. stateMachineVersionArn The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1. If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. status The current status of the execution. Type: String Valid Values: RUNNING \| SUCCEEDED \| FAILED \| TIMED_OUT \| ABORTED \| PENDING_REDRIVE stopDate If the execution ended, the date the execution stopped. Type: Timestamp traceHeader The AWS X-Ray trace header that was passed to the execution. Note For X-Ray traces, all AWS services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use Response Elements API Version
step-functions-api-012	step-functions-api.pdf	12	returns a null value. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. status The current status of the execution. Type: String Valid Values: RUNNING \| SUCCEEDED \| FAILED \| TIMED_OUT \| ABORTED \| PENDING_REDRIVE stopDate If the execution ended, the date the execution stopped. Type: Timestamp traceHeader The AWS X-Ray trace header that was passed to the execution. Note For X-Ray traces, all AWS services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use Response Elements API Version 2016-11-23 44 AWS Step Functions API Reference traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: \p{ASCII}* Errors For information about the errors that are common to all actions, see Common Errors. ExecutionDoesNotExist The speciﬁed execution does not exist. HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 KmsAccessDeniedException Either your AWS KMS key policy or API caller does not have the required permissions. HTTP Status Code: 400 KmsInvalidStateException The AWS KMS key is not in valid state, for example: Disabled or Deleted. HTTP Status Code: 400 KmsThrottlingException Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller. HTTP Status Code: 400 Errors API Version 2016-11-23 45 AWS Step Functions See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 46 AWS Step Functions DescribeMapRun API Reference Provides information about a Map Run's conﬁguration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the AWS Step Functions Developer Guide. Request Syntax { "mapRunArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. mapRunArn The Amazon Resource Name (ARN) that identiﬁes a Map Run. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: Yes Response Syntax { "executionArn": "string", "executionCounts": { "aborted": number, "failed": number, "failuresNotRedrivable": number, "pending": number, "pendingRedrive": number, "resultsWritten": number, DescribeMapRun API Version 2016-11-23 47 AWS Step Functions API Reference "running": number, "succeeded": number, "timedOut": number, "total": number }, "itemCounts": { "aborted": number, "failed": number, "failuresNotRedrivable": number, "pending": number, "pendingRedrive": number, "resultsWritten": number, "running": number, "succeeded": number, "timedOut": number, "total": number }, "mapRunArn": "string", "maxConcurrency": number, "redriveCount": number, "redriveDate": number, "startDate": number, "status": "string", "stopDate": number, "toleratedFailureCount": number, "toleratedFailurePercentage": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. executionArn The Amazon Resource Name (ARN) that identiﬁes the execution in which the Map Run was started. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Response Elements API Version 2016-11-23 48 AWS Step Functions executionCounts API Reference A JSON object that contains information about the total number of child workﬂow executions for the Map Run, and the count of child workﬂow executions for each status, such as failed and succeeded. Type: MapRunExecutionCounts object itemCounts A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed. Type: MapRunItemCounts object mapRunArn The Amazon Resource Name (ARN) that identiﬁes a Map Run. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. maxConcurrency The maximum number of child workﬂow executions conﬁgured to run in parallel for the Map Run at the same time. Type: Integer Valid Range: Minimum value of 0. redriveCount The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run. Type: Integer redriveDate The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null. Type: Timestamp Response Elements API Version 2016-11-23 49 API Reference AWS Step Functions startDate The date when the Map Run was started. Type: Timestamp status The current status of
step-functions-api-013	step-functions-api.pdf	13	at the same time. Type: Integer Valid Range: Minimum value of 0. redriveCount The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run. Type: Integer redriveDate The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null. Type: Timestamp Response Elements API Version 2016-11-23 49 API Reference AWS Step Functions startDate The date when the Map Run was started. Type: Timestamp status The current status of the Map Run. Type: String Valid Values: RUNNING \| SUCCEEDED \| FAILED \| ABORTED stopDate The date when the Map Run was stopped. Type: Timestamp toleratedFailureCount The maximum number of failed child workﬂow executions before the Map Run fails. Type: Long Valid Range: Minimum value of 0. toleratedFailurePercentage The maximum percentage of failed child workﬂow executions before the Map Run fails. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Errors For information about the errors that are common to all actions, see Common Errors. InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 Errors API Version 2016-11-23 50 AWS Step Functions ResourceNotFound Could not ﬁnd the referenced resource. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 51 AWS Step Functions API Reference DescribeStateMachine Provides information about a state machine's deﬁnition, its IAM role Amazon Resource Name (ARN), and conﬁguration. A qualiﬁed state machine ARN can either refer to a Distributed Map state deﬁned within a state machine, a version ARN, or an alias ARN. The following are some examples of qualiﬁed and unqualiﬁed state machine ARNs: • The following qualiﬁed state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/ mapStateLabel Note If you provide a qualiﬁed state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. • The following qualiﬁed state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account- id>:stateMachine:<myStateMachine:PROD> Note If you provide a qualiﬁed state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. • The following unqualiﬁed state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account- id>:stateMachine:<myStateMachine> This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN. DescribeStateMachine API Version 2016-11-23 52 AWS Step Functions Note API Reference This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. Request Syntax { "includedData": "string", "stateMachineArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. includedData If your state machine deﬁnition is encrypted with a AWS KMS key, callers must have kms:Decrypt permission to decrypt the deﬁnition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted deﬁnition. Note When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine deﬁnition to get the Distributed Map state’s deﬁnition. In this case, the API caller needs to have kms:Decrypt permission. Type: String Valid Values: ALL_DATA \| METADATA_ONLY Required: No Request Syntax API Version 2016-11-23 53 AWS Step Functions stateMachineArn API Reference The Amazon Resource Name (ARN) of the state machine for which you want the information. If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Syntax { "creationDate": number, "definition": "string", "description": "string", "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string", "type": "string" }, "label": "string", "loggingConfiguration": { "destinations": [ { "cloudWatchLogsLogGroup": { "logGroupArn": "string" } } ], "includeExecutionData": boolean, "level": "string" }, "name": "string", "revisionId": "string", "roleArn": "string", "stateMachineArn": "string", "status": "string", Response Syntax API Version 2016-11-23 54 AWS Step Functions API Reference "tracingConfiguration": { "enabled": boolean }, "type": "string", "variableReferences": { "string" : [ "string" ]
step-functions-api-014	step-functions-api.pdf	14	machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Syntax { "creationDate": number, "definition": "string", "description": "string", "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string", "type": "string" }, "label": "string", "loggingConfiguration": { "destinations": [ { "cloudWatchLogsLogGroup": { "logGroupArn": "string" } } ], "includeExecutionData": boolean, "level": "string" }, "name": "string", "revisionId": "string", "roleArn": "string", "stateMachineArn": "string", "status": "string", Response Syntax API Version 2016-11-23 54 AWS Step Functions API Reference "tracingConfiguration": { "enabled": boolean }, "type": "string", "variableReferences": { "string" : [ "string" ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. creationDate The date the state machine is created. For a state machine version, creationDate is the date the version was created. Type: Timestamp deﬁnition The Amazon States Language deﬁnition of the state machine. See Amazon States Language. If called with includedData = METADATA_ONLY, the returned deﬁnition will be {}. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. description The description of the state machine version. Type: String Length Constraints: Maximum length of 256. encryptionConﬁguration Settings to conﬁgure server-side encryption. Response Elements API Version 2016-11-23 55 AWS Step Functions API Reference Type: EncryptionConﬁguration object label A user-deﬁned or an auto-generated string that identiﬁes a Map state. This parameter is present only if the stateMachineArn speciﬁed in input is a qualiﬁed state machine ARN. Type: String loggingConﬁguration Type: LoggingConﬁguration object name The name of the state machine. A name must not contain: • white space • brackets < > { } [ ] • wildcard characters ? * • special characters " # % \ ^ \| ~ ` $ & , ; : / • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) • surrogates (U+D800-DFFF) • invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. revisionId The revision identiﬁer for the state machine. Use the revisionId parameter to compare between versions of a state machine conﬁguration used for executions without performing a diﬀ of the properties, such as definition and roleArn. Type: String Response Elements API Version 2016-11-23 56 AWS Step Functions roleArn API Reference The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.) Type: String Length Constraints: Minimum length of 1. Maximum length of 256. stateMachineArn The Amazon Resource Name (ARN) that identiﬁes the state machine. If you speciﬁed a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. status The current status of the state machine. Type: String Valid Values: ACTIVE \| DELETING tracingConﬁguration Selects whether AWS X-Ray tracing is enabled. Type: TracingConﬁguration object type The type of the state machine (STANDARD or EXPRESS). Type: String Valid Values: STANDARD \| EXPRESS variableReferences A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response. Response Elements API Version 2016-11-23 57 AWS Step Functions API Reference Type: String to array of strings map Key Length Constraints: Minimum length of 1. Maximum length of 80. Errors For information about the errors that are common to all actions, see Common Errors. InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 KmsAccessDeniedException Either your AWS KMS key policy or API caller does not have the required permissions. HTTP Status Code: 400 KmsInvalidStateException The AWS KMS key is not in valid state, for example: Disabled or Deleted. HTTP Status Code: 400 KmsThrottlingException Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller. HTTP Status Code: 400 StateMachineDoesNotExist The speciﬁed state machine does not exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2016-11-23 58 API Reference AWS Step Functions • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 59 AWS Step Functions API
step-functions-api-015	step-functions-api.pdf	15	not exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2016-11-23 58 API Reference AWS Step Functions • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 59 AWS Step Functions API Reference DescribeStateMachineAlias Returns details about a state machine alias. Related operations: • CreateStateMachineAlias • ListStateMachineAliases • UpdateStateMachineAlias • DeleteStateMachineAlias Request Syntax { "stateMachineAliasArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. stateMachineAliasArn The Amazon Resource Name (ARN) of the state machine alias. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Syntax { "creationDate": number, "description": "string", "name": "string", DescribeStateMachineAlias API Version 2016-11-23 60 AWS Step Functions API Reference "routingConfiguration": [ { "stateMachineVersionArn": "string", "weight": number } ], "stateMachineAliasArn": "string", "updateDate": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. creationDate The date the state machine alias was created. Type: Timestamp description A description of the alias. Type: String Length Constraints: Maximum length of 256. name The name of the state machine alias. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. routingConﬁguration The routing conﬁguration of the alias. Type: Array of RoutingConﬁgurationListItem objects Array Members: Minimum number of 1 item. Maximum number of 2 items. Response Elements API Version 2016-11-23 61 AWS Step Functions stateMachineAliasArn API Reference The Amazon Resource Name (ARN) of the state machine alias. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. updateDate The date the state machine alias was last updated. For a newly created state machine, this is the same as the creation date. Type: Timestamp Errors For information about the errors that are common to all actions, see Common Errors. InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 ResourceNotFound Could not ﬁnd the referenced resource. HTTP Status Code: 400 ValidationException The input does not satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2016-11-23 62 API Reference AWS Step Functions • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 63 AWS Step Functions API Reference DescribeStateMachineForExecution Provides information about a state machine's deﬁnition, its execution role ARN, and conﬁguration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. Note This operation is eventually consistent. The results are best eﬀort and may not reﬂect very recent updates and changes. This API action is not supported by EXPRESS state machines. Request Syntax { "executionArn": "string", "includedData": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. executionArn The Amazon Resource Name (ARN) of the execution you want state machine information for. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes includedData If your state machine deﬁnition is encrypted with a AWS KMS key, callers must have kms:Decrypt permission to decrypt the deﬁnition. Alternatively, you can call the API with DescribeStateMachineForExecution API Version 2016-11-23 64 AWS Step Functions API Reference includedData = METADATA_ONLY to get a successful response without the encrypted deﬁnition. Type: String Valid Values: ALL_DATA \| METADATA_ONLY Required: No Response Syntax { "definition": "string", "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string", "type": "string" }, "label": "string", "loggingConfiguration": { "destinations": [ { "cloudWatchLogsLogGroup": { "logGroupArn": "string" } } ], "includeExecutionData": boolean, "level": "string" }, "mapRunArn": "string", "name": "string", "revisionId": "string", "roleArn": "string", "stateMachineArn": "string", "tracingConfiguration": { "enabled": boolean }, "updateDate": number, "variableReferences": { "string" : [ "string" ] } Response Syntax API Version 2016-11-23 65 AWS Step Functions } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The
step-functions-api-016	step-functions-api.pdf	16	response without the encrypted deﬁnition. Type: String Valid Values: ALL_DATA \| METADATA_ONLY Required: No Response Syntax { "definition": "string", "encryptionConfiguration": { "kmsDataKeyReusePeriodSeconds": number, "kmsKeyId": "string", "type": "string" }, "label": "string", "loggingConfiguration": { "destinations": [ { "cloudWatchLogsLogGroup": { "logGroupArn": "string" } } ], "includeExecutionData": boolean, "level": "string" }, "mapRunArn": "string", "name": "string", "revisionId": "string", "roleArn": "string", "stateMachineArn": "string", "tracingConfiguration": { "enabled": boolean }, "updateDate": number, "variableReferences": { "string" : [ "string" ] } Response Syntax API Version 2016-11-23 65 AWS Step Functions } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. deﬁnition The Amazon States Language deﬁnition of the state machine. See Amazon States Language. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. encryptionConﬁguration Settings to conﬁgure server-side encryption. Type: EncryptionConﬁguration object label A user-deﬁned or an auto-generated string that identiﬁes a Map state. This ﬁeld is returned only if the executionArn is a child workﬂow execution that was started by a Distributed Map state. Type: String loggingConﬁguration The LoggingConfiguration data type is used to set CloudWatch Logs options. Type: LoggingConﬁguration object mapRunArn The Amazon Resource Name (ARN) of the Map Run that started the child workﬂow execution. This ﬁeld is returned only if the executionArn is a child workﬂow execution that was started by a Distributed Map state. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Response Elements API Version 2016-11-23 66 AWS Step Functions name API Reference The name of the state machine associated with the execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. revisionId The revision identiﬁer for the state machine. The ﬁrst revision ID when you create the state machine is null. Use the state machine revisionId parameter to compare the revision of a state machine with the conﬁguration of the state machine used for executions without performing a diﬀ of the properties, such as definition and roleArn. Type: String roleArn The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. stateMachineArn The Amazon Resource Name (ARN) of the state machine associated with the execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. tracingConﬁguration Selects whether AWS X-Ray tracing is enabled. Type: TracingConﬁguration object updateDate The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date. Response Elements API Version 2016-11-23 67 AWS Step Functions Type: Timestamp variableReferences API Reference A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response. Type: String to array of strings map Key Length Constraints: Minimum length of 1. Maximum length of 80. Errors For information about the errors that are common to all actions, see Common Errors. ExecutionDoesNotExist The speciﬁed execution does not exist. HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 KmsAccessDeniedException Either your AWS KMS key policy or API caller does not have the required permissions. HTTP Status Code: 400 KmsInvalidStateException The AWS KMS key is not in valid state, for example: Disabled or Deleted. HTTP Status Code: 400 KmsThrottlingException Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller. HTTP Status Code: 400 Errors API Version 2016-11-23 68 AWS Step Functions See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 69 AWS Step Functions GetActivityTask API Reference Used by workers to retrieve a task (with the speciﬁed activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Note This API action isn't logged in CloudTrail. Important Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher
step-functions-api-017	step-functions-api.pdf	17	has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Note This API action isn't logged in CloudTrail. Important Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide. Request Syntax { "activityArn": "string", "workerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. activityArn The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.) GetActivityTask API Version 2016-11-23 70 AWS Step Functions Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes workerName You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. Required: No Response Syntax { "input": "string", "taskToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. input The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. Type: String Length Constraints: Maximum length of 262144. taskToken A token that identiﬁes the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task. Response Syntax API Version 2016-11-23 71 AWS Step Functions Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. ActivityDoesNotExist The speciﬁed activity does not exist. HTTP Status Code: 400 ActivityWorkerLimitExceeded The maximum number of workers concurrently polling for activity tasks has been reached. HTTP Status Code: 400 InvalidArn The provided Amazon Resource Name (ARN) is not valid. HTTP Status Code: 400 KmsAccessDeniedException Either your AWS KMS key policy or API caller does not have the required permissions. HTTP Status Code: 400 KmsInvalidStateException The AWS KMS key is not in valid state, for example: Disabled or Deleted. HTTP Status Code: 400 KmsThrottlingException Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller. HTTP Status Code: 400 Errors API Version 2016-11-23 72 AWS Step Functions See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-23 73 AWS Step Functions API Reference GetExecutionHistory Returns the history of the speciﬁed execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events ﬁrst. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This API action is not supported by EXPRESS state machines. Request Syntax { "executionArn": "string", "includeExecutionData": boolean, "maxResults": number, "nextToken": "string", "reverseOrder": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. executionArn The Amazon Resource Name (ARN) of the execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes includeExecutionData You can select whether execution data (input or output of a history event) is returned. The default is true. GetExecutionHistory API Version 2016-11-23 74 AWS Step Functions Type: Boolean Required: No
step-functions-api-018	step-functions-api.pdf	18	not supported by EXPRESS state machines. Request Syntax { "executionArn": "string", "includeExecutionData": boolean, "maxResults": number, "nextToken": "string", "reverseOrder": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. executionArn The Amazon Resource Name (ARN) of the execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes includeExecutionData You can select whether execution data (input or output of a history event) is returned. The default is true. GetExecutionHistory API Version 2016-11-23 74 AWS Step Functions Type: Boolean Required: No maxResults API Reference The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the speciﬁed maximum. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1000. Required: No nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No reverseOrder Lists events in descending order of their timeStamp. Type: Boolean Required: No Response Syntax { "events": [ { Response Syntax API Version 2016-11-23 75 AWS Step Functions API Reference "activityFailedEventDetails": { "cause": "string", "error": "string" }, "activityScheduledEventDetails": { "heartbeatInSeconds": number, "input": "string", "inputDetails": { "truncated": boolean }, "resource": "string", "timeoutInSeconds": number }, "activityScheduleFailedEventDetails": { "cause": "string", "error": "string" }, "activityStartedEventDetails": { "workerName": "string" }, "activitySucceededEventDetails": { "output": "string", "outputDetails": { "truncated": boolean } }, "activityTimedOutEventDetails": { "cause": "string", "error": "string" }, "evaluationFailedEventDetails": { "cause": "string", "error": "string", "location": "string", "state": "string" }, "executionAbortedEventDetails": { "cause": "string", "error": "string" }, "executionFailedEventDetails": { "cause": "string", "error": "string" }, Response Syntax API Version 2016-11-23 76 AWS Step Functions API Reference "executionRedrivenEventDetails": { "redriveCount": number }, "executionStartedEventDetails": { "input": "string", "inputDetails": { "truncated": boolean }, "roleArn": "string", "stateMachineAliasArn": "string", "stateMachineVersionArn": "string" }, "executionSucceededEventDetails": { "output": "string", "outputDetails": { "truncated": boolean } }, "executionTimedOutEventDetails": { "cause": "string", "error": "string" }, "id": number, "lambdaFunctionFailedEventDetails": { "cause": "string", "error": "string" }, "lambdaFunctionScheduledEventDetails": { "input": "string", "inputDetails": { "truncated": boolean }, "resource": "string", "taskCredentials": { "roleArn": "string" }, "timeoutInSeconds": number }, "lambdaFunctionScheduleFailedEventDetails": { "cause": "string", "error": "string" }, "lambdaFunctionStartFailedEventDetails": { "cause": "string", Response Syntax API Version 2016-11-23 77 AWS Step Functions API Reference "error": "string" }, "lambdaFunctionSucceededEventDetails": { "output": "string", "outputDetails": { "truncated": boolean } }, "lambdaFunctionTimedOutEventDetails": { "cause": "string", "error": "string" }, "mapIterationAbortedEventDetails": { "index": number, "name": "string" }, "mapIterationFailedEventDetails": { "index": number, "name": "string" }, "mapIterationStartedEventDetails": { "index": number, "name": "string" }, "mapIterationSucceededEventDetails": { "index": number, "name": "string" }, "mapRunFailedEventDetails": { "cause": "string", "error": "string" }, "mapRunRedrivenEventDetails": { "mapRunArn": "string", "redriveCount": number }, "mapRunStartedEventDetails": { "mapRunArn": "string" }, "mapStateStartedEventDetails": { "length": number }, "previousEventId": number, "stateEnteredEventDetails": { Response Syntax API Version 2016-11-23 78 AWS Step Functions API Reference "input": "string", "inputDetails": { "truncated": boolean }, "name": "string" }, "stateExitedEventDetails": { "assignedVariables": { "string" : "string" }, "assignedVariablesDetails": { "truncated": boolean }, "name": "string", "output": "string", "outputDetails": { "truncated": boolean } }, "taskFailedEventDetails": { "cause": "string", "error": "string", "resource": "string", "resourceType": "string" }, "taskScheduledEventDetails": { "heartbeatInSeconds": number, "parameters": "string", "region": "string", "resource": "string", "resourceType": "string", "taskCredentials": { "roleArn": "string" }, "timeoutInSeconds": number }, "taskStartedEventDetails": { "resource": "string", "resourceType": "string" }, "taskStartFailedEventDetails": { "cause": "string", "error": "string", "resource": "string", Response Syntax API Version 2016-11-23 79 AWS Step Functions API Reference "resourceType": "string" }, "taskSubmitFailedEventDetails": { "cause": "string", "error": "string", "resource": "string", "resourceType": "string" }, "taskSubmittedEventDetails": { "output": "string", "outputDetails": { "truncated": boolean }, "resource": "string", "resourceType": "string" }, "taskSucceededEventDetails": { "output": "string", "outputDetails": { "truncated": boolean }, "resource": "string", "resourceType": "string" }, "taskTimedOutEventDetails": { "cause": "string", "error": "string", "resource": "string", "resourceType": "string" }, "timestamp": number, "type": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2016-11-23 80 AWS Step Functions events The list of events that occurred in the execution. Type: Array of HistoryEvent objects nextToken API Reference If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.