Create a user invitation

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

1 { 2 "expiresAt": "2022-11-22T04:37:12Z", 3 "inviteId": "clm9t1g17000008jmfsw20lsz", 4 "invitee": { 5 "apiTokenName": "my-token", 6 "avatarUrl": "https://avatar.url", 7 "fullName": "Jane Doe", 8 "id": "clm8qv74h000008mlf08scq7k", 9 "subjectType": "USER", 10 "username": "user1@company.com" 11 }, 12 "inviter": { 13 "apiTokenName": "my-token", 14 "avatarUrl": "https://avatar.url", 15 "fullName": "Jane Doe", 16 "id": "clm8qv74h000008mlf08scq7k", 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.

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

expiresAtstring

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.

organizationNamestringOptional

The name of the Organization where the invite was sent.

userIdstringOptional

The ID for the user who was invited.

Path parameters

Headers

Request

Response

Errors