Actions, resources, and condition keys for AWS Identity Store - Service Authorization Reference

Actions, resources, and condition keys for AWS Identity Store

AWS Identity Store (service prefix: identitystore) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS Identity Store

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
CreateGroup Grants permission to create a group in the specified IdentityStore Write

Identitystore*

CreateGroupMembership Grants permission to create a member to a group in the specified IdentityStore Write

Group*

Identitystore*

User*

CreateUser Grants permission to create a user in the specified IdentityStore Write

Identitystore*

DeleteGroup Grants permission to delete a group in the specified IdentityStore Write

Group*

Identitystore*

DeleteGroupMembership Grants permission to remove a member that is part of a group in the specified IdentityStore Write

Group*

GroupMembership*

Identitystore*

User*

DeleteUser Grants permission to delete a user in the specified IdentityStore Write

Identitystore*

User*

DescribeGroup Grants permission to retrieve information about a group in the specified IdentityStore Read

Group*

Identitystore*

DescribeGroupMembership Grants permission to retrieve information about a member that is part of a group in the specified IdentityStore Read

Group*

GroupMembership*

Identitystore*

User*

DescribeUser Grants permission to retrieve information about user in the specified IdentityStore Read

Identitystore*

User*

GetGroupId Grants permission to retrieve ID information about group in the specified IdentityStore Read

Group*

Identitystore*

GetGroupMembershipId Grants permission to retrieve ID information of a member which is part of a group in the specified IdentityStore Read

Group*

GroupMembership*

Identitystore*

User*

GetUserId Grants permission to retrieves ID information about user in the specified IdentityStore Read

Identitystore*

User*

IsMemberInGroups Grants permission to check if a member is a part of groups in the specified IdentityStore Read

AllGroupMemberships*

Group*

Identitystore*

User*

ListGroupMemberships Grants permission to retrieve all members that are part of a group in the specified IdentityStore List

AllGroupMemberships*

Group*

Identitystore*

ListGroupMembershipsForMember Grants permission to list groups of the target member in the specified IdentityStore List

AllGroupMemberships*

Identitystore*

User*

ListGroups Grants permission to search for groups within the specified IdentityStore List

AllGroups*

Identitystore*

ListUsers Grants permission to search for users in the specified IdentityStore List

AllUsers*

Identitystore*

UpdateGroup Grants permission to update information about a group in the specified IdentityStore Write

Group*

Identitystore*

UpdateUser Grants permission to update user information in the specified IdentityStore Write

Identitystore*

User*

Resource types defined by AWS Identity Store

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types ARN Condition keys
Identitystore arn:${Partition}:identitystore::${Account}:identitystore/${IdentityStoreId}
User arn:${Partition}:identitystore:::user/${UserId}
Group arn:${Partition}:identitystore:::group/${GroupId}
GroupMembership arn:${Partition}:identitystore:::membership/${MembershipId}
AllUsers arn:${Partition}:identitystore:::user/*
AllGroups arn:${Partition}:identitystore:::group/*
AllGroupMemberships arn:${Partition}:identitystore:::membership/*

Condition keys for AWS Identity Store

AWS Identity Store defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
identitystore:UserId Filters access by IAM Identity Center User ID String