List organization client associations

List all clients associated with an organization, using checkpoint pagination.

• Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.

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

C#

C#

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

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.Organizations.Clients.ListAsync(
            id: "id",
            request: new ListOrganizationClientsRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationClientsRequestParameters;

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

        client.organizations().clients().list(
            "id",
            ListOrganizationClientsRequestParameters
                .builder()
                .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\Organizations\Clients\Requests\ListOrganizationClientsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->clients->list(
    'id',
    new ListOrganizationClientsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.organizations.clients.list(
    id="id",
    from="from",
    take=1,
)

require "auth0"

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

client.organizations.clients.list(
  id: "id",
  from: "from",
  take: 1
)

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

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

fetch('https://{tenantDomain}/api/v2/organizations/{id}/clients', 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/organizations/{id}/clients"

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

}

200

{
  "clients": [
    {
      "client_id": "<string>",
      "use_for_member_access": true,
      "client": {
        "name": "<string>",
        "app_type": "<string>",
        "logo_uri": "<string>",
        "is_first_party": true,
        "grant_types": [
          "<string>"
        ]
      }
    }
  ],
  "next": "<string>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string<organization-id> · requis

ID of the organization.

Paramètres de requête

from · string

Optional Id from which to start selection.

take · integer · défaut: 50

Number of results per page. Defaults to 50. Values greater than the maximum of 100 are capped at 100.

Plage requise: x >= 1

Réponse

200

application/json

Organization clients successfully retrieved.

clients · object[] · requis

The list of clients associated with the organization.

Show child attributes

next · string

An opaque token that, when present, can be passed as the from query parameter to retrieve the next page of results.