Obtener los miembros de una organización

Lista los miembros de la organización. Este endpoint está sujeto a consistencia eventual. Es posible que los usuarios nuevos no se incluyan de inmediato en la respuesta y que los usuarios eliminados no se quiten de inmediato de ella.

• Usa el parámetro fields para definir opcionalmente los detalles específicos de los miembros que se recuperarán. Si fields se deja en blanco, se devuelven todos los campos (excepto los roles).
• Los roles de los miembros no se envían de forma predeterminada. Usa fields=roles para recuperar los roles asignados a cada miembro listado. Para usar este parámetro, debes incluir el scope read:organization_member_roles en el token.

Este endpoint admite dos tipos de paginación:

• Paginación por offset
• Paginación por punto de control

Debes usar la paginación por punto de control si necesitas recuperar más de 1000 miembros de la organización.

Paginación por punto de control

Para buscar por punto de control, usa los siguientes parámetros: - from: id opcional a partir del cual iniciar la selección. - take: La cantidad total de entradas que se recuperarán al usar el parámetro from. El valor predeterminado es 50. Nota: La primera vez que llames a este endpoint usando paginación por punto de control, debes omitir el parámetro from. Si hay más resultados, se incluirá un valor next en la respuesta. Puedes usarlo en llamadas posteriores a la API. Cuando next deje de incluirse en la respuesta, esto indica que no quedan más páginas.

GET https://{tenantDomain}/api/v2/organizations/{id}/members

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.ListOrganizationMembersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Organizations.Members.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/members \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/members"

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations/{id}/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;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/organizations/{id}/members")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/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

200

[
  {
    "email": "[e-mail]",
    "name": "<string>",
    "picture": "<string>",
    "roles": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "user_id": "<string>"
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

Identificador de la organización.

Maximum string length: 50

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: 0 <= x <= 1000

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelve los resultados dentro de un objeto que contiene el recuento total de resultados (true) o como un arreglo de resultados directo (false, valor predeterminado).

from · string

Id opcional a partir del cual iniciar la selección.

take · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

fields · string

Lista de campos separados por comas que se incluirán o excluirán (según el valor proporcionado para include_fields) en el resultado. Déjelo en blanco para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados se incluirán (true) o se excluirán (false).

Respuesta

200

application/json

Miembros recuperados correctamente.

Option 1 · object[]

Option 2 · object

Option 3 · object

email · string<email> · predeterminado: [e-mail]

Dirección de correo electrónico de este usuario.

name · string

Nombre de este usuario.

picture · string

URL de la imagen de este usuario.

roles · object[]

Show child attributes

user_id · string

ID de este usuario.