Skip to content

List Users

finspacedata_list_users R Documentation

Lists all available users in FinSpace

Description

Lists all available users in FinSpace.

Usage

finspacedata_list_users(nextToken, maxResults)

Arguments

nextToken

A token that indicates where a results page should begin.

maxResults

[required] The maximum number of results per page.

Value

A list with the following syntax:

list(
  users = list(
    list(
      userId = "string",
      status = "CREATING"|"ENABLED"|"DISABLED",
      firstName = "string",
      lastName = "string",
      emailAddress = "string",
      type = "SUPER_USER"|"APP_USER",
      apiAccess = "ENABLED"|"DISABLED",
      apiAccessPrincipalArn = "string",
      createTime = 123,
      lastEnabledTime = 123,
      lastDisabledTime = 123,
      lastModifiedTime = 123,
      lastLoginTime = 123
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_users(
  nextToken = "string",
  maxResults = 123
)