Skip to content

Get User Details

codecatalyst_get_user_details R Documentation

Returns information about a user

Description

Returns information about a user.

Usage

codecatalyst_get_user_details(id, userName)

Arguments

id

The system-generated unique ID of the user.

userName

The name of the user as displayed in Amazon CodeCatalyst.

Value

A list with the following syntax:

list(
  userId = "string",
  userName = "string",
  displayName = "string",
  primaryEmail = list(
    email = "string",
    verified = TRUE|FALSE
  ),
  version = "string"
)

Request syntax

svc$get_user_details(
  id = "string",
  userName = "string"
)