Obtenir l’invitation

Obtenir une invitation destinée à un membre

curl --request GET \
  --url https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}', 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/{invitation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
}

{
  "status": 400,
  "title": "Validation Error",
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "detail": "No auth token provided.",
  "status": 401,
  "title": "Missing Token",
  "type": "https://auth0.com/api-errors#A0E-401-0002"
}

{
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint.",
  "status": 403,
  "title": "Insufficient Scope",
  "type": "https://auth0.com/api-errors#A0E-403-0002"
}

{
  "detail": "The organization does not exist.",
  "status": 404,
  "title": "Resource Not Found",
  "type": "https://auth0.com/api-errors#A0E-404-0002"
}

{
  "detail": "The endpoint request limit has been exceeded.",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "type": "https://auth0.com/api-errors#A0E-429-0003"
}

GET

member-invitations

{invitation_id}

Obtenir une invitation destinée à un membre

curl --request GET \
  --url https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}', 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/{invitation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
}

{
  "status": 400,
  "title": "Validation Error",
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "detail": "No auth token provided.",
  "status": 401,
  "title": "Missing Token",
  "type": "https://auth0.com/api-errors#A0E-401-0002"
}

{
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint.",
  "status": 403,
  "title": "Insufficient Scope",
  "type": "https://auth0.com/api-errors#A0E-403-0002"
}

{
  "detail": "The organization does not exist.",
  "status": 404,
  "title": "Resource Not Found",
  "type": "https://auth0.com/api-errors#A0E-404-0002"
}

{
  "detail": "The endpoint request limit has been exceeded.",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "type": "https://auth0.com/api-errors#A0E-429-0003"
}

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

invitation_id

string

requis

read-only

L’ID de l’invitation du membre

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

Paramètres de requête

fields

string

Liste de champs séparés par des virgules à inclure ou à exclure dans le résultat (selon la valeur fournie pour include_fields). Laissez vide pour récupérer tous les champs. Remarque : vous ne pouvez pas filtrer sur ticket_id, et cette valeur ne sera renvoyée que si les champs ne sont pas filtrés.

Required string length: 1 - 255

Pattern:

^(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url)(,(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url))*$

include_fields

boolean

défaut:true

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false). La valeur par défaut est true

Réponse

Obtenir une invitation de membre pour une organisation par ID.

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.