Create a user invitation | Astronomer Documentation

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

{
  "expiresAt": "2022-11-22T04:37:12Z",
  "inviteId": "clm9t1g17000008jmfsw20lsz",
  "invitee": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "inviter": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "organizationId": "clm9t0gbt000108jv4f1cfu8u",
  "organizationName": "My Organization",
  "userId": "clm9t060z000008jv3mira7x5"
}

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

{
  "expiresAt": "2022-11-22T04:37:12Z",
  "inviteId": "clm9t1g17000008jmfsw20lsz",
  "invitee": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "inviter": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "organizationId": "clm9t0gbt000108jv4f1cfu8u",
  "organizationName": "My Organization",
  "userId": "clm9t060z000008jv3mira7x5"
}

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

The request body for creating user invite.

inviteeEmailstringRequired

The email of the user to invite.

roleenumRequired

The user's Organization role.

Allowed values:

Response

expiresAtstringformat: "date-time"

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

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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

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	}