List Users By Permission Group

finspacedata_list_users_by_permission_group

R Documentation

Lists details of all the users in a specific permission group¶

Description¶

Lists details of all the users in a specific permission group.

Usage¶

finspacedata_list_users_by_permission_group(permissionGroupId,
  nextToken, maxResults)

Arguments¶

permissionGroupId

[required] The unique identifier for the permission group.

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",
      membershipStatus = "ADDITION_IN_PROGRESS"|"ADDITION_SUCCESS"|"REMOVAL_IN_PROGRESS"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_users_by_permission_group(
  permissionGroupId = "string",
  nextToken = "string",
  maxResults = 123
)