Describe User

connect_describe_user

R Documentation

Describes the specified user

Description

Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Usage

connect_describe_user(UserId, InstanceId)

Arguments

UserId

[required] The identifier of the user account.

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Value

A list with the following syntax:

list(
  User = list(
    Id = "string",
    Arn = "string",
    Username = "string",
    IdentityInfo = list(
      FirstName = "string",
      LastName = "string",
      Email = "string",
      SecondaryEmail = "string",
      Mobile = "string"
    ),
    PhoneConfig = list(
      PhoneType = "SOFT_PHONE"|"DESK_PHONE",
      AutoAccept = TRUE|FALSE,
      AfterContactWorkTimeLimit = 123,
      DeskPhoneNumber = "string"
    ),
    DirectoryUserId = "string",
    SecurityProfileIds = list(
      "string"
    ),
    RoutingProfileId = "string",
    HierarchyGroupId = "string",
    Tags = list(
      "string"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string"
  )
)

Request syntax

svc$describe_user(
  UserId = "string",
  InstanceId = "string"
)