Create a user invitation (API Explorer)

Platform API ReferenceOrganization
Platform API ReferenceAlerts
Platform API ReferenceOptions
- GETGet cluster options
- GETGet Deployment options
Platform API ReferenceCluster
Platform API ReferenceDeployment
Platform API ReferenceDeploy
Platform API ReferenceEnvironment
Platform API ReferenceNotification Channels
Platform API ReferenceWorkspace
IAM API ReferenceAuthorization
- GETList authorization permission groups
IAM API ReferenceAllowed IP Address Range
IAM API ReferenceInvite
- POSTCreate a user invitation
- DELDelete a user invite
IAM API ReferenceRole
IAM API ReferenceTeam
IAM API ReferenceAPI Token
IAM API ReferenceUser

Built with

POSThttps://api.astronomer.io/iam/v1beta1/organizations/organizationId/invites

Path Parameters

organizationIdstringRequired

Body Parameters

inviteeEmailstringRequired
roleenumRequired

View in API Reference

Request

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

Response

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