String requestId
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.
String streetAddress
The street of the address.
String locality
A string of the address locality.
String region
The region of the address.
String postalCode
The postal code of the address.
String country
The country of the address.
String formatted
A string containing a formatted version of the address for display.
String type
A string representing the type of address. For example, "Home."
Boolean primary
A Boolean value representing whether this is the primary address for the associated resource.
ExternalId externalId
The identifier issued to this resource by an external identity provider.
String attributePath
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
String requestId
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.
String reason
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.
String identityStoreId
The globally unique identifier for the identity store.
String groupId
The identifier for a group in the identity store.
MemberId memberId
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.
String identityStoreId
The globally unique identifier for the identity store.
String displayName
A string containing the name of the group. This value is commonly displayed when the group is referenced.
String description
A string containing the description of the group.
String identityStoreId
The globally unique identifier for the identity store.
String userName
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.
Name name
An object containing the user's name.
String displayName
A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."
String nickName
A string containing an alternate name for the user.
String profileUrl
A string containing a URL that may be associated with the user.
List<E> emails
A list of Email
objects containing email addresses associated with the user.
List<E> addresses
A list of Address
objects containing addresses associated with the user.
List<E> phoneNumbers
A list of PhoneNumber
objects containing phone numbers associated with the user.
String userType
A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
String title
A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.
String preferredLanguage
A string containing the preferred language of the user. For example, "American English" or "en-us."
String locale
A string containing the user's geographical region or location.
String timezone
A string containing the user's time zone.
String identityStoreId
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.
String groupId
The identifier for a group in the identity store.
String groupId
The identifier for a group in the identity store.
String displayName
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.
List<E> externalIds
A list of ExternalId
objects that contains the identifiers issued to this resource by an external
identity provider.
String description
A string containing a description of the group.
String identityStoreId
The globally unique identifier for the identity store.
String identityStoreId
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.
String userId
The identifier for a user in the identity store.
String userName
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.
String userId
The identifier for a user in the identity store.
List<E> externalIds
A list of ExternalId
objects that contains the identifiers issued to this resource by an external
identity provider.
Name name
The name of the user.
String displayName
The user's name value for display.
String nickName
An alternative descriptive name for the user.
String profileUrl
A URL link for the user's profile.
List<E> emails
The user's email value.
List<E> addresses
The user's physical address.
List<E> phoneNumbers
A list of PhoneNumber
objects associated with a user.
String userType
A string indicating the user's type.
String title
A string containing the user's title.
String preferredLanguage
The preferred language of the user.
String locale
A string containing the user's geographical region or location.
String timezone
The time zone for a user.
String identityStoreId
The globally unique identifier for the identity store.
String value
A string containing an email address. For example, "[email protected]."
String type
A string representing the type of address. For example, "Work."
Boolean primary
A Boolean value representing whether this is the primary email address for the associated resource.
String attributePath
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.
String attributeValue
Represents the data for an attribute. Each attribute value is described as a name-value pair.
String identityStoreId
The globally unique identifier for the identity store.
AlternateIdentifier alternateIdentifier
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
example, a unique GroupDisplayName
.
String identityStoreId
The globally unique identifier for the identity store.
String groupId
The identifier for a group in the identity store.
MemberId memberId
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.
String identityStoreId
The globally unique identifier for the identity store.
AlternateIdentifier alternateIdentifier
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
example, a unique UserDisplayName
.
String groupId
The identifier for a group in the identity store.
String displayName
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 the group is created and stored as an attribute of the group object in the identity store.
List<E> externalIds
A list of ExternalId
objects that contains the identifiers issued to this resource by an external
identity provider.
String description
A string containing a description of the specified group.
String identityStoreId
The globally unique identifier for the identity store.
String identityStoreId
The globally unique identifier for the identity store.
String membershipId
The identifier for a GroupMembership
object in an identity store.
String groupId
The identifier for a group in the identity store.
MemberId memberId
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.
String groupId
The identifier for a group in the identity store.
MemberId memberId
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.
Boolean membershipExists
Indicates whether a membership relation exists or not.
String requestId
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.
Integer retryAfterSeconds
The number of seconds that you would like to wait before retrying the next request.
String identityStoreId
The globally unique identifier for the identity store.
MemberId memberId
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.
Integer maxResults
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.
String nextToken
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.
List<E> groupMemberships
A list of GroupMembership
objects in the group for a specified member.
String nextToken
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.
String identityStoreId
The globally unique identifier for the identity store.
String groupId
The identifier for a group in the identity store.
Integer maxResults
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 nextToken
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.
List<E> groupMemberships
A list of GroupMembership
objects in the group.
String nextToken
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.
String identityStoreId
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.
Integer maxResults
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.
String nextToken
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.
List<E> filters
A list of Filter
objects, which is used in the ListUsers
and ListGroups
requests.
List<E> groups
A list of Group
objects in the identity store.
String nextToken
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.
String identityStoreId
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.
Integer maxResults
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.
String nextToken
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.
List<E> filters
A list of Filter
objects, which is used in the ListUsers
and ListGroups
requests.
List<E> users
A list of User
objects in the identity store.
String nextToken
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.
String userId
An object containing the identifiers of resources that can be members.
String formatted
A string containing a formatted version of the name for display.
String familyName
The family name of the user.
String givenName
The given name of the user.
String middleName
The middle name of the user.
String honorificPrefix
The honorific prefix of the user. For example, "Dr."
String honorificSuffix
The honorific suffix of the user. For example, "M.D."
String value
A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".
String type
A string representing the type of a phone number. For example, "Mobile."
Boolean primary
A Boolean value representing whether this is the primary phone number for the associated resource.
String resourceType
An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.
String resourceId
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.
String requestId
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.
String requestId
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.
String requestId
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.
Integer retryAfterSeconds
The number of seconds that you would like to wait before retrying the next request.
String identityStoreId
The globally unique identifier for the identity store.
String groupId
The identifier for a group in the identity store.
List<E> operations
A list of AttributeOperation
objects to apply to the requested group. These operations might add,
replace, or remove an attribute.
String identityStoreId
The globally unique identifier for the identity store.
String userId
The identifier for a user in the identity store.
List<E> operations
A list of AttributeOperation
objects to apply to the requested user. These operations might add,
replace, or remove an attribute.
String userName
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.
String userId
The identifier for a user in the identity store.
List<E> externalIds
A list of ExternalId
objects that contains the identifiers issued to this resource by an external
identity provider.
Name name
An object containing the user's name.
String displayName
A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
String nickName
A string containing an alternate name for the user.
String profileUrl
A string containing a URL that may be associated with the user.
List<E> emails
A list of Email
objects containing email addresses associated with the user.
List<E> addresses
A list of Address
objects containing addresses associated with the user.
List<E> phoneNumbers
A list of PhoneNumber
objects containing phone numbers associated with the user.
String userType
A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
String title
A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
String preferredLanguage
A string containing the preferred language of the user. For example, "American English" or "en-us."
String locale
A string containing the user's geographical region or location.
String timezone
A string containing the user's time zone.
String identityStoreId
The globally unique identifier for the identity store.
String requestId
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.
Copyright © 2023. All rights reserved.