Get synchronized groups for a directory provisioning configuration

Retrieve the configured synchronized groups for a connection directory provisioning configuration.

GET https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronized-groups

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Connections.DirectoryProvisioning.ListSynchronizedGroupsAsync(
            id: "id",
            request: new ListSynchronizedGroupsRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.connections.directoryprovisioning.requests.ListSynchronizedGroupsRequestParameters;

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

        client.connections().directoryProvisioning().listSynchronizedGroups(
            "id",
            ListSynchronizedGroupsRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Connections\DirectoryProvisioning\Requests\ListSynchronizedGroupsRequestParameters;

$client = new Management(
    token: '<token>',
);
$client->connections->directoryProvisioning->listSynchronizedGroups(
    'id',
    new ListSynchronizedGroupsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

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

require "auth0"

client = Auth0::Management.new(token: "<token>")

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

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

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

fetch('https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronized-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/connections/{id}/directory-provisioning/synchronized-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))

}

200

{
  "groups": [
    {
      "id": "<string>"
    }
  ],
  "next": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

The id of the connection to list synchronized groups for.

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 connection's synchronized groups. See Response Schemas for schema.

groups · object[] · required

Array of Google Workspace group ids configured for synchronization.

Show child attributes

next · string

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