Smaws_Client_Identitystore (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_external_id : 
  id:Types.external_id_identifier ->
  issuer:Types.external_id_issuer ->
  unit ->
  Types.external_id

val make_name : 
  ?honorific_suffix:Types.sensitive_string_type ->
  ?honorific_prefix:Types.sensitive_string_type ->
  ?middle_name:Types.sensitive_string_type ->
  ?given_name:Types.sensitive_string_type ->
  ?family_name:Types.sensitive_string_type ->
  ?formatted:Types.sensitive_string_type ->
  unit ->
  Types.name

val make_email : 
  ?primary:Types.boolean_type ->
  ?type_:Types.sensitive_string_type ->
  ?value:Types.sensitive_string_type ->
  unit ->
  Types.email

val make_address : 
  ?primary:Types.boolean_type ->
  ?type_:Types.sensitive_string_type ->
  ?formatted:Types.sensitive_string_type ->
  ?country:Types.sensitive_string_type ->
  ?postal_code:Types.sensitive_string_type ->
  ?region:Types.sensitive_string_type ->
  ?locality:Types.sensitive_string_type ->
  ?street_address:Types.sensitive_string_type ->
  unit ->
  Types.address

val make_phone_number : 
  ?primary:Types.boolean_type ->
  ?type_:Types.sensitive_string_type ->
  ?value:Types.sensitive_string_type ->
  unit ->
  Types.phone_number

val make_photo : 
  ?primary:Types.boolean_type ->
  ?display:Types.sensitive_string_type ->
  ?type_:Types.sensitive_string_type ->
  value:Types.sensitive_string_type ->
  unit ->
  Types.photo

val make_role : 
  ?primary:Types.boolean_type ->
  ?type_:Types.sensitive_string_type ->
  ?value:Types.sensitive_string_type ->
  unit ->
  Types.role

val make_user : 
  ?extensions:Types.extensions ->
  ?updated_by:Types.string_type ->
  ?updated_at:Types.date_type ->
  ?created_by:Types.string_type ->
  ?created_at:Types.date_type ->
  ?roles:Types.roles ->
  ?birthdate:Types.sensitive_string_type ->
  ?website:Types.sensitive_string_type ->
  ?photos:Types.photos ->
  ?user_status:Types.user_status ->
  ?timezone:Types.sensitive_string_type ->
  ?locale:Types.sensitive_string_type ->
  ?preferred_language:Types.sensitive_string_type ->
  ?title:Types.sensitive_string_type ->
  ?user_type:Types.sensitive_string_type ->
  ?phone_numbers:Types.phone_numbers ->
  ?addresses:Types.addresses ->
  ?emails:Types.emails ->
  ?profile_url:Types.sensitive_string_type ->
  ?nick_name:Types.sensitive_string_type ->
  ?display_name:Types.sensitive_string_type ->
  ?name:Types.name ->
  ?external_ids:Types.external_ids ->
  ?user_name:Types.user_name ->
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.user

val make_update_user_response : unit -> unit

val make_attribute_operation : 
  ?attribute_value:Types.attribute_value ->
  attribute_path:Types.attribute_path ->
  unit ->
  Types.attribute_operation

val make_update_user_request : 
  operations:Types.attribute_operations ->
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.update_user_request

val make_update_group_response : unit -> unit

val make_update_group_request : 
  operations:Types.attribute_operations ->
  group_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.update_group_request

val make_unique_attribute : 
  attribute_value:Types.attribute_value ->
  attribute_path:Types.attribute_path ->
  unit ->
  Types.unique_attribute

val make_list_users_response : 
  ?next_token:Types.next_token ->
  users:Types.users ->
  unit ->
  Types.list_users_response

val make_filter : 
  attribute_value:Types.sensitive_string_type ->
  attribute_path:Types.attribute_path ->
  unit ->
  Types.filter

val make_list_users_request : 
  ?filters:Types.filters ->
  ?next_token:Types.next_token ->
  ?max_results:Types.max_results ->
  ?extensions:Types.extension_names ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.list_users_request

val make_group : 
  ?updated_by:Types.string_type ->
  ?created_by:Types.string_type ->
  ?updated_at:Types.date_type ->
  ?created_at:Types.date_type ->
  ?description:Types.sensitive_string_type ->
  ?external_ids:Types.external_ids ->
  ?display_name:Types.group_display_name ->
  identity_store_id:Types.identity_store_id ->
  group_id:Types.resource_id ->
  unit ->
  Types.group

val make_list_groups_response : 
  ?next_token:Types.next_token ->
  groups:Types.groups ->
  unit ->
  Types.list_groups_response

val make_list_groups_request : 
  ?filters:Types.filters ->
  ?next_token:Types.next_token ->
  ?max_results:Types.max_results ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.list_groups_request

val make_group_membership : 
  ?updated_by:Types.string_type ->
  ?created_by:Types.string_type ->
  ?updated_at:Types.date_type ->
  ?created_at:Types.date_type ->
  ?member_id:Types.member_id ->
  ?group_id:Types.resource_id ->
  ?membership_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.group_membership

val make_list_group_memberships_response : 
  ?next_token:Types.next_token ->
  group_memberships:Types.group_memberships ->
  unit ->
  Types.list_group_memberships_response

val make_list_group_memberships_request : 
  ?next_token:Types.next_token ->
  ?max_results:Types.max_results ->
  group_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.list_group_memberships_request

val make_list_group_memberships_for_member_response : 
  ?next_token:Types.next_token ->
  group_memberships:Types.group_memberships ->
  unit ->
  Types.list_group_memberships_for_member_response

val make_list_group_memberships_for_member_request : 
  ?next_token:Types.next_token ->
  ?max_results:Types.max_results ->
  member_id:Types.member_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.list_group_memberships_for_member_request

val make_is_member_in_groups_response : 
  results:Types.group_membership_existence_results ->
  unit ->
  Types.is_member_in_groups_response

val make_is_member_in_groups_request : 
  group_ids:Types.group_ids ->
  member_id:Types.member_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.is_member_in_groups_request

val make_get_user_id_response : 
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.get_user_id_response

val make_get_user_id_request : 
  alternate_identifier:Types.alternate_identifier ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.get_user_id_request

val make_get_group_membership_id_response : 
  identity_store_id:Types.identity_store_id ->
  membership_id:Types.resource_id ->
  unit ->
  Types.get_group_membership_id_response

val make_get_group_membership_id_request : 
  member_id:Types.member_id ->
  group_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.get_group_membership_id_request

val make_get_group_id_response : 
  identity_store_id:Types.identity_store_id ->
  group_id:Types.resource_id ->
  unit ->
  Types.get_group_id_response

val make_get_group_id_request : 
  alternate_identifier:Types.alternate_identifier ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.get_group_id_request

val make_describe_user_response : 
  ?extensions:Types.extensions ->
  ?updated_by:Types.string_type ->
  ?updated_at:Types.date_type ->
  ?created_by:Types.string_type ->
  ?created_at:Types.date_type ->
  ?roles:Types.roles ->
  ?birthdate:Types.sensitive_string_type ->
  ?website:Types.sensitive_string_type ->
  ?photos:Types.photos ->
  ?user_status:Types.user_status ->
  ?timezone:Types.sensitive_string_type ->
  ?locale:Types.sensitive_string_type ->
  ?preferred_language:Types.sensitive_string_type ->
  ?title:Types.sensitive_string_type ->
  ?user_type:Types.sensitive_string_type ->
  ?phone_numbers:Types.phone_numbers ->
  ?addresses:Types.addresses ->
  ?emails:Types.emails ->
  ?profile_url:Types.sensitive_string_type ->
  ?nick_name:Types.sensitive_string_type ->
  ?display_name:Types.sensitive_string_type ->
  ?name:Types.name ->
  ?external_ids:Types.external_ids ->
  ?user_name:Types.user_name ->
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.describe_user_response

val make_describe_user_request : 
  ?extensions:Types.extension_names ->
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.describe_user_request

val make_describe_group_response : 
  ?updated_by:Types.string_type ->
  ?created_by:Types.string_type ->
  ?updated_at:Types.date_type ->
  ?created_at:Types.date_type ->
  ?description:Types.sensitive_string_type ->
  ?external_ids:Types.external_ids ->
  ?display_name:Types.group_display_name ->
  identity_store_id:Types.identity_store_id ->
  group_id:Types.resource_id ->
  unit ->
  Types.describe_group_response

val make_describe_group_request : 
  group_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.describe_group_request

val make_describe_group_membership_response : 
  ?updated_by:Types.string_type ->
  ?created_by:Types.string_type ->
  ?updated_at:Types.date_type ->
  ?created_at:Types.date_type ->
  member_id:Types.member_id ->
  group_id:Types.resource_id ->
  membership_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.describe_group_membership_response

val make_describe_group_membership_request : 
  membership_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.describe_group_membership_request

val make_delete_user_response : unit -> unit

val make_delete_user_request : 
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.delete_user_request

val make_delete_group_response : unit -> unit

val make_delete_group_request : 
  group_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.delete_group_request

val make_delete_group_membership_response : unit -> unit

val make_delete_group_membership_request : 
  membership_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.delete_group_membership_request

val make_create_user_response : 
  user_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.create_user_response

val make_create_user_request : 
  ?extensions:Types.extensions ->
  ?roles:Types.roles ->
  ?birthdate:Types.sensitive_string_type ->
  ?website:Types.sensitive_string_type ->
  ?photos:Types.photos ->
  ?timezone:Types.sensitive_string_type ->
  ?locale:Types.sensitive_string_type ->
  ?preferred_language:Types.sensitive_string_type ->
  ?title:Types.sensitive_string_type ->
  ?user_type:Types.sensitive_string_type ->
  ?phone_numbers:Types.phone_numbers ->
  ?addresses:Types.addresses ->
  ?emails:Types.emails ->
  ?profile_url:Types.sensitive_string_type ->
  ?nick_name:Types.sensitive_string_type ->
  ?display_name:Types.sensitive_string_type ->
  ?name:Types.name ->
  ?user_name:Types.user_name ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.create_user_request

val make_create_group_response : 
  identity_store_id:Types.identity_store_id ->
  group_id:Types.resource_id ->
  unit ->
  Types.create_group_response

val make_create_group_request : 
  ?description:Types.sensitive_string_type ->
  ?display_name:Types.group_display_name ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.create_group_request

val make_create_group_membership_response : 
  identity_store_id:Types.identity_store_id ->
  membership_id:Types.resource_id ->
  unit ->
  Types.create_group_membership_response

val make_create_group_membership_request : 
  member_id:Types.member_id ->
  group_id:Types.resource_id ->
  identity_store_id:Types.identity_store_id ->
  unit ->
  Types.create_group_membership_request

Operations

module CreateGroup : sig ... end

Creates a group within the specified identity store.

module CreateGroupMembership : sig ... end

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

module CreateUser : sig ... end

Creates a user within the specified identity store.

module DeleteGroup : sig ... end

Delete a group within an identity store given GroupId.

module DeleteGroupMembership : sig ... end

Delete a membership within a group given MembershipId.

module DeleteUser : sig ... end

Deletes a user within an identity store given UserId.

module DescribeGroup : sig ... end

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

module DescribeGroupMembership : sig ... end

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

module DescribeUser : sig ... end

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

module GetGroupId : sig ... end

Retrieves GroupId in an identity store.

module GetGroupMembershipId : sig ... end

Retrieves the MembershipId in an identity store.

module GetUserId : sig ... end

Retrieves the UserId in an identity store.

module IsMemberInGroups : sig ... end

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

module ListGroupMemberships : sig ... end

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

module ListGroupMembershipsForMember : sig ... end

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

module ListGroups : sig ... end

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.

module ListUsers : sig ... end

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.

module UpdateGroup : sig ... end

Updates the specified group metadata and attributes in the specified identity store.

module UpdateUser : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end