Sign in
Users

List all gateway users

Changed on

Returns every user configured in the gateway along with role assignments. Callers without gateway:user:read get the team directory: lock reasons, who locked the account, and MFA preferences are omitted.

get/users

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/users
  • Auth: API key in header Cookie

Response

OK

created_atstring
created_by_emailstring
created_by_namestring
created_by_user_idinteger
emailstring
idinteger
locked_atstring
locked_by_emailstring
locked_by_namestring
locked_by_user_idinteger
locked_reasonstring
mfa_enforced_atstring
mfa_enrolledboolean
namestring
preferred_mfa_methodstring
rolesstring[]
suspendedboolean
updated_atstring

Changes