Organizations

Get Users for Organization

List all users within an organization including their roles, status, last activity, and access permissions for administrative oversight.

get/v1/organizations/{organizationId}/users

Request

  • Base URL
    https://api.tetrascience.com
  • URL
    https://api.tetrascience.com/v1/organizations/{organizationId}/users
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Query parameters

userStatus'active' | 'inactive' | 'locked'
Example:active
role'admin' | 'member' | 'readonly'
Example:service
roleIdId required(unresolved $ref)
authType'password' | 'service'
Example:service
fromnumber
sizenumber
emailEmail (unresolved $ref)

Email address of the user (exact match)

firstNamestring

Exact match on user first name

lastNamestring

Exact match on user last name

includestring[]
withCredentialsboolean

Parameters

#/paths/~1v1~1organizations~1{organizationId}/get/parameters/0 (unresolved $ref)

Response

Responding with list of users

authTypeAuthType (unresolved $ref)
emailEmail (unresolved $ref)
firstNamestring
lastNamestring
idId (unresolved $ref)
lastActivitystring
status'active' | 'inactive'
systemRolestring
password_historyobject[]
athenaCredentialsUpdatedAtCreatedAt (unresolved $ref)
rowPreferencesPreferences (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.