Lister les membres de l’organisation

Lister les membres

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

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

fetch('https://{tenantDomain}/my-org/v1/members', 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/members",
  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/members"

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

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

{
  "members": [
    {
      "email": "roadrunner@acme.com",
      "roles": [
        {
          "id": "rol_BKI0BKI0BKI0BKI0",
          "name": "role1"
        },
        {
          "id": "rol_BKW1BKIfBKd0BaI0",
          "name": "role2"
        }
      ],
      "user_id": "auth0|123234235"
    }
  ]
}

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

members

Lister les membres

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

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

fetch('https://{tenantDomain}/my-org/v1/members', 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/members",
  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/members"

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

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

{
  "members": [
    {
      "email": "roadrunner@acme.com",
      "roles": [
        {
          "id": "rol_BKI0BKI0BKI0BKI0",
          "name": "role1"
        },
        {
          "id": "rol_BKW1BKIfBKd0BaI0",
          "name": "role2"
        }
      ],
      "user_id": "auth0|123234235"
    }
  ]
}

{
  "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 requête

fields

string

Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez vide pour récupérer tous les champs. Le champ 'roles' n’est pas renvoyé par défaut ; il n’est inclus que lorsque 'roles' est explicitement demandé dans la liste des champs (mode inclusion) et que le jeton contient aussi la portée read:my_org:member_roles. Si 'roles' est demandé sans cette portée, il est silencieusement omis de la réponse.

Required string length: 1 - 255

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

Réponse

Lister les membres d’une organisation.

members

object[]

Show child attributes

string

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