User

Get user information

GET
Retrieve user information about a specific user account.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the user belongs.
userIdstringRequired
The user's ID.

Response

This endpoint returns an object
avatarUrl
string
The URL for the user's profile image.
createdAt
datetime

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

fullName
string
The user's full name.
id
string
The user's ID.
status
enum
The user's status.
Allowed values: ACTIVEINACTIVEPENDINGBANNED
updatedAt
datetime

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

username
string
The user's username.
deploymentRoles
list of objectsOptional
The user's Deployment roles.
organizationRole
enumOptional
The user's Organization role.
Allowed values: ORGANIZATION_OWNERORGANIZATION_BILLING_ADMINORGANIZATION_MEMBER
workspaceRoles
list of objectsOptional
The user's Workspace roles.
GET
1curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/users/userId \
2     -H "Authorization: Bearer <token>"
Response
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  "deploymentRoles": [
10    {
11      "deploymentId": "clm8t5u4q000008jq4qoc3031",
12      "role": "DEPLOYMENT_ADMIN"
13    }
14  ],
15  "organizationRole": "ORGANIZATION_OWNER",
16  "workspaceRoles": [
17    {
18      "role": "WORKSPACE_OWNER",
19      "workspaceId": "clm8t5u4q000008jq4qoc3036"
20    }
21  ]
22}
Built with