Skip to content

Creates a relationship between a member and a group

Description

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

Usage

identitystore_create_group_membership(IdentityStoreId, GroupId,
  MemberId)

Arguments

  • IdentityStoreId

    [required] The globally unique identifier for the identity store.

    You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

  • GroupId

    [required] The identifier for a group in the identity store.

    You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

  • MemberId

    [required] An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  MembershipId = "string",
  MembershipArn = "string"
)

Request syntax

svc$create_group_membership(
  IdentityStoreId = "string",
  GroupId = "string",
  MemberId = list(
    UserId = "string"
  )
)