List users in an Organization

curl https://api.astronomer.io/v1/organizations/organizationId/users \
     -H "Authorization: Bearer <token>"

{
  "limit": 10,
  "offset": 0,
  "totalCount": 100,
  "users": [
    {
      "avatarUrl": "https://avatar.url",
      "createdAt": "2022-11-22T04:37:12Z",
      "fullName": "Jane Doe",
      "id": "clm9sq6s0000008kz7uvl7yz7",
      "status": "ACTIVE",
      "updatedAt": "2022-11-22T04:37:12Z",
      "username": "user1@company.com",
      "dagRoles": [
        {
          "dagId": "my_dag",
          "deploymentId": "clm8t5u4q000008jq4qoc3031",
          "role": "DAG_VIEWER"
        }
      ],
      "deploymentRoles": [
        {
          "deploymentId": "clm8t5u4q000008jq4qoc3031",
          "role": "DEPLOYMENT_ADMIN"
        }
      ],
      "organizationRole": "ORGANIZATION_MEMBER",
      "workspaceRoles": [
        {
          "role": "WORKSPACE_MEMBER",
          "workspaceId": "clm8t5u4q000008jq4qoc3036"
        }
      ]
    }
  ]
}

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

Authentication

AuthorizationBearer

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

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>=0Defaults to 0

Offset for pagination

limitintegerOptional0-1000Defaults to 20

Limit for pagination

sortslist of enumsOptional

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

Response

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.

Authentication

Path parameters

Query parameters

Response

Errors