Skip to content

Updates the specified user metadata and attributes in the specified identity store

Description

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

Usage

identitystore_update_user(IdentityStoreId, UserId, Operations, Revision)

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.

  • UserId

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

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

  • Operations

    [required] A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see User.

  • Revision

    The expected current revision of the user. When you provide this value, the update is applied only if it matches the current revision of the user in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the update is applied unconditionally.

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  UserId = "string",
  UserArn = "string",
  Revision = "string"
)

Request syntax

svc$update_user(
  IdentityStoreId = "string",
  UserId = "string",
  Operations = list(
    list(
      AttributePath = "string",
      AttributeValue = list()
    )
  ),
  Revision = "string"
)