Identitystore

This page documents function available when using the Identitystore module, created with @service Identitystore.

Index

Documentation

Main.Identitystore.create_groupMethod
create_group(identity_store_id)
create_group(identity_store_id, params::Dict{String,<:Any})

Creates a group within the specified identity store.

Arguments

  • identity_store_id: The globally unique identifier for the identity store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A string containing the description of the group.
  • "DisplayName": 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.
Main.Identitystore.create_group_membershipMethod
create_group_membership(group_id, identity_store_id, member_id)
create_group_membership(group_id, identity_store_id, member_id, params::Dict{String,<:Any})

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

Arguments

  • group_id: The identifier for a group in the identity store.
  • identity_store_id: The globally unique identifier for the identity store.
  • member_id: 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.
Main.Identitystore.create_userMethod
create_user(identity_store_id)
create_user(identity_store_id, params::Dict{String,<:Any})

Creates a user within the specified identity store.

Arguments

  • identity_store_id: The globally unique identifier for the identity store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Addresses": A list of Address objects containing addresses associated with the user.
  • "DisplayName": A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."
  • "Emails": A list of Email objects containing email addresses associated with the user.
  • "Locale": A string containing the geographical region or location of the user.
  • "Name": An object containing the name of the user.
  • "NickName": A string containing an alternate name for the user.
  • "PhoneNumbers": A list of PhoneNumber objects containing phone numbers associated with the user.
  • "PreferredLanguage": A string containing the preferred language of the user. For example, "American English" or "en-us."
  • "ProfileUrl": A string containing a URL that might be associated with the user.
  • "Timezone": A string containing the time zone of the user.
  • "Title": A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
  • "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. "Administrator" and "AWSAdministrators" are reserved names and can't be used for users or groups.
  • "UserType": A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
Main.Identitystore.delete_groupMethod
delete_group(group_id, identity_store_id)
delete_group(group_id, identity_store_id, params::Dict{String,<:Any})

Delete a group within an identity store given GroupId.

Arguments

  • group_id: The identifier for a group in the identity store.
  • identity_store_id: The globally unique identifier for the identity store.
Main.Identitystore.delete_group_membershipMethod
delete_group_membership(identity_store_id, membership_id)
delete_group_membership(identity_store_id, membership_id, params::Dict{String,<:Any})

Delete a membership within a group given MembershipId.

Arguments

  • identity_store_id: The globally unique identifier for the identity store.
  • membership_id: The identifier for a GroupMembership in an identity store.
Main.Identitystore.delete_userMethod
delete_user(identity_store_id, user_id)
delete_user(identity_store_id, user_id, params::Dict{String,<:Any})

Deletes a user within an identity store given UserId.

Arguments

  • identity_store_id: The globally unique identifier for the identity store.
  • user_id: The identifier for a user in the identity store.
Main.Identitystore.describe_groupMethod
describe_group(group_id, identity_store_id)
describe_group(group_id, identity_store_id, params::Dict{String,<:Any})

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

Arguments

  • group_id: The identifier for a group in the identity store.
  • identity_store_id: 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.
Main.Identitystore.describe_group_membershipMethod
describe_group_membership(identity_store_id, membership_id)
describe_group_membership(identity_store_id, membership_id, params::Dict{String,<:Any})

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

Arguments

  • identity_store_id: The globally unique identifier for the identity store.
  • membership_id: The identifier for a GroupMembership in an identity store.
Main.Identitystore.describe_userMethod
describe_user(identity_store_id, user_id)
describe_user(identity_store_id, user_id, params::Dict{String,<:Any})

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

Arguments

  • identity_store_id: 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.
  • user_id: The identifier for a user in the identity store.
Main.Identitystore.get_group_idMethod
get_group_id(alternate_identifier, identity_store_id)
get_group_id(alternate_identifier, identity_store_id, params::Dict{String,<:Any})

Retrieves GroupId in an identity store.

Arguments

  • alternate_identifier: 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.
  • identity_store_id: The globally unique identifier for the identity store.
Main.Identitystore.get_group_membership_idMethod
get_group_membership_id(group_id, identity_store_id, member_id)
get_group_membership_id(group_id, identity_store_id, member_id, params::Dict{String,<:Any})

Retrieves the MembershipId in an identity store.

Arguments

  • group_id: The identifier for a group in the identity store.
  • identity_store_id: The globally unique identifier for the identity store.
  • member_id: 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.
Main.Identitystore.get_user_idMethod
get_user_id(alternate_identifier, identity_store_id)
get_user_id(alternate_identifier, identity_store_id, params::Dict{String,<:Any})

Retrieves the UserId in an identity store.

Arguments

  • alternate_identifier: 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.
  • identity_store_id: The globally unique identifier for the identity store.
Main.Identitystore.is_member_in_groupsMethod
is_member_in_groups(group_ids, identity_store_id, member_id)
is_member_in_groups(group_ids, identity_store_id, member_id, params::Dict{String,<:Any})

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

Arguments

  • group_ids: A list of identifiers for groups in the identity store.
  • identity_store_id: The globally unique identifier for the identity store.
  • member_id: An object containing the identifier of a group member.
Main.Identitystore.list_group_membershipsMethod
list_group_memberships(group_id, identity_store_id)
list_group_memberships(group_id, identity_store_id, params::Dict{String,<:Any})

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

Arguments

  • group_id: The identifier for a group in the identity store.
  • identity_store_id: The globally unique identifier for the identity store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
Main.Identitystore.list_group_memberships_for_memberMethod
list_group_memberships_for_member(identity_store_id, member_id)
list_group_memberships_for_member(identity_store_id, member_id, params::Dict{String,<:Any})

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

Arguments

  • identity_store_id: The globally unique identifier for the identity store.
  • member_id: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
Main.Identitystore.list_groupsMethod
list_groups(identity_store_id)
list_groups(identity_store_id, params::Dict{String,<:Any})

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.

Arguments

  • identity_store_id: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A list of Filter objects, which is used in the ListUsers and ListGroups requests.
  • "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.
  • "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.
Main.Identitystore.list_usersMethod
list_users(identity_store_id)
list_users(identity_store_id, params::Dict{String,<:Any})

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.

Arguments

  • identity_store_id: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A list of Filter objects, which is used in the ListUsers and ListGroups requests.
  • "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.
  • "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.
Main.Identitystore.update_groupMethod
update_group(group_id, identity_store_id, operations)
update_group(group_id, identity_store_id, operations, params::Dict{String,<:Any})

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

Arguments

  • group_id: The identifier for a group in the identity store.
  • identity_store_id: The globally unique identifier for the identity store.
  • operations: A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute.
Main.Identitystore.update_userMethod
update_user(identity_store_id, operations, user_id)
update_user(identity_store_id, operations, user_id, params::Dict{String,<:Any})

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

Arguments

  • identity_store_id: The globally unique identifier for the identity store.
  • operations: A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute.
  • user_id: The identifier for a user in the identity store.