Lister les invitations destinées à un membre

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

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

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

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

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

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

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

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

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

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

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

GET

member-invitations

Lister les invitations destinées à un membre

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

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

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

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

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

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

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

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

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

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

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

Autorisations

Authorization

string

header

requis

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

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

from

string

Curseur facultatif à partir duquel commencer la sélection (exclusif).

Required string length: 1 - 1000

take

integer

défaut:50

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

sort

string

défaut:created_at:-1

Champ à utiliser pour le tri. Utilisez field:order, où order vaut 1 pour l’ordre croissant et -1 pour l’ordre décroissant. La valeur par défaut est created_at:-1

Pattern: ^created_at:(1|-1)$

include_totals

boolean

défaut:false

Lorsque true, la réponse inclut un décompte 'total' des éléments de l'ensemble de résultats (tenant compte des filtres actifs), ainsi qu'un indicateur 'total_is_capped'. Ce décompte est approximatif et plafonné à 1000 ; si la taille réelle peut être supérieure, 'total_is_capped' est true et 'total' constitue une borne inférieure. Omis s'il n'est pas demandé.

Réponse

Lister les invitations de membres pour une organisation.

string

Curseur de pagination pour la page de résultats suivante.

total

integer

read-only

Nombre approximatif d'invitations en attente dans l'ensemble de résultats (tenant compte des filtres actifs). Présent uniquement lorsque include_totals=true. Plafonné à 1000.

total_is_capped

boolean

read-only

Indique si le décompte s'est arrêté avant d'atteindre la taille réelle de l'ensemble de résultats. Lorsque true, 'total' constitue une borne inférieure (la taille réelle est égale ou supérieure à 'total') ; lorsque false, 'total' reflète l'ensemble complet de résultats tel qu'il a été décompté. Présent uniquement lorsque 'total' est présent.

invitations

object[]

Show child attributes