IAM API ReferenceUser

List users in an Organization

List users in an Organization or a specific Workspace or Deployment within an Organization.

If you specify workspaceId, the response lists the user’s Workspace and Organization roles. If you specify deploymentId, the response lists the user’s Deployment and Organization roles. If you specify both workspaceId and deploymentId, the response lists Workspace, Deployment, and Organization roles for users that belong to both the specified Workspace and Deployment.

Path parameters

organizationIdstringRequired

The ID of the Organization to list users for.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

workspaceIdstringOptional

The ID of the Workspace to filter the list of users for. When specified, the API returns only users belonging to the specified Workspace.

deploymentIdstringOptional

The ID of the Deployment to filter the list of users for. When specified, the API returns only users belonging to the specified Deployment.

offsetintegerOptional>=0Defaults to 0

Offset for pagination

limitintegerOptional>=0<=1000Defaults to 20

Limit for pagination

sortslist of enumsOptional

Sorting criteria, each criterion should conform to format ‘fieldName:asc’ or ‘fieldName:desc’

Response

OK

limitinteger

The maximum number of users in one page.

offsetinteger

The offset of the current page of users.

totalCountinteger

The total number of users.

userslist of objects

The list of users in the current page.

Errors