user

list all users as super admin (require to be super amdin)

Changed on
get/users/list_as_super_admin

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/users/list_as_super_admin
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

active_onlyboolean

filter only active users

Response

user

emailstring required
login_type'password' | 'github' | 'service_account' | 'pending_oauth' required
super_adminboolean required
devopsboolean
verifiedboolean required
namestring
companystring
usernamestring
operator_onlyboolean
is_workspace_adminboolean

Populated only for service accounts. True if the service account has workspace admin in its (single) workspace.

first_time_userboolean required
role_source'manual' | 'instance_group' | 'service_account' required
disabledboolean required
workspace_idstring

Changes

  • ad43ddfd42efRevision changes
    • warning

      added the new pending_oauth enum value to the / response property for the response status