{ "version":"2.0", "metadata":{ "apiVersion":"2020-06-15", "endpointPrefix":"identitystore", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"IdentityStore", "serviceFullName":"AWS SSO Identity Store", "serviceId":"identitystore", "signatureVersion":"v4", "signingName":"identitystore", "targetPrefix":"AWSIdentityStore", "uid":"identitystore-2020-06-15" }, "operations":{ "CreateGroup":{ "name":"CreateGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGroupRequest"}, "output":{"shape":"CreateGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a group within the specified identity store.

" }, "CreateGroupMembership":{ "name":"CreateGroupMembership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGroupMembershipRequest"}, "output":{"shape":"CreateGroupMembershipResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a relationship between a member and a group. The following identifiers must be specified: `GroupId`, `IdentityStoreId`, and `MemberId`.

" }, "CreateUser":{ "name":"CreateUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserRequest"}, "output":{"shape":"CreateUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a user within the specified identity store.

" }, "DeleteGroup":{ "name":"DeleteGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGroupRequest"}, "output":{"shape":"DeleteGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Delete a group within an identity store given `GroupId`.

", "idempotent":true }, "DeleteGroupMembership":{ "name":"DeleteGroupMembership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGroupMembershipRequest"}, "output":{"shape":"DeleteGroupMembershipResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Delete a membership within a group given `MembershipId`.

", "idempotent":true }, "DeleteUser":{ "name":"DeleteUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserRequest"}, "output":{"shape":"DeleteUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes a user within an identity store given `UserId`.

", "idempotent":true }, "DescribeGroup":{ "name":"DescribeGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeGroupRequest"}, "output":{"shape":"DescribeGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves the group metadata and attributes from `GroupId` in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "DescribeGroupMembership":{ "name":"DescribeGroupMembership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeGroupMembershipRequest"}, "output":{"shape":"DescribeGroupMembershipResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves membership metadata and attributes from `MembershipId` in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "DescribeUser":{ "name":"DescribeUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserRequest"}, "output":{"shape":"DescribeUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves the user metadata and attributes from the `UserId` in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "GetGroupId":{ "name":"GetGroupId", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGroupIdRequest"}, "output":{"shape":"GetGroupIdResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves `GroupId` in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "GetGroupMembershipId":{ "name":"GetGroupMembershipId", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGroupMembershipIdRequest"}, "output":{"shape":"GetGroupMembershipIdResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves the `MembershipId` in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "GetUserId":{ "name":"GetUserId", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUserIdRequest"}, "output":{"shape":"GetUserIdResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves the `UserId` in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "IsMemberInGroups":{ "name":"IsMemberInGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"IsMemberInGroupsRequest"}, "output":{"shape":"IsMemberInGroupsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "ListGroupMemberships":{ "name":"ListGroupMemberships", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupMembershipsRequest"}, "output":{"shape":"ListGroupMembershipsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

For the specified group in the specified identity store, returns the list of all `GroupMembership` objects and returns results in paginated form.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "ListGroupMembershipsForMember":{ "name":"ListGroupMembershipsForMember", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupMembershipsForMemberRequest"}, "output":{"shape":"ListGroupMembershipsForMemberResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

For the specified member in the specified identity store, returns the list of all `GroupMembership` objects and returns results in paginated form.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "ListGroups":{ "name":"ListGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupsRequest"}, "output":{"shape":"ListGroupsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

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.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "ListUsers":{ "name":"ListUsers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUsersRequest"}, "output":{"shape":"ListUsersResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

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.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

" }, "UpdateGroup":{ "name":"UpdateGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGroupRequest"}, "output":{"shape":"UpdateGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

For the specified group in the specified identity store, updates the group metadata and attributes.

" }, "UpdateUser":{ "name":"UpdateUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserRequest"}, "output":{"shape":"UpdateUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

For the specified user in the specified identity store, updates the user metadata and attributes.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" } }, "documentation":"

You do not have sufficient access to perform this action.

", "exception":true }, "Address":{ "type":"structure", "members":{ "StreetAddress":{ "shape":"SensitiveStringType", "documentation":"

The street of the address.

" }, "Locality":{ "shape":"SensitiveStringType", "documentation":"

A string of the address locality.

" }, "Region":{ "shape":"SensitiveStringType", "documentation":"

The region of the address.

" }, "PostalCode":{ "shape":"SensitiveStringType", "documentation":"

The postal code of the address.

" }, "Country":{ "shape":"SensitiveStringType", "documentation":"

The country of the address.

" }, "Formatted":{ "shape":"SensitiveStringType", "documentation":"

A string containing a formatted version of the address for display.

" }, "Type":{ "shape":"SensitiveStringType", "documentation":"

A string representing the type of address. For example, \"Home.\"

" }, "Primary":{ "shape":"SensitiveBooleanType", "documentation":"

A Boolean value representing whether this is the primary address for the associated resource.

" } }, "documentation":"

The address associated with the specified user.

" }, "Addresses":{ "type":"list", "member":{"shape":"Address"}, "max":1, "min":1 }, "AlternateIdentifier":{ "type":"structure", "members":{ "ExternalId":{ "shape":"ExternalId", "documentation":"

The identifier issued to this resource by an external identity provider.

" }, "UniqueAttribute":{ "shape":"UniqueAttribute", "documentation":"

An entity attribute that's unique to a specific entity.

" } }, "documentation":"

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.

", "union":true }, "AttributeOperation":{ "type":"structure", "required":["AttributePath"], "members":{ "AttributePath":{ "shape":"AttributePath", "documentation":"

A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

" }, "AttributeValue":{ "shape":"AttributeValue", "documentation":"

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.

" } }, "documentation":"

An operation that applies to the requested group. This operation might add, replace, or remove an attribute.

" }, "AttributeOperations":{ "type":"list", "member":{"shape":"AttributeOperation"}, "max":100, "min":1 }, "AttributePath":{ "type":"string", "max":255, "min":1, "pattern":"\\p{L}+(?:\\.\\p{L}+){0,2}" }, "AttributeValue":{ "type":"structure", "members":{ }, "documentation":"

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.

", "document":true }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" }, "Reason":{ "shape":"ConflictExceptionReason", "documentation":"

This request cannot be completed for one of the following reasons:

- Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

- The requested resource was being concurrently modified by another request.

" } }, "documentation":"

This request cannot be completed for one of the following reasons:

- Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

- The requested resource was being concurrently modified by another request.

", "exception":true }, "ConflictExceptionReason":{ "type":"string", "enum":[ "UNIQUENESS_CONSTRAINT_VIOLATION", "CONCURRENT_MODIFICATION" ] }, "CreateGroupMembershipRequest":{ "type":"structure", "required":[ "IdentityStoreId", "GroupId", "MemberId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "MemberId":{ "shape":"MemberId", "documentation":"

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.

" } } }, "CreateGroupMembershipResponse":{ "type":"structure", "required":[ "MembershipId", "IdentityStoreId" ], "members":{ "MembershipId":{ "shape":"ResourceId", "documentation":"

The identifier for a newly created `GroupMembership` in an identity store.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "CreateGroupRequest":{ "type":"structure", "required":["IdentityStoreId"], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "DisplayName":{ "shape":"GroupDisplayName", "documentation":"

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.

" }, "Description":{ "shape":"SensitiveStringType", "documentation":"

A string containing the description of the group.

" } } }, "CreateGroupResponse":{ "type":"structure", "required":[ "GroupId", "IdentityStoreId" ], "members":{ "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier of the newly created group in the identity store.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "CreateUserRequest":{ "type":"structure", "required":["IdentityStoreId"], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "UserName":{ "shape":"UserName", "documentation":"

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.

" }, "Name":{ "shape":"Name", "documentation":"

An object containing the name of the user.

" }, "DisplayName":{ "shape":"SensitiveStringType", "documentation":"

A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, \"John Doe.\"

" }, "NickName":{ "shape":"SensitiveStringType", "documentation":"

A string containing an alternate name for the user.

" }, "ProfileUrl":{ "shape":"SensitiveStringType", "documentation":"

A string containing a URL that might be associated with the user.

" }, "Emails":{ "shape":"Emails", "documentation":"

A list of `Email` objects containing email addresses associated with the user.

" }, "Addresses":{ "shape":"Addresses", "documentation":"

A list of `Address` objects containing addresses associated with the user.

" }, "PhoneNumbers":{ "shape":"PhoneNumbers", "documentation":"

A list of `PhoneNumber` objects containing phone numbers associated with the user.

" }, "UserType":{ "shape":"SensitiveStringType", "documentation":"

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

" }, "Title":{ "shape":"SensitiveStringType", "documentation":"

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

" }, "PreferredLanguage":{ "shape":"SensitiveStringType", "documentation":"

A string containing the preferred language of the user. For example, \"American English\" or \"en-us.\"

" }, "Locale":{ "shape":"SensitiveStringType", "documentation":"

A string containing the geographical region or location of the user.

" }, "Timezone":{ "shape":"SensitiveStringType", "documentation":"

A string containing the time zone of the user.

" } } }, "CreateUserResponse":{ "type":"structure", "required":[ "UserId", "IdentityStoreId" ], "members":{ "UserId":{ "shape":"ResourceId", "documentation":"

The identifier of the newly created user in the identity store.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "DeleteGroupMembershipRequest":{ "type":"structure", "required":[ "IdentityStoreId", "MembershipId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "MembershipId":{ "shape":"ResourceId", "documentation":"

The identifier for a `GroupMembership` in an identity store.

" } } }, "DeleteGroupMembershipResponse":{ "type":"structure", "members":{ } }, "DeleteGroupRequest":{ "type":"structure", "required":[ "IdentityStoreId", "GroupId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" } } }, "DeleteGroupResponse":{ "type":"structure", "members":{ } }, "DeleteUserRequest":{ "type":"structure", "required":[ "IdentityStoreId", "UserId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "UserId":{ "shape":"ResourceId", "documentation":"

The identifier for a user in the identity store.

" } } }, "DeleteUserResponse":{ "type":"structure", "members":{ } }, "DescribeGroupMembershipRequest":{ "type":"structure", "required":[ "IdentityStoreId", "MembershipId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "MembershipId":{ "shape":"ResourceId", "documentation":"

The identifier for a `GroupMembership` in an identity store.

" } } }, "DescribeGroupMembershipResponse":{ "type":"structure", "required":[ "IdentityStoreId", "MembershipId", "GroupId", "MemberId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "MembershipId":{ "shape":"ResourceId", "documentation":"

The identifier for a `GroupMembership` in an identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "MemberId":{"shape":"MemberId"} } }, "DescribeGroupRequest":{ "type":"structure", "required":[ "IdentityStoreId", "GroupId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

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.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" } } }, "DescribeGroupResponse":{ "type":"structure", "required":[ "GroupId", "IdentityStoreId" ], "members":{ "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "DisplayName":{ "shape":"GroupDisplayName", "documentation":"

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":{ "shape":"ExternalIds", "documentation":"

A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.

" }, "Description":{ "shape":"SensitiveStringType", "documentation":"

A string containing a description of the group.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "DescribeUserRequest":{ "type":"structure", "required":[ "IdentityStoreId", "UserId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

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.

" }, "UserId":{ "shape":"ResourceId", "documentation":"

The identifier for a user in the identity store.

" } } }, "DescribeUserResponse":{ "type":"structure", "required":[ "UserId", "IdentityStoreId" ], "members":{ "UserName":{ "shape":"UserName", "documentation":"

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.

" }, "UserId":{ "shape":"ResourceId", "documentation":"

The identifier for a user in the identity store.

" }, "ExternalIds":{ "shape":"ExternalIds", "documentation":"

A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.

" }, "Name":{ "shape":"Name", "documentation":"

The name of the user.

" }, "DisplayName":{ "shape":"SensitiveStringType", "documentation":"

The display name of the user.

" }, "NickName":{ "shape":"SensitiveStringType", "documentation":"

An alternative descriptive name for the user.

" }, "ProfileUrl":{ "shape":"SensitiveStringType", "documentation":"

A URL link for the user's profile.

" }, "Emails":{ "shape":"Emails", "documentation":"

The email address of the user.

" }, "Addresses":{ "shape":"Addresses", "documentation":"

The physical address of the user.

" }, "PhoneNumbers":{ "shape":"PhoneNumbers", "documentation":"

A list of `PhoneNumber` objects associated with a user.

" }, "UserType":{ "shape":"SensitiveStringType", "documentation":"

A string indicating the type of user.

" }, "Title":{ "shape":"SensitiveStringType", "documentation":"

A string containing the title of the user.

" }, "PreferredLanguage":{ "shape":"SensitiveStringType", "documentation":"

The preferred language of the user.

" }, "Locale":{ "shape":"SensitiveStringType", "documentation":"

A string containing the geographical region or location of the user.

" }, "Timezone":{ "shape":"SensitiveStringType", "documentation":"

The time zone for a user.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "Email":{ "type":"structure", "members":{ "Value":{ "shape":"SensitiveStringType", "documentation":"

A string containing an email address. For example, \"johndoe@amazon.com.\"

" }, "Type":{ "shape":"SensitiveStringType", "documentation":"

A string representing the type of address. For example, \"Work.\"

" }, "Primary":{ "shape":"SensitiveBooleanType", "documentation":"

A Boolean value representing whether this is the primary email address for the associated resource.

" } }, "documentation":"

The email address associated with the user.

" }, "Emails":{ "type":"list", "member":{"shape":"Email"}, "max":1, "min":1 }, "ExceptionMessage":{"type":"string"}, "ExternalId":{ "type":"structure", "required":[ "Issuer", "Id" ], "members":{ "Issuer":{ "shape":"ExternalIdIssuer", "documentation":"

The issuer for an external identifier.

" }, "Id":{ "shape":"ExternalIdIdentifier", "documentation":"

The identifier issued to this resource by an external identity provider.

" } }, "documentation":"

The identifier issued to this resource by an external identity provider.

" }, "ExternalIdIdentifier":{ "type":"string", "max":256, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", "sensitive":true }, "ExternalIdIssuer":{ "type":"string", "max":100, "min":1, "pattern":"(?!(?i)(arn|aws):)[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", "sensitive":true }, "ExternalIds":{ "type":"list", "member":{"shape":"ExternalId"}, "max":10, "min":1 }, "Filter":{ "type":"structure", "required":[ "AttributePath", "AttributeValue" ], "members":{ "AttributePath":{ "shape":"AttributePath", "documentation":"

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":{ "shape":"SensitiveStringType", "documentation":"

Represents the data for an attribute. Each attribute value is described as a name-value pair.

" } }, "documentation":"

A query filter used by `ListUsers` and `ListGroups`. This filter object provides the attribute name and attribute value to search users or groups.

" }, "Filters":{ "type":"list", "member":{"shape":"Filter"}, "max":1, "min":0 }, "GetGroupIdRequest":{ "type":"structure", "required":[ "IdentityStoreId", "AlternateIdentifier" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "AlternateIdentifier":{ "shape":"AlternateIdentifier", "documentation":"

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`.

" } } }, "GetGroupIdResponse":{ "type":"structure", "required":[ "GroupId", "IdentityStoreId" ], "members":{ "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "GetGroupMembershipIdRequest":{ "type":"structure", "required":[ "IdentityStoreId", "GroupId", "MemberId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "MemberId":{ "shape":"MemberId", "documentation":"

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.

" } } }, "GetGroupMembershipIdResponse":{ "type":"structure", "required":[ "MembershipId", "IdentityStoreId" ], "members":{ "MembershipId":{ "shape":"ResourceId", "documentation":"

The identifier for a `GroupMembership` in an identity store.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "GetUserIdRequest":{ "type":"structure", "required":[ "IdentityStoreId", "AlternateIdentifier" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "AlternateIdentifier":{ "shape":"AlternateIdentifier", "documentation":"

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`.

" } } }, "GetUserIdResponse":{ "type":"structure", "required":[ "UserId", "IdentityStoreId" ], "members":{ "UserId":{ "shape":"ResourceId", "documentation":"

The identifier for a user in the identity store.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } } }, "Group":{ "type":"structure", "required":[ "GroupId", "IdentityStoreId" ], "members":{ "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "DisplayName":{ "shape":"GroupDisplayName", "documentation":"

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.

" }, "ExternalIds":{ "shape":"ExternalIds", "documentation":"

A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.

" }, "Description":{ "shape":"SensitiveStringType", "documentation":"

A string containing a description of the specified group.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } }, "documentation":"

A group object that contains the metadata and attributes for a specified group.

" }, "GroupDisplayName":{ "type":"string", "max":1024, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+", "sensitive":true }, "GroupIds":{ "type":"list", "member":{"shape":"ResourceId"}, "max":100, "min":1 }, "GroupMembership":{ "type":"structure", "required":["IdentityStoreId"], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "MembershipId":{ "shape":"ResourceId", "documentation":"

The identifier for a `GroupMembership` object in an identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "MemberId":{ "shape":"MemberId", "documentation":"

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.

" } }, "documentation":"

Contains the identifiers for a group, a group member, and a `GroupMembership` object in the identity store.

" }, "GroupMembershipExistenceResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "MemberId":{ "shape":"MemberId", "documentation":"

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.

" }, "MembershipExists":{ "shape":"SensitiveBooleanType", "documentation":"

Indicates whether a membership relation exists or not.

" } }, "documentation":"

Indicates whether a resource is a member of a group in the identity store.

" }, "GroupMembershipExistenceResults":{ "type":"list", "member":{"shape":"GroupMembershipExistenceResult"} }, "GroupMemberships":{ "type":"list", "member":{"shape":"GroupMembership"} }, "Groups":{ "type":"list", "member":{"shape":"Group"} }, "IdentityStoreId":{ "type":"string", "max":36, "min":1, "pattern":"d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" }, "RetryAfterSeconds":{ "shape":"RetryAfterSeconds", "documentation":"

The number of seconds to wait before retrying the next request.

" } }, "documentation":"

The request processing has failed because of an unknown error, exception or failure with an internal server.

", "exception":true, "fault":true, "retryable":{"throttling":false} }, "IsMemberInGroupsRequest":{ "type":"structure", "required":[ "IdentityStoreId", "MemberId", "GroupIds" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "MemberId":{ "shape":"MemberId", "documentation":"

An object containing the identifier of a group member.

" }, "GroupIds":{ "shape":"GroupIds", "documentation":"

A list of identifiers for groups in the identity store.

" } } }, "IsMemberInGroupsResponse":{ "type":"structure", "required":["Results"], "members":{ "Results":{ "shape":"GroupMembershipExistenceResults", "documentation":"

A list containing the results of membership existence checks.

" } } }, "ListGroupMembershipsForMemberRequest":{ "type":"structure", "required":[ "IdentityStoreId", "MemberId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "MemberId":{ "shape":"MemberId", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to be returned per request. This parameter is used in the `ListUsers` and `ListGroups` requests to specify how many results to return in one page. The length limit is 50 characters.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" } } }, "ListGroupMembershipsForMemberResponse":{ "type":"structure", "required":["GroupMemberships"], "members":{ "GroupMemberships":{ "shape":"GroupMemberships", "documentation":"

A list of `GroupMembership` objects in the group for a specified member.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" } } }, "ListGroupMembershipsRequest":{ "type":"structure", "required":[ "IdentityStoreId", "GroupId" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" } } }, "ListGroupMembershipsResponse":{ "type":"structure", "required":["GroupMemberships"], "members":{ "GroupMemberships":{ "shape":"GroupMemberships", "documentation":"

A list of `GroupMembership` objects in the group.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" } } }, "ListGroupsRequest":{ "type":"structure", "required":["IdentityStoreId"], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to be returned per request. This parameter is used in the `ListUsers` and `ListGroups` requests to specify how many results to return in one page. The length limit is 50 characters.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" }, "Filters":{ "shape":"Filters", "documentation":"

A list of `Filter` objects, which is used in the `ListUsers` and `ListGroups` requests.

", "deprecated":true, "deprecatedMessage":"Using filters with ListGroups API is deprecated, please use GetGroupId API instead." } } }, "ListGroupsResponse":{ "type":"structure", "required":["Groups"], "members":{ "Groups":{ "shape":"Groups", "documentation":"

A list of `Group` objects in the identity store.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 it1 is used in the API request to search for the next page.

" } } }, "ListUsersRequest":{ "type":"structure", "required":["IdentityStoreId"], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to be returned per request. This parameter is used in the `ListUsers` and `ListGroups` requests to specify how many results to return in one page. The length limit is 50 characters.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" }, "Filters":{ "shape":"Filters", "documentation":"

A list of `Filter` objects, which is used in the `ListUsers` and `ListGroups` requests.

", "deprecated":true, "deprecatedMessage":"Using filters with ListUsers API is deprecated, please use GetGroupId API instead." } } }, "ListUsersResponse":{ "type":"structure", "required":["Users"], "members":{ "Users":{ "shape":"Users", "documentation":"

A list of `User` objects in the identity store.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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 search for the next page.

" } } }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MemberId":{ "type":"structure", "members":{ "UserId":{ "shape":"ResourceId", "documentation":"

An object containing the identifiers of resources that can be members.

" } }, "documentation":"

An object containing the identifier of a group member.

", "union":true }, "Name":{ "type":"structure", "members":{ "Formatted":{ "shape":"SensitiveStringType", "documentation":"

A string containing a formatted version of the name for display.

" }, "FamilyName":{ "shape":"SensitiveStringType", "documentation":"

The family name of the user.

" }, "GivenName":{ "shape":"SensitiveStringType", "documentation":"

The given name of the user.

" }, "MiddleName":{ "shape":"SensitiveStringType", "documentation":"

The middle name of the user.

" }, "HonorificPrefix":{ "shape":"SensitiveStringType", "documentation":"

The honorific prefix of the user. For example, \"Dr.\"

" }, "HonorificSuffix":{ "shape":"SensitiveStringType", "documentation":"

The honorific suffix of the user. For example, \"M.D.\"

" } }, "documentation":"

The full name of the user.

" }, "NextToken":{ "type":"string", "max":65535, "min":1, "pattern":"[-a-zA-Z0-9+=/:_]*" }, "PhoneNumber":{ "type":"structure", "members":{ "Value":{ "shape":"SensitiveStringType", "documentation":"

A string containing a phone number. For example, \"8675309\" or \"+1 (800) 123-4567\".

" }, "Type":{ "shape":"SensitiveStringType", "documentation":"

A string representing the type of a phone number. For example, \"Mobile.\"

" }, "Primary":{ "shape":"SensitiveBooleanType", "documentation":"

A Boolean value representing whether this is the primary phone number for the associated resource.

" } }, "documentation":"

The phone number associated with the user.

" }, "PhoneNumbers":{ "type":"list", "member":{"shape":"PhoneNumber"}, "max":1, "min":1 }, "RequestId":{ "type":"string", "max":36, "min":1, "pattern":"[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}" }, "ResourceId":{ "type":"string", "max":47, "min":1, "pattern":"([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "ResourceType":{ "shape":"ResourceType", "documentation":"

An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The identifier for a resource in the identity store that can be used as `UserId` or `GroupId`. The format for `ResourceId` is either `UUID` or `1234567890-UUID`, where `UUID` is a randomly generated value for each resource when it is created and `1234567890` represents the `IdentityStoreId` string value. In the case that the identity store is migrated from a legacy SSO identity store, the `ResourceId` for that identity store will be in the format of `UUID`. Otherwise, it will be in the `1234567890-UUID` format.

" }, "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" } }, "documentation":"

Indicates that a requested resource is not found.

", "exception":true }, "ResourceType":{ "type":"string", "enum":[ "GROUP", "USER", "IDENTITY_STORE", "GROUP_MEMBERSHIP" ] }, "RetryAfterSeconds":{"type":"integer"}, "SensitiveBooleanType":{ "type":"boolean", "sensitive":true }, "SensitiveStringType":{ "type":"string", "max":1024, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r 　]+", "sensitive":true }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" } }, "documentation":"

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

", "exception":true }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" }, "RetryAfterSeconds":{ "shape":"RetryAfterSeconds", "documentation":"

The number of seconds to wait before retrying the next request.

" } }, "documentation":"

Indicates that the principal has crossed the throttling limits of the API operations.

", "exception":true, "retryable":{"throttling":true} }, "UniqueAttribute":{ "type":"structure", "required":[ "AttributePath", "AttributeValue" ], "members":{ "AttributePath":{ "shape":"AttributePath", "documentation":"

A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

" }, "AttributeValue":{ "shape":"AttributeValue", "documentation":"

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.

" } }, "documentation":"

An entity attribute that's unique to a specific entity.

" }, "UpdateGroupRequest":{ "type":"structure", "required":[ "IdentityStoreId", "GroupId", "Operations" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "GroupId":{ "shape":"ResourceId", "documentation":"

The identifier for a group in the identity store.

" }, "Operations":{ "shape":"AttributeOperations", "documentation":"

A list of `AttributeOperation` objects to apply to the requested group. These operations might add, replace, or remove an attribute.

" } } }, "UpdateGroupResponse":{ "type":"structure", "members":{ } }, "UpdateUserRequest":{ "type":"structure", "required":[ "IdentityStoreId", "UserId", "Operations" ], "members":{ "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" }, "UserId":{ "shape":"ResourceId", "documentation":"

The identifier for a user in the identity store.

" }, "Operations":{ "shape":"AttributeOperations", "documentation":"

A list of `AttributeOperation` objects to apply to the requested user. These operations might add, replace, or remove an attribute.

" } } }, "UpdateUserResponse":{ "type":"structure", "members":{ } }, "User":{ "type":"structure", "required":[ "UserId", "IdentityStoreId" ], "members":{ "UserName":{ "shape":"UserName", "documentation":"

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.

" }, "UserId":{ "shape":"ResourceId", "documentation":"

The identifier for a user in the identity store.

" }, "ExternalIds":{ "shape":"ExternalIds", "documentation":"

A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.

" }, "Name":{ "shape":"Name", "documentation":"

An object containing the name of the user.

" }, "DisplayName":{ "shape":"SensitiveStringType", "documentation":"

A string containing the name of the user that is formatted for display when the user is referenced. For example, \"John Doe.\"

" }, "NickName":{ "shape":"SensitiveStringType", "documentation":"

A string containing an alternate name for the user.

" }, "ProfileUrl":{ "shape":"SensitiveStringType", "documentation":"

A string containing a URL that might be associated with the user.

" }, "Emails":{ "shape":"Emails", "documentation":"

A list of `Email` objects containing email addresses associated with the user.

" }, "Addresses":{ "shape":"Addresses", "documentation":"

A list of `Address` objects containing addresses associated with the user.

" }, "PhoneNumbers":{ "shape":"PhoneNumbers", "documentation":"

A list of `PhoneNumber` objects containing phone numbers associated with the user.

" }, "UserType":{ "shape":"SensitiveStringType", "documentation":"

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

" }, "Title":{ "shape":"SensitiveStringType", "documentation":"

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

" }, "PreferredLanguage":{ "shape":"SensitiveStringType", "documentation":"

A string containing the preferred language of the user. For example, \"American English\" or \"en-us.\"

" }, "Locale":{ "shape":"SensitiveStringType", "documentation":"

A string containing the geographical region or location of the user.

" }, "Timezone":{ "shape":"SensitiveStringType", "documentation":"

A string containing the time zone of the user.

" }, "IdentityStoreId":{ "shape":"IdentityStoreId", "documentation":"

The globally unique identifier for the identity store.

" } }, "documentation":"

A user object that contains the metadata and attributes for a specified user.

" }, "UserName":{ "type":"string", "max":128, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", "sensitive":true }, "Users":{ "type":"list", "member":{"shape":"User"} }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

" } }, "documentation":"

The request failed because it contains a syntax error.

", "exception":true } }, "documentation":"

The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.

This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.

IAM Identity Center uses the `sso` and `identitystore` API namespaces.

" }