Get user information

GET

https://api.astronomer.io/v1/organizations/:organizationId/users/:userId

GET

/v1/organizations/:organizationId/users/:userId

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

1 {
2   "avatarUrl": "https://avatar.url",
3   "createdAt": "2022-11-22T04:37:12Z",
4   "fullName": "Jane Doe",
5   "id": "clm9sq6s0000008kz7uvl7yz7",
6   "status": "ACTIVE",
7   "updatedAt": "2022-11-22T04:37:12Z",
8   "username": "user1@company.com",
9   "dagRoles": [
10     {
11       "deploymentId": "clm8t5u4q000008jq4qoc3031",
12       "role": "DAG_VIEWER",
13       "dagId": "my_dag",
14       "dagTag": "team-a"
15     }
16   ],
17   "deploymentRoles": [
18     {
19       "deploymentId": "clm8t5u4q000008jq4qoc3031",
20       "role": "DEPLOYMENT_ADMIN"
21     }
22   ],
23   "organizationRole": "ORGANIZATION_OWNER",
24   "workspaceRoles": [
25     {
26       "role": "WORKSPACE_OWNER",
27       "workspaceId": "clm8t5u4q000008jq4qoc3036"
28     }
29   ]
30 }

Retrieve user information about a specific user account.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization to which the user belongs.

userIdstringRequired

The user's ID.

Response

avatarUrlstring

The URL for the user's profile image.

createdAtdatetime

The time when the user was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

fullNamestring

The user's full name.

idstring

The user's ID.

statusenum

The user's status.

updatedAtdatetime

The time when the user was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

usernamestring

The user's username.

dagRoleslist of objects

The user's DAG roles.

deploymentRoleslist of objects

The user's Deployment roles.

organizationRoleenum

The user's Organization role.

workspaceRoleslist of objects

The user's Workspace roles.

Errors

400

Get User Request Bad Request Error

401

Get User Request Unauthorized Error

403

Get User Request Forbidden Error

404

Get User Request Not Found Error

500

Get User Request Internal Server Error