Get a list of directory provisioning configurations

Retrieve a list of directory provisioning configurations of a tenant.

GET https://{tenantDomain}/api/v2/connections-directory-provisionings

C#

C#

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

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.Connections.DirectoryProvisioning.ListAsync(
            new ListDirectoryProvisioningsRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.connections.types.ListDirectoryProvisioningsRequestParameters;

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

        client.connections().directoryProvisioning().list(
            ListDirectoryProvisioningsRequestParameters
                .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\Connections\DirectoryProvisioning\Requests\ListDirectoryProvisioningsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->directoryProvisioning->list(
    new ListDirectoryProvisioningsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.connections.directory_provisioning.list(
    from="from",
    take=1,
)

require "auth0"

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

client.connections.directory_provisioning.list(
  from: "from",
  take: 1
)

curl --request GET \
  --url https://{tenantDomain}/api/v2/connections-directory-provisionings \
  --header 'Authorization: Bearer <token>'

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

fetch('https://{tenantDomain}/api/v2/connections-directory-provisionings', 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/connections-directory-provisionings"

	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

{
  "directory_provisionings": [
    {
      "connection_id": "<string>",
      "connection_name": "<string>",
      "strategy": "<string>",
      "mapping": [
        {
          "auth0": "<string>",
          "idp": "<string>"
        }
      ],
      "synchronize_automatically": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_synchronization_at": "2023-11-07T05:31:56Z",
      "last_synchronization_status": "<string>",
      "last_synchronization_error": "<string>"
    }
  ],
  "next": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Query Parameters

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

Response

200

application/json

The tenant's directory provisioning configuration. See Response Schemas for schema.

directory_provisionings · object[] · required

List of directory provisioning configurations

Show child attributes

next · string

The cursor to be used as the "from" query parameter for the next page of results.