Créer des invitations destinées à un membre

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/member-invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
  "invitees": [
    {
      "email": "user@example.com",
      "roles": [
        "rol_0000000000000001"
      ]
    }
  ],
  "inviter": {
    "name": "Allison the Admin"
  },
  "ttl_sec": 3600
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/member-invitations"

payload = {
    "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
    "invitees": [
        {
            "email": "user@example.com",
            "roles": ["rol_0000000000000001"]
        }
    ],
    "inviter": { "name": "Allison the Admin" },
    "ttl_sec": 3600
}
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({
    identity_provider_id: 'con_2CZPv6IY0gWzDaQJ',
    invitees: [{email: 'user@example.com', roles: ['rol_0000000000000001']}],
    inviter: {name: 'Allison the Admin'},
    ttl_sec: 3600
  })
};

fetch('https://{tenantDomain}/my-org/v1/member-invitations', 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://{tenantDomain}/my-org/v1/member-invitations",
  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([
    'identity_provider_id' => 'con_2CZPv6IY0gWzDaQJ',
    'invitees' => [
        [
                'email' => 'user@example.com',
                'roles' => [
                                'rol_0000000000000001'
                ]
        ]
    ],
    'inviter' => [
        'name' => 'Allison the Admin'
    ],
    'ttl_sec' => 3600
  ]),
  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://{tenantDomain}/my-org/v1/member-invitations"

	payload := strings.NewReader("{\n  \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n  \"invitees\": [\n    {\n      \"email\": \"user@example.com\",\n      \"roles\": [\n        \"rol_0000000000000001\"\n      ]\n    }\n  ],\n  \"inviter\": {\n    \"name\": \"Allison the Admin\"\n  },\n  \"ttl_sec\": 3600\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://{tenantDomain}/my-org/v1/member-invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n  \"invitees\": [\n    {\n      \"email\": \"user@example.com\",\n      \"roles\": [\n        \"rol_0000000000000001\"\n      ]\n    }\n  ],\n  \"inviter\": {\n    \"name\": \"Allison the Admin\"\n  },\n  \"ttl_sec\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/member-invitations")

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  \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n  \"invitees\": [\n    {\n      \"email\": \"user@example.com\",\n      \"roles\": [\n        \"rol_0000000000000001\"\n      ]\n    }\n  ],\n  \"inviter\": {\n    \"name\": \"Allison the Admin\"\n  },\n  \"ttl_sec\": 3600\n}"

response = http.request(request)
puts response.read_body

[
  {
    "created_at": "2025-04-11T20:11:45.431Z",
    "expires_at": "2025-04-11T20:11:45.431Z",
    "id": "uinv_12345678abcdefgh",
    "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
    "invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
    "invitee": {
      "email": "user@example.com"
    },
    "inviter": {
      "name": "Allison the Admin"
    },
    "organization_id": "org_12345678abcdefgh",
    "roles": [
      "rol_BKW1BKIfBKd0BaI0"
    ],
    "ticket_id": "1asdfasd23usjdef"
  }
]

Créer des invitations

deprecated

Créez une ou plusieurs invitations destinées aux membres de cette organisation. Si une invitation active existe déjà pour un utilisateur, la génération d’une nouvelle invitation révoquera automatiquement toutes les invitations en attente pour cet utilisateur. Les rôles spécifiés dans la charge utile seront attribués à l’utilisateur lorsqu’il acceptera l’invitation.

POST

member-invitations

Créer des invitations destinées à un membre

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/member-invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
  "invitees": [
    {
      "email": "user@example.com",
      "roles": [
        "rol_0000000000000001"
      ]
    }
  ],
  "inviter": {
    "name": "Allison the Admin"
  },
  "ttl_sec": 3600
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/member-invitations"

payload = {
    "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
    "invitees": [
        {
            "email": "user@example.com",
            "roles": ["rol_0000000000000001"]
        }
    ],
    "inviter": { "name": "Allison the Admin" },
    "ttl_sec": 3600
}
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({
    identity_provider_id: 'con_2CZPv6IY0gWzDaQJ',
    invitees: [{email: 'user@example.com', roles: ['rol_0000000000000001']}],
    inviter: {name: 'Allison the Admin'},
    ttl_sec: 3600
  })
};

