Create a user invitation
curl --request POST \
--url https://api.astronomer.io/v1/organizations/{organizationId}/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inviteeEmail": "user1@company.com",
"role": "ORGANIZATION_MEMBER"
}
'import requests
url = "https://api.astronomer.io/v1/organizations/{organizationId}/invites"
payload = {
"inviteeEmail": "user1@company.com",
"role": "ORGANIZATION_MEMBER"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({inviteeEmail: 'user1@company.com', role: 'ORGANIZATION_MEMBER'})
};
fetch('https://api.astronomer.io/v1/organizations/{organizationId}/invites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/invites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inviteeEmail' => 'user1@company.com',
'role' => 'ORGANIZATION_MEMBER'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations/{organizationId}/invites"
payload := strings.NewReader("{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_MEMBER\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_MEMBER\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_MEMBER\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Invite
Create a user invitation
Invite a user to an Organization.
POST
/
organizations
/
{organizationId}
/
invites
Create a user invitation
curl --request POST \
--url https://api.astronomer.io/v1/organizations/{organizationId}/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inviteeEmail": "user1@company.com",
"role": "ORGANIZATION_MEMBER"
}
'import requests
url = "https://api.astronomer.io/v1/organizations/{organizationId}/invites"
payload = {
"inviteeEmail": "user1@company.com",
"role": "ORGANIZATION_MEMBER"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({inviteeEmail: 'user1@company.com', role: 'ORGANIZATION_MEMBER'})
};
fetch('https://api.astronomer.io/v1/organizations/{organizationId}/invites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/invites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inviteeEmail' => 'user1@company.com',
'role' => 'ORGANIZATION_MEMBER'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations/{organizationId}/invites"
payload := strings.NewReader("{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_MEMBER\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_MEMBER\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_MEMBER\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Organization to invite the user to.
Body
application/json
The request body for creating user invite.
The email of the user to invite.
Example:
"user1@company.com"
The user's Organization role.
Available options:
ORGANIZATION_OWNER, ORGANIZATION_OBSERVE_ADMIN, ORGANIZATION_OBSERVE_MEMBER, ORGANIZATION_BILLING_ADMIN, ORGANIZATION_MEMBER Example:
"ORGANIZATION_MEMBER"
Response
OK
The time when the invite is expired in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
Example:
"2022-11-22T04:37:12Z"
The invite ID.
Example:
"clm9t1g17000008jmfsw20lsz"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The ID of the Organization where the invite was sent.
Example:
"clm9t0gbt000108jv4f1cfu8u"
The name of the Organization where the invite was sent.
Example:
"My Organization"
The ID for the user who was invited.
Example:
"clm9t060z000008jv3mira7x5"
Was this page helpful?
⌘I