2026/09/29 - AWS SSO Identity Store - 3 new 17 updated api methods
Changes Add support for network access controls to restrict Identity Store API and SCIM access to trusted networks, optimistic locking for users and groups via resource revisions, and resource ARNs as identifiers in requests.
Updates the configuration of the specified identity store, including its network configuration.
See also: AWS API Documentation
Request Syntax
client.update_identity_store(
IdentityStoreId='string',
NetworkConfiguration={
'VpceAccessRequired': True|False,
'ApiRestrictSourceVpcs': [
'string',
],
'ApiAllowSourceIps': [
'string',
],
'ScimAllowSourceIps': [
'string',
]
}
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
dict
The network configuration to apply to the identity store. This controls whether access through a virtual private cloud (VPC) endpoint is required and the source VPCs and IP addresses that are allowed to access the identity store.
When you provide NetworkConfiguration in a request, the service performs a full replacement of the identity store's current network configuration with the values you specify. Any values that you omit are cleared. To preserve or change the allowed source VPCs or IP address ranges, include the complete set of values that you want in the request. To clear a list, omit it; an empty list is not accepted.
VpceAccessRequired (boolean) -- [REQUIRED]
Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.
This value must be set to either true or false when you provide NetworkConfiguration in a request.
ApiRestrictSourceVpcs (list) --
A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if you specified one. If you don't specify a value, access isn't restricted to specific VPCs, but the VPC endpoint requirement set by VpceAccessRequired still applies.
(string) --
ApiAllowSourceIps (list) --
A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by VpceAccessRequired, and even if it doesn't originate from a VPC in ApiRestrictSourceVpcs. If you don't specify a value, no such IP address exception applies.
(string) --
ScimAllowSourceIps (list) --
A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If you don't specify a value, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement set by VpceAccessRequired.
For example, to allow SCIM traffic from the public internet while still requiring the identity store API operations to be accessed through a VPC endpoint, set VpceAccessRequired to true and set this value to 0.0.0.0/0.
(string) --
dict
Response Syntax
{
'IdentityStoreId': 'string',
'IdentityStoreArn': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
IdentityStoreArn (string) --
The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.
Lists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To obtain additional information about an identity store, call DescribeIdentityStore.
This operation returns results in paginated form. Use the NextToken parameter to retrieve additional pages of results.
See also: AWS API Documentation
Request Syntax
client.list_identity_stores(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return per request. This parameter is used in all List operations to specify how many results to return on one page. If you don't specify a value, the operation uses a default page size.
string
The pagination token used for the ListIdentityStores API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
dict
Response Syntax
{
'IdentityStores': [
{
'IdentityStoreId': 'string',
'IdentityStoreArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IdentityStores (list) --
A list of IdentityStore objects, each of which contains the identifiers for an identity store that you have access to.
(dict) --
A structure that contains the identifiers for an identity store: its globally unique identifier (ID) and Amazon Resource Name (ARN).
IdentityStoreId (string) --
The globally unique identifier for the identity store.
IdentityStoreArn (string) --
The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.
NextToken (string) --
The pagination token used for the ListIdentityStores API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.
See also: AWS API Documentation
Request Syntax
client.describe_identity_store(
IdentityStoreId='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'IdentityStoreArn': 'string',
'NetworkConfiguration': {
'VpceAccessRequired': True|False,
'ApiRestrictSourceVpcs': [
'string',
],
'ApiAllowSourceIps': [
'string',
],
'ScimAllowSourceIps': [
'string',
]
}
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
IdentityStoreArn (string) --
The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.
NetworkConfiguration (dict) --
The network configuration of the identity store. This configuration controls whether access through a virtual private cloud (VPC) endpoint is required, and which source VPCs and IP addresses are allowed.
VpceAccessRequired (boolean) --
Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.
ApiRestrictSourceVpcs (list) --
A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if one is configured. If this field is empty, access isn't restricted to specific VPCs, but the VPC endpoint requirement from VpceAccessRequired still applies.
(string) --
ApiAllowSourceIps (list) --
A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by VpceAccessRequired, and even if it doesn't originate from a VPC in ApiRestrictSourceVpcs. If this field is empty, no such IP address exception applies.
(string) --
ScimAllowSourceIps (list) --
A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If this field is empty, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement.
(string) --
{'GroupArn': 'string', 'Revision': 'string'}
Creates a group within the specified identity store.
See also: AWS API Documentation
Request Syntax
client.create_group(
IdentityStoreId='string',
DisplayName='string',
Description='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
A string containing the name of the group. This value is commonly displayed when the group is referenced. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.
string
A string containing the description of the group.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'GroupId': 'string',
'GroupArn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
GroupId (string) --
The identifier of the newly created group in the identity store.
GroupArn (string) --
The Amazon Resource Name (ARN) of the newly created group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Revision (string) --
The revision of the newly created group in the identity store.
{'MembershipArn': 'string'}
Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.
See also: AWS API Documentation
Request Syntax
client.create_group_membership(
IdentityStoreId='string',
GroupId='string',
MemberId={
'UserId': 'string'
}
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
dict
[REQUIRED]
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
UserId (string) --
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'MembershipId': 'string',
'MembershipArn': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
MembershipId (string) --
The identifier for a newly created GroupMembership in an identity store.
MembershipArn (string) --
The Amazon Resource Name (ARN) of the newly created group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
{'Revision': 'string', 'UserArn': 'string'}
Creates a user within the specified identity store.
See also: AWS API Documentation
Request Syntax
client.create_user(
IdentityStoreId='string',
UserName='string',
Name={
'Formatted': 'string',
'FamilyName': 'string',
'GivenName': 'string',
'MiddleName': 'string',
'HonorificPrefix': 'string',
'HonorificSuffix': 'string'
},
DisplayName='string',
NickName='string',
ProfileUrl='string',
Emails=[
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
Addresses=[
{
'StreetAddress': 'string',
'Locality': 'string',
'Region': 'string',
'PostalCode': 'string',
'Country': 'string',
'Formatted': 'string',
'Type': 'string',
'Primary': True|False
},
],
PhoneNumbers=[
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
UserType='string',
Title='string',
PreferredLanguage='string',
Locale='string',
Timezone='string',
Photos=[
{
'Value': 'string',
'Type': 'string',
'Display': 'string',
'Primary': True|False
},
],
Website='string',
Birthdate='string',
Roles=[
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
Extensions={
'string': {...}|[...]|123|123.4|'string'|True|None
}
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.
dict
An object containing the name of the user. When used in IAM Identity Center, this parameter is required.
Formatted (string) --
A string containing a formatted version of the name for display.
FamilyName (string) --
The family name of the user.
GivenName (string) --
The given name of the user.
MiddleName (string) --
The middle name of the user.
HonorificPrefix (string) --
The honorific prefix of the user. For example, "Dr."
HonorificSuffix (string) --
The honorific suffix of the user. For example, "M.D."
string
A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe." When used in IAM Identity Center, this parameter is required.
string
A string containing an alternate name for the user.
string
A string containing a URL that might be associated with the user.
list
A list of Email objects containing email addresses associated with the user.
(dict) --
The email address associated with the user.
Value (string) --
A string containing an email address. For example, "johndoe@amazon.com."
Type (string) --
A string representing the type of address. For example, "Work."
Primary (boolean) --
A Boolean value representing whether this is the primary email address for the associated resource.
list
A list of Address objects containing addresses associated with the user.
(dict) --
The address associated with the specified user.
StreetAddress (string) --
The street of the address.
Locality (string) --
A string of the address locality.
Region (string) --
The region of the address.
PostalCode (string) --
The postal code of the address.
Country (string) --
The country of the address.
Formatted (string) --
A string containing a formatted version of the address for display.
Type (string) --
A string representing the type of address. For example, "Home."
Primary (boolean) --
A Boolean value representing whether this is the primary address for the associated resource.
list
A list of PhoneNumber objects containing phone numbers associated with the user.
(dict) --
The phone number associated with the user.
Value (string) --
A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".
Type (string) --
A string representing the type of a phone number. For example, "Mobile."
Primary (boolean) --
A Boolean value representing whether this is the primary phone number for the associated resource.
string
A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
string
A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
string
A string containing the preferred language of the user. For example, "American English" or "en-us."
string
A string containing the geographical region or location of the user.
string
A string containing the time zone of the user.
list
A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.
(dict) --
Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.
Value (string) -- [REQUIRED]
The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.
Type (string) --
The type of photo. This field is optional and can be used to categorize different types of photos.
Display (string) --
A human-readable description of the photo for display purposes. This optional field provides context about the photo.
Primary (boolean) --
Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.
string
The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.
string
The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.
list
A list of Role objects containing roles associated with the user.
(dict) --
The role associated with the user.
Value (string) --
A string containing a role name. For example, "Researcher."
Type (string) --
A string representing the type of role. For example, "Work."
Primary (boolean) --
A Boolean value representing whether this is the primary role for the associated resource.
dict
A map with additional attribute extensions for the user. Each map key corresponds to an extension name, while map values represent extension data in Document type (not supported by Java V1, Go V1 and older versions of the CLI). aws:identitystore:enterprise is the only supported extension name.
(string) --
(:ref:`document<document>`) --
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'UserId': 'string',
'UserArn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
UserId (string) --
The identifier of the newly created user in the identity store.
UserArn (string) --
The Amazon Resource Name (ARN) of the newly created user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Revision (string) --
The revision of the newly created user in the identity store.
{'Revision': 'string'}
Delete a group within an identity store given GroupId.
See also: AWS API Documentation
Request Syntax
client.delete_group(
IdentityStoreId='string',
GroupId='string',
Revision='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
string
The expected current revision of the group. When you provide this value, the group is deleted only if it matches the current revision of the group in the identity store. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the group is deleted regardless of its current revision.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Revision': 'string'}
Deletes a user within an identity store given UserId.
See also: AWS API Documentation
Request Syntax
client.delete_user(
IdentityStoreId='string',
UserId='string',
Revision='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
string
The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the user is deleted regardless of its current revision.
dict
Response Syntax
{}
Response Structure
(dict) --
{'GroupArn': 'string', 'Revision': 'string'}
Retrieves the group metadata and attributes from GroupId in an identity store.
See also: AWS API Documentation
Request Syntax
client.describe_group(
IdentityStoreId='string',
GroupId='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'GroupId': 'string',
'GroupArn': 'string',
'Revision': 'string',
'DisplayName': 'string',
'ExternalIds': [
{
'Issuer': 'string',
'Id': 'string'
},
],
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedBy': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
GroupId (string) --
The identifier for a group in the identity store.
GroupArn (string) --
The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Revision (string) --
The current revision of the group in the identity store. This value changes each time the group is modified.
DisplayName (string) --
The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.
ExternalIds (list) --
A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
(dict) --
The identifier issued to this resource by an external identity provider.
Issuer (string) --
The issuer for an external identifier.
Id (string) --
The identifier issued to this resource by an external identity provider.
Description (string) --
A string containing a description of the group.
CreatedAt (datetime) --
The date and time the group was created.
UpdatedAt (datetime) --
The date and time the group was last updated.
CreatedBy (string) --
The identifier of the user or system that created the group.
UpdatedBy (string) --
The identifier of the user or system that last updated the group.
{'MembershipArn': 'string'}
Retrieves membership metadata and attributes from MembershipId in an identity store.
See also: AWS API Documentation
Request Syntax
client.describe_group_membership(
IdentityStoreId='string',
MembershipId='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a GroupMembership in an identity store.
You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 or membership ARN arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'MembershipId': 'string',
'MembershipArn': 'string',
'GroupId': 'string',
'MemberId': {
'UserId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedBy': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
MembershipId (string) --
The identifier for a GroupMembership in an identity store.
MembershipArn (string) --
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
GroupId (string) --
The identifier for a group in the identity store.
MemberId (dict) --
An object containing the identifier of a group member.
UserId (string) --
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
CreatedAt (datetime) --
The date and time the group membership was created.
UpdatedAt (datetime) --
The date and time the group membership was last updated.
CreatedBy (string) --
The identifier of the user or system that created the group membership.
UpdatedBy (string) --
The identifier of the user or system that last updated the group membership.
{'Revision': 'string', 'UserArn': 'string'}
Retrieves the user metadata and attributes from the UserId in an identity store.
See also: AWS API Documentation
Request Syntax
client.describe_user(
IdentityStoreId='string',
UserId='string',
Extensions=[
'string',
]
)
string
[REQUIRED]
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
list
A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.
(string) --
dict
Response Syntax
{
'IdentityStoreId': 'string',
'UserId': 'string',
'UserArn': 'string',
'Revision': 'string',
'UserName': 'string',
'ExternalIds': [
{
'Issuer': 'string',
'Id': 'string'
},
],
'Name': {
'Formatted': 'string',
'FamilyName': 'string',
'GivenName': 'string',
'MiddleName': 'string',
'HonorificPrefix': 'string',
'HonorificSuffix': 'string'
},
'DisplayName': 'string',
'NickName': 'string',
'ProfileUrl': 'string',
'Emails': [
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
'Addresses': [
{
'StreetAddress': 'string',
'Locality': 'string',
'Region': 'string',
'PostalCode': 'string',
'Country': 'string',
'Formatted': 'string',
'Type': 'string',
'Primary': True|False
},
],
'PhoneNumbers': [
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
'UserType': 'string',
'Title': 'string',
'PreferredLanguage': 'string',
'Locale': 'string',
'Timezone': 'string',
'UserStatus': 'ENABLED'|'DISABLED',
'Photos': [
{
'Value': 'string',
'Type': 'string',
'Display': 'string',
'Primary': True|False
},
],
'Website': 'string',
'Birthdate': 'string',
'Roles': [
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'UpdatedBy': 'string',
'Extensions': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
UserId (string) --
The identifier for a user in the identity store.
UserArn (string) --
The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Revision (string) --
The current revision of the user in the identity store. This value changes each time the user is modified.
UserName (string) --
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
ExternalIds (list) --
A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
(dict) --
The identifier issued to this resource by an external identity provider.
Issuer (string) --
The issuer for an external identifier.
Id (string) --
The identifier issued to this resource by an external identity provider.
Name (dict) --
The name of the user.
Formatted (string) --
A string containing a formatted version of the name for display.
FamilyName (string) --
The family name of the user.
GivenName (string) --
The given name of the user.
MiddleName (string) --
The middle name of the user.
HonorificPrefix (string) --
The honorific prefix of the user. For example, "Dr."
HonorificSuffix (string) --
The honorific suffix of the user. For example, "M.D."
DisplayName (string) --
The display name of the user.
NickName (string) --
An alternative descriptive name for the user.
ProfileUrl (string) --
A URL link for the user's profile.
Emails (list) --
The email address of the user.
(dict) --
The email address associated with the user.
Value (string) --
A string containing an email address. For example, "johndoe@amazon.com."
Type (string) --
A string representing the type of address. For example, "Work."
Primary (boolean) --
A Boolean value representing whether this is the primary email address for the associated resource.
Addresses (list) --
The physical address of the user.
(dict) --
The address associated with the specified user.
StreetAddress (string) --
The street of the address.
Locality (string) --
A string of the address locality.
Region (string) --
The region of the address.
PostalCode (string) --
The postal code of the address.
Country (string) --
The country of the address.
Formatted (string) --
A string containing a formatted version of the address for display.
Type (string) --
A string representing the type of address. For example, "Home."
Primary (boolean) --
A Boolean value representing whether this is the primary address for the associated resource.
PhoneNumbers (list) --
A list of PhoneNumber objects associated with a user.
(dict) --
The phone number associated with the user.
Value (string) --
A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".
Type (string) --
A string representing the type of a phone number. For example, "Mobile."
Primary (boolean) --
A Boolean value representing whether this is the primary phone number for the associated resource.
UserType (string) --
A string indicating the type of user.
Title (string) --
A string containing the title of the user.
PreferredLanguage (string) --
The preferred language of the user.
Locale (string) --
A string containing the geographical region or location of the user.
Timezone (string) --
The time zone for a user.
UserStatus (string) --
The current status of the user account.
Photos (list) --
A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.
(dict) --
Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.
Value (string) --
The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.
Type (string) --
The type of photo. This field is optional and can be used to categorize different types of photos.
Display (string) --
A human-readable description of the photo for display purposes. This optional field provides context about the photo.
Primary (boolean) --
Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.
Website (string) --
The user's personal website or blog URL. Returns the stored website information for the user.
Birthdate (string) --
The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.
Roles (list) --
The roles of the user.
(dict) --
The role associated with the user.
Value (string) --
A string containing a role name. For example, "Researcher."
Type (string) --
A string representing the type of role. For example, "Work."
Primary (boolean) --
A Boolean value representing whether this is the primary role for the associated resource.
CreatedAt (datetime) --
The date and time the user was created.
CreatedBy (string) --
The identifier of the user or system that created the user.
UpdatedAt (datetime) --
The date and time the user was last updated.
UpdatedBy (string) --
The identifier of the user or system that last updated the user.
Extensions (dict) --
A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.
(string) --
(:ref:`document<document>`) --
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
{'GroupArn': 'string'}
Retrieves GroupId in an identity store.
See also: AWS API Documentation
Request Syntax
client.get_group_id(
IdentityStoreId='string',
AlternateIdentifier={
'ExternalId': {
'Issuer': 'string',
'Id': 'string'
},
'UniqueAttribute': {
'AttributePath': 'string',
'AttributeValue': {...}|[...]|123|123.4|'string'|True|None
}
}
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
dict
[REQUIRED]
A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.
ExternalId (dict) --
The identifier issued to this resource by an external identity provider.
Issuer (string) -- [REQUIRED]
The issuer for an external identifier.
Id (string) -- [REQUIRED]
The identifier issued to this resource by an external identity provider.
UniqueAttribute (dict) --
An entity attribute that's unique to a specific entity.
AttributePath (string) -- [REQUIRED]
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
AttributeValue (:ref:`document<document>`) -- [REQUIRED]
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'GroupId': 'string',
'GroupArn': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
GroupId (string) --
The identifier for a group in the identity store.
GroupArn (string) --
The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
{'MembershipArn': 'string'}
Retrieves the MembershipId in an identity store.
See also: AWS API Documentation
Request Syntax
client.get_group_membership_id(
IdentityStoreId='string',
GroupId='string',
MemberId={
'UserId': 'string'
}
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
dict
[REQUIRED]
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
UserId (string) --
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'MembershipId': 'string',
'MembershipArn': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
MembershipId (string) --
The identifier for a GroupMembership in an identity store.
MembershipArn (string) --
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
{'UserArn': 'string'}
Retrieves the UserId in an identity store.
See also: AWS API Documentation
Request Syntax
client.get_user_id(
IdentityStoreId='string',
AlternateIdentifier={
'ExternalId': {
'Issuer': 'string',
'Id': 'string'
},
'UniqueAttribute': {
'AttributePath': 'string',
'AttributeValue': {...}|[...]|123|123.4|'string'|True|None
}
}
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
dict
[REQUIRED]
A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are userName and emails.value.
ExternalId (dict) --
The identifier issued to this resource by an external identity provider.
Issuer (string) -- [REQUIRED]
The issuer for an external identifier.
Id (string) -- [REQUIRED]
The identifier issued to this resource by an external identity provider.
UniqueAttribute (dict) --
An entity attribute that's unique to a specific entity.
AttributePath (string) -- [REQUIRED]
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
AttributeValue (:ref:`document<document>`) -- [REQUIRED]
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'UserId': 'string',
'UserArn': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
UserId (string) --
The identifier for a user in the identity store.
UserArn (string) --
The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
{'GroupMemberships': {'MembershipArn': 'string'}}
For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
See also: AWS API Documentation
Request Syntax
client.list_group_memberships(
IdentityStoreId='string',
GroupId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
integer
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
string
The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
dict
Response Syntax
{
'GroupMemberships': [
{
'IdentityStoreId': 'string',
'MembershipId': 'string',
'MembershipArn': 'string',
'GroupId': 'string',
'MemberId': {
'UserId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GroupMemberships (list) --
A list of GroupMembership objects in the group.
(dict) --
Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.
IdentityStoreId (string) --
The globally unique identifier for the identity store.
MembershipId (string) --
The identifier for a GroupMembership object in an identity store.
MembershipArn (string) --
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
GroupId (string) --
The identifier for a group in the identity store.
MemberId (dict) --
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
UserId (string) --
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
CreatedAt (datetime) --
The date and time the group membership was created.
UpdatedAt (datetime) --
The date and time the group membership was last updated.
CreatedBy (string) --
The identifier of the user or system that created the group membership.
UpdatedBy (string) --
The identifier of the user or system that last updated the group membership.
NextToken (string) --
The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
{'GroupMemberships': {'MembershipArn': 'string'}}
For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
See also: AWS API Documentation
Request Syntax
client.list_group_memberships_for_member(
IdentityStoreId='string',
MemberId={
'UserId': 'string'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
dict
[REQUIRED]
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
UserId (string) --
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
integer
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
string
The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
dict
Response Syntax
{
'GroupMemberships': [
{
'IdentityStoreId': 'string',
'MembershipId': 'string',
'MembershipArn': 'string',
'GroupId': 'string',
'MemberId': {
'UserId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GroupMemberships (list) --
A list of GroupMembership objects in the group for a specified member.
(dict) --
Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.
IdentityStoreId (string) --
The globally unique identifier for the identity store.
MembershipId (string) --
The identifier for a GroupMembership object in an identity store.
MembershipArn (string) --
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
GroupId (string) --
The identifier for a group in the identity store.
MemberId (dict) --
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
UserId (string) --
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
CreatedAt (datetime) --
The date and time the group membership was created.
UpdatedAt (datetime) --
The date and time the group membership was last updated.
CreatedBy (string) --
The identifier of the user or system that created the group membership.
UpdatedBy (string) --
The identifier of the user or system that last updated the group membership.
NextToken (string) --
The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
{'Groups': {'GroupArn': 'string', 'Revision': 'string'}}
Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.
See also: AWS API Documentation
Request Syntax
client.list_groups(
IdentityStoreId='string',
MaxResults=123,
NextToken='string',
Filters=[
{
'AttributePath': 'string',
'AttributeValue': 'string'
},
]
)
string
[REQUIRED]
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
integer
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
string
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
list
A list of Filter objects, which is used in the ListUsers and ListGroups requests.
(dict) --
A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.
AttributePath (string) -- [REQUIRED]
The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
AttributeValue (string) -- [REQUIRED]
Represents the data for an attribute. Each attribute value is described as a name-value pair.
dict
Response Syntax
{
'Groups': [
{
'IdentityStoreId': 'string',
'GroupId': 'string',
'GroupArn': 'string',
'Revision': 'string',
'DisplayName': 'string',
'ExternalIds': [
{
'Issuer': 'string',
'Id': 'string'
},
],
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Groups (list) --
A list of Group objects in the identity store.
(dict) --
A group object that contains the metadata and attributes for a specified group.
IdentityStoreId (string) --
The globally unique identifier for the identity store.
GroupId (string) --
The identifier for a group in the identity store.
GroupArn (string) --
The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Revision (string) --
The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the Revision parameter of an UpdateGroup or DeleteGroup request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.
DisplayName (string) --
The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
Prefix search supports a maximum of 1,000 characters for the string.
ExternalIds (list) --
A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
(dict) --
The identifier issued to this resource by an external identity provider.
Issuer (string) --
The issuer for an external identifier.
Id (string) --
The identifier issued to this resource by an external identity provider.
Description (string) --
A string containing a description of the specified group.
CreatedAt (datetime) --
The date and time the group was created.
UpdatedAt (datetime) --
The date and time the group was last updated.
CreatedBy (string) --
The identifier of the user or system that created the group.
UpdatedBy (string) --
The identifier of the user or system that last updated the group.
NextToken (string) --
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
{'Users': {'Revision': 'string', 'UserArn': 'string'}}
Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.
See also: AWS API Documentation
Request Syntax
client.list_users(
IdentityStoreId='string',
Extensions=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'AttributePath': 'string',
'AttributeValue': 'string'
},
]
)
string
[REQUIRED]
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
list
A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.
(string) --
integer
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
string
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
list
A list of Filter objects, which is used in the ListUsers and ListGroups requests.
(dict) --
A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.
AttributePath (string) -- [REQUIRED]
The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
AttributeValue (string) -- [REQUIRED]
Represents the data for an attribute. Each attribute value is described as a name-value pair.
dict
Response Syntax
{
'Users': [
{
'IdentityStoreId': 'string',
'UserId': 'string',
'UserArn': 'string',
'Revision': 'string',
'UserName': 'string',
'ExternalIds': [
{
'Issuer': 'string',
'Id': 'string'
},
],
'Name': {
'Formatted': 'string',
'FamilyName': 'string',
'GivenName': 'string',
'MiddleName': 'string',
'HonorificPrefix': 'string',
'HonorificSuffix': 'string'
},
'DisplayName': 'string',
'NickName': 'string',
'ProfileUrl': 'string',
'Emails': [
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
'Addresses': [
{
'StreetAddress': 'string',
'Locality': 'string',
'Region': 'string',
'PostalCode': 'string',
'Country': 'string',
'Formatted': 'string',
'Type': 'string',
'Primary': True|False
},
],
'PhoneNumbers': [
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
'UserType': 'string',
'Title': 'string',
'PreferredLanguage': 'string',
'Locale': 'string',
'Timezone': 'string',
'UserStatus': 'ENABLED'|'DISABLED',
'Photos': [
{
'Value': 'string',
'Type': 'string',
'Display': 'string',
'Primary': True|False
},
],
'Website': 'string',
'Birthdate': 'string',
'Roles': [
{
'Value': 'string',
'Type': 'string',
'Primary': True|False
},
],
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'UpdatedBy': 'string',
'Extensions': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Users (list) --
A list of User objects in the identity store.
(dict) --
A user object that contains the metadata and attributes for a specified user.
IdentityStoreId (string) --
The globally unique identifier for the identity store.
UserId (string) --
The identifier for a user in the identity store.
UserArn (string) --
The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Revision (string) --
The current revision of the user in the identity store. This value changes each time the user is modified. You can provide it as the Revision parameter of an UpdateUser or DeleteUser request to make the operation conditional on the user not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.
UserName (string) --
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
ExternalIds (list) --
A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
(dict) --
The identifier issued to this resource by an external identity provider.
Issuer (string) --
The issuer for an external identifier.
Id (string) --
The identifier issued to this resource by an external identity provider.
Name (dict) --
An object containing the name of the user.
Formatted (string) --
A string containing a formatted version of the name for display.
FamilyName (string) --
The family name of the user.
GivenName (string) --
The given name of the user.
MiddleName (string) --
The middle name of the user.
HonorificPrefix (string) --
The honorific prefix of the user. For example, "Dr."
HonorificSuffix (string) --
The honorific suffix of the user. For example, "M.D."
DisplayName (string) --
A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."
Prefix search supports a maximum of 1,000 characters for the string.
NickName (string) --
A string containing an alternate name for the user.
ProfileUrl (string) --
A string containing a URL that might be associated with the user.
Emails (list) --
A list of Email objects containing email addresses associated with the user.
(dict) --
The email address associated with the user.
Value (string) --
A string containing an email address. For example, "johndoe@amazon.com."
Type (string) --
A string representing the type of address. For example, "Work."
Primary (boolean) --
A Boolean value representing whether this is the primary email address for the associated resource.
Addresses (list) --
A list of Address objects containing addresses associated with the user.
(dict) --
The address associated with the specified user.
StreetAddress (string) --
The street of the address.
Locality (string) --
A string of the address locality.
Region (string) --
The region of the address.
PostalCode (string) --
The postal code of the address.
Country (string) --
The country of the address.
Formatted (string) --
A string containing a formatted version of the address for display.
Type (string) --
A string representing the type of address. For example, "Home."
Primary (boolean) --
A Boolean value representing whether this is the primary address for the associated resource.
PhoneNumbers (list) --
A list of PhoneNumber objects containing phone numbers associated with the user.
(dict) --
The phone number associated with the user.
Value (string) --
A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".
Type (string) --
A string representing the type of a phone number. For example, "Mobile."
Primary (boolean) --
A Boolean value representing whether this is the primary phone number for the associated resource.
UserType (string) --
A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
Title (string) --
A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
PreferredLanguage (string) --
A string containing the preferred language of the user. For example, "American English" or "en-us."
Locale (string) --
A string containing the geographical region or location of the user.
Timezone (string) --
A string containing the time zone of the user.
UserStatus (string) --
The current status of the user account.
Photos (list) --
A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.
(dict) --
Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.
Value (string) --
The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.
Type (string) --
The type of photo. This field is optional and can be used to categorize different types of photos.
Display (string) --
A human-readable description of the photo for display purposes. This optional field provides context about the photo.
Primary (boolean) --
Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.
Website (string) --
The user's personal website or blog URL. This field stores website information for personal or professional use.
Birthdate (string) --
The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.
Roles (list) --
A list of Role objects containing roles associated with the user.
(dict) --
The role associated with the user.
Value (string) --
A string containing a role name. For example, "Researcher."
Type (string) --
A string representing the type of role. For example, "Work."
Primary (boolean) --
A Boolean value representing whether this is the primary role for the associated resource.
CreatedAt (datetime) --
The date and time the user was created.
CreatedBy (string) --
The identifier of the user or system that created the user.
UpdatedAt (datetime) --
The date and time the user was last updated.
UpdatedBy (string) --
The identifier of the user or system that last updated the user.
Extensions (dict) --
A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.
(string) --
(:ref:`document<document>`) --
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
NextToken (string) --
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
{'Revision': 'string'}
Response {'GroupArn': 'string',
'GroupId': 'string',
'IdentityStoreId': 'string',
'Revision': 'string'}
Updates the specified group metadata and attributes in the specified identity store.
See also: AWS API Documentation
Request Syntax
client.update_group(
IdentityStoreId='string',
GroupId='string',
Operations=[
{
'AttributePath': 'string',
'AttributeValue': {...}|[...]|123|123.4|'string'|True|None
},
],
Revision='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
list
[REQUIRED]
A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see Group.
(dict) --
An operation that applies to the requested group. This operation might add, replace, or remove an attribute.
AttributePath (string) -- [REQUIRED]
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
AttributeValue (:ref:`document<document>`) --
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
string
The expected current revision of the group. When you provide this value, the update is applied only if it matches the current revision of the group in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the update is applied unconditionally.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'GroupId': 'string',
'GroupArn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
GroupId (string) --
The identifier for a group in the identity store.
GroupArn (string) --
The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Revision (string) --
The revision of the group after the requested update is applied.
{'Revision': 'string'}
Response {'IdentityStoreId': 'string',
'Revision': 'string',
'UserArn': 'string',
'UserId': 'string'}
Updates the specified user metadata and attributes in the specified identity store.
See also: AWS API Documentation
Request Syntax
client.update_user(
IdentityStoreId='string',
UserId='string',
Operations=[
{
'AttributePath': 'string',
'AttributeValue': {...}|[...]|123|123.4|'string'|True|None
},
],
Revision='string'
)
string
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
string
[REQUIRED]
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
list
[REQUIRED]
A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see User.
(dict) --
An operation that applies to the requested group. This operation might add, replace, or remove an attribute.
AttributePath (string) -- [REQUIRED]
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
AttributeValue (:ref:`document<document>`) --
The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
string
The expected current revision of the user. When you provide this value, the update is applied only if it matches the current revision of the user in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the update is applied unconditionally.
dict
Response Syntax
{
'IdentityStoreId': 'string',
'UserId': 'string',
'UserArn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
IdentityStoreId (string) --
The globally unique identifier for the identity store.
UserId (string) --
The identifier for a user in the identity store.
UserArn (string) --
The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Revision (string) --
The revision of the user after the requested update is applied.