fetch('https://{tenantDomain}/my-org/v1/member-invitations', 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://{tenantDomain}/my-org/v1/member-invitations",
  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([
    'identity_provider_id' => 'con_2CZPv6IY0gWzDaQJ',
    'invitees' => [
        [
                'email' => 'user@example.com',
                'roles' => [
                                'rol_0000000000000001'
                ]
        ]
    ],
    'inviter' => [
        'name' => 'Allison the Admin'
    ],
    'ttl_sec' => 3600
  ]),
  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://{tenantDomain}/my-org/v1/member-invitations"

	payload := strings.NewReader("{\n  \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n  \"invitees\": [\n    {\n      \"email\": \"user@example.com\",\n      \"roles\": [\n        \"rol_0000000000000001\"\n      ]\n    }\n  ],\n  \"inviter\": {\n    \"name\": \"Allison the Admin\"\n  },\n  \"ttl_sec\": 3600\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://{tenantDomain}/my-org/v1/member-invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n  \"invitees\": [\n    {\n      \"email\": \"user@example.com\",\n      \"roles\": [\n        \"rol_0000000000000001\"\n      ]\n    }\n  ],\n  \"inviter\": {\n    \"name\": \"Allison the Admin\"\n  },\n  \"ttl_sec\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/member-invitations")

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  \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n  \"invitees\": [\n    {\n      \"email\": \"user@example.com\",\n      \"roles\": [\n        \"rol_0000000000000001\"\n      ]\n    }\n  ],\n  \"inviter\": {\n    \"name\": \"Allison the Admin\"\n  },\n  \"ttl_sec\": 3600\n}"

response = http.request(request)
puts response.read_body

[
  {
    "created_at": "2025-04-11T20:11:45.431Z",
    "expires_at": "2025-04-11T20:11:45.431Z",
    "id": "uinv_12345678abcdefgh",
    "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
    "invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
    "invitee": {
      "email": "user@example.com"
    },
    "inviter": {
      "name": "Allison the Admin"
    },
    "organization_id": "org_12345678abcdefgh",
    "roles": [
      "rol_BKW1BKIfBKd0BaI0"
    ],
    "ticket_id": "1asdfasd23usjdef"
  }
]

Autorisations

Authorization

string

header

requis

The access token received from the authorization server in the OAuth 2.0 flow.

En-têtes

auth0-custom-domain

string

Corps

application/json

invitees

object[]

requis

Required array length: 1 - 10 elements

Show child attributes

identity_provider_id

string

Identifiant du fournisseur d’identité. Au moins un des champs identity_provider_id ou user_store_id doit être fourni.

Pattern: ^con_[A-Za-z0-9]{16}$

inviter

object

Show child attributes

ttl_sec

integer

défaut:604800

Nombre de secondes pendant lesquelles l’invitation est valide avant d’expirer. S’il n’est pas précisé ou s’il est défini à 0, ce paramètre prend par défaut la valeur de 604800 secondes (7 jours). Valeur maximale : 2592000 secondes (30 jours).

Plage requise: 0 <= x <= 2592000

Réponse

Créer des invitations de membres pour une organisation.

created_at

string<date-time>

L’horodatage au format ISO 8601 représentant l’heure de création de l’invitation.

expires_at

string<date-time>

L’horodatage au format ISO 8601 représentant l’heure d’expiration de l’invitation.

string

read-only

L’ID de l’invitation du membre

Pattern: ^uinv_[A-Za-z0-9]{16}$

identity_provider_id

string

read-only

Identifiant du fournisseur d’identité.

Pattern: ^con_[A-Za-z0-9]{16}$

invitation_url

string<uri>

L’URL d’invitation à envoyer à la personne invitée.

invitee

object

Show child attributes

inviter

object

Show child attributes

organization_id

string

read-only

Identifiant de l’organisation.

Pattern: ^org_[A-Za-z0-9]{16}$

roles

string[]

read-only

L’ID d’un rôle pouvant être attribué à un membre d’une organisation.

Pattern: ^rol_[A-Za-z0-9]{16}$

ticket_id

string

L’ID du ticket d’invitation.