Skip to content

Deletes a user within an identity store given UserId

Description

Deletes a user within an identity store given UserId.

Usage

identitystore_delete_user(IdentityStoreId, UserId, 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.

  • Revision

    The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the user is deleted regardless of its current revision.

Value

An empty list.

Request syntax

svc$delete_user(
  IdentityStoreId = "string",
  UserId = "string",
  Revision = "string"
)