Create a user invitation

POST

https://api.astronomer.io/v1/organizations/:organizationId/invites

POST

/v1/organizations/:organizationId/invites

$ curl -X POST https://api.astronomer.io/v1/organizations/organizationId/invites \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "inviteeEmail": "user1@company.com",
>   "role": "ORGANIZATION_OWNER"
> }'

1 {
2   "expiresAt": "2022-11-22T04:37:12Z",
3   "inviteId": "clm9t1g17000008jmfsw20lsz",
4   "invitee": {
5     "id": "clm8qv74h000008mlf08scq7k",
6     "apiTokenName": "my-token",
7     "avatarUrl": "https://avatar.url",
8     "fullName": "Jane Doe",
9     "subjectType": "USER",
10     "username": "user1@company.com"
11   },
12   "inviter": {
13     "id": "clm8qv74h000008mlf08scq7k",
14     "apiTokenName": "my-token",
15     "avatarUrl": "https://avatar.url",
16     "fullName": "Jane Doe",
17     "subjectType": "USER",
18     "username": "user1@company.com"
19   },
20   "organizationId": "clm9t0gbt000108jv4f1cfu8u",
21   "organizationName": "My Organization",
22   "userId": "clm9t060z000008jv3mira7x5"
23 }

Invite a user to 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 invite the user to.

Request

This endpoint expects an object.

inviteeEmailstringRequired

The email of the user to invite.

roleenumRequired

The user's Organization role.

Allowed values:

Response

expiresAtdatetime

The time when the invite is expired in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

inviteIdstring

The invite ID.

inviteeobject

inviterobject

organizationIdstring

The ID of the Organization where the invite was sent.

organizationNamestring

The name of the Organization where the invite was sent.

userIdstring

The ID for the user who was invited.

Errors

400

Create User Invite Body Bad Request Error

401

Create User Invite Body Unauthorized Error

403

Create User Invite Body Forbidden Error

404

Create User Invite Body Not Found Error

500

Create User Invite Body Internal Server Error