User

List users in an Organization

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

Path parameters

organizationIdstringRequired
The ID of the Organization to list users for.

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
Offset for pagination
limitintegerOptional
Limit for pagination
sortsenumOptional
Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'

Response

This endpoint returns an object
limit
integer
The maximum number of users in one page.
offset
integer
The offset of the current page of users.
totalCount
integer
The total number of users.
users
list of objects
The list of users in the current page.
GET
1curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/users \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "limit": 10,
3  "offset": 0,
4  "totalCount": 100,
5  "users": [
6    {
7      "avatarUrl": "https://avatar.url",
8      "createdAt": "2022-11-22T04:37:12Z",
9      "fullName": "Jane Doe",
10      "id": "clm9sq6s0000008kz7uvl7yz7",
11      "status": "ACTIVE",
12      "updatedAt": "2022-11-22T04:37:12Z",
13      "username": "user1@company.com",
14      "deploymentRoles": [
15        {
16          "deploymentId": "clm8t5u4q000008jq4qoc3031",
17          "role": "DEPLOYMENT_ADMIN"
18        }
19      ],
20      "organizationRole": "ORGANIZATION_OWNER",
21      "workspaceRoles": [
22        {
23          "role": "WORKSPACE_OWNER",
24          "workspaceId": "clm8t5u4q000008jq4qoc3036"
25        }
26      ]
27    }
28  ]
29}
Built with