Obtenir les groupes - Auth0 Docs

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Groups.ListAsync(
            new ListGroupsRequestParameters {
                ConnectionId = "connection_id",
                Name = "name",
                ExternalId = "external_id",
                Search = "search",
                Fields = "fields",
                IncludeFields = true,
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListGroupsRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.groups().list(
            ListGroupsRequestParameters
                .builder()
                .connectionId("connection_id")
                .name("name")
                .externalId("external_id")
                .search("search")
                .fields("fields")
                .includeFields(true)
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Groups\Requests\ListGroupsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->groups->list(
    new ListGroupsRequestParameters([
        'connectionId' => 'connection_id',
        'name' => 'name',
        'externalId' => 'external_id',
        'search' => 'search',
        'fields' => 'fields',
        'includeFields' => true,
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.groups.list(
    connection_id="connection_id",
    name="name",
    external_id="external_id",
    search="search",
    fields="fields",
    include_fields=True,
    from="from",
    take=1,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.groups.list(
  connection_id: "connection_id",
  name: "name",
  external_id: "external_id",
  search: "search",
  fields: "fields",
  include_fields: true,
  from: "from",
  take: 1
)

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

fetch('https://{tenantDomain}/api/v2/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://{tenantDomain}/api/v2/groups"

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

}

[
  {
    "connection_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "id": "<string>",
    "name": "<string>",
    "tenant_name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

GET

https://{tenantDomain}/api/v2

groups

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Groups.ListAsync(
            new ListGroupsRequestParameters {
                ConnectionId = "connection_id",
                Name = "name",
                ExternalId = "external_id",
                Search = "search",
                Fields = "fields",
                IncludeFields = true,
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListGroupsRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.groups().list(
            ListGroupsRequestParameters
                .builder()
                .connectionId("connection_id")
                .name("name")
                .externalId("external_id")
                .search("search")
                .fields("fields")
                .includeFields(true)
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Groups\Requests\ListGroupsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->groups->list(
    new ListGroupsRequestParameters([
        'connectionId' => 'connection_id',
        'name' => 'name',
        'externalId' => 'external_id',
        'search' => 'search',
        'fields' => 'fields',
        'includeFields' => true,
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.groups.list(
    connection_id="connection_id",
    name="name",
    external_id="external_id",
    search="search",
    fields="fields",
    include_fields=True,
    from="from",
    take=1,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.groups.list(
  connection_id: "connection_id",
  name: "name",
  external_id: "external_id",
  search: "search",
  fields: "fields",
  include_fields: true,
  from: "from",
  take: 1
)

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

fetch('https://{tenantDomain}/api/v2/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://{tenantDomain}/api/v2/groups"

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

}

[
  {
    "connection_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "id": "<string>",
    "name": "<string>",
    "tenant_name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Autorisations

Authorization

string

header

requis

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

Paramètres de requête

connection_id

string

Filtrer les groupes par ID de connexion.

name

string

Filtrer les groupes par nom.

Required string length: 1 - 128

external_id

string

Filtrer les groupes par ID externe.

Maximum string length: 256

string

Rechercher des groupes par nom ou par ID externe.

Required string length: 1 - 256

fields

string

Une liste de champs séparés par des virgules à inclure ou à exclure (selon include_fields) dans le résultat; laisser vide pour récupérer tous les champs

Maximum string length: 256

include_fields

boolean

Indique si les champs précisés doivent être inclus (true) ou exclus (false).

page

integer

Index de la page de résultats à retourner. La première page est 0.

Plage requise: x >= 0

per_page

integer

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

Plage requise: 1 <= x <= 100

include_totals

boolean

Retourner les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de array directe de résultats (false, par défaut).

from

string

ID facultatif à partir duquel commencer la sélection.

take

integer

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

Plage requise: 1 <= x <= 100

Réponse

Groupes récupérés avec succès.

object[]
object

Représente les métadonnées d’un groupe. Les listes de membres sont récupérées au moyen d’un endpoint distinct.

connection_id

string<connection-id>

Identifiant de la connexion à laquelle ce groupe appartient (s’il s’agit d’un groupe de connexion).

created_at

string<date-time>

Horodatage de la création du groupe.

external_id

string

Identifiant externe du groupe, souvent utilisé pour la synchronisation SCIM. Longueur maximale de 256 caractères.

Maximum string length: 256

string

Identifiant unique du groupe (généré par le service).

Required string length: 18 - 26

Pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$

name

string

Nom du groupe. Doit être unique dans sa connexion. Doit contenir entre 1 et 128 caractères ASCII imprimables.

Required string length: 1 - 128

Pattern: ^[\x20-\x7E]+$

tenant_name

string

Identifiant du tenant auquel ce groupe appartient.

Minimum string length: 3

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

updated_at

string<date-time>

Horodatage de la dernière mise à jour du groupe.