--- title: Read All Synced Groups for a Rule description: The GET {{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups endpoint returns all synchronized groups for the specified identity propagation rule in the specified environment. component: pingone-api page_id: pingone-api:platform:identity-propagation-provisioning/propagation-rules/read-all-synced-groups-for-a-rule canonical_url: https://developer.pingidentity.com/pingone-api/platform/identity-propagation-provisioning/propagation-rules/read-all-synced-groups-for-a-rule.html section_ids: headers: Headers example-request: Example Request example-response: Example Response --- # Read All Synced Groups for a Rule ## ```none GET {{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups ``` The `GET {{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups` endpoint returns all synchronized groups for the specified identity propagation rule in the specified environment. Pagination is supported for response using the `limit` and `cursor` query parameters. The first 1000 groups are returned if no pagination parameters are supplied in the request. > **Collapse: Query parameters** > > | Parameter | Description | > | --------- | ------------------------------------------------------ | > | `limit` | Indicates the number of items to be returned per page. | > | `cursor` | Indicates the first item to retrieve. | ### Headers Authorization      Bearer {{accessToken}} ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups' \ --header 'Authorization: Bearer {{accessToken}}' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Get); request.AddHeader("Authorization", "Bearer {{accessToken}}"); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups" method := "GET" client := &http.Client { } req, err := http.NewRequest(method, url, nil) if err != nil { fmt.Println(err) return } req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http GET /v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups HTTP/1.1 Host: {{apiPath}} Authorization: Bearer {{accessToken}} ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = RequestBody.create(mediaType, ""); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups") .method("GET", body) .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups", "method": "GET", "timeout": 0, "headers": { "Authorization": "Bearer {{accessToken}}" }, }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'GET', 'url': '{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups', 'headers': { 'Authorization': 'Bearer {{accessToken}}' } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests url = "{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups" payload = {} headers = { 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups'); $request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Authorization' => 'Bearer {{accessToken}}' )); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer {{accessToken}}" response = http.request(request) puts response.read_body ``` ```swift var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/propagation/rules/{{ruleID}}/syncedGroups")!,timeoutInterval: Double.infinity) request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "GET" let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 200 OK ```json { "_embedded":{ "syncedGroups":[ { "group":{ "id":"1d7cbf0f-134c-42dc-9dbc-be57fa0828a0" }, "environment":{ "id":"{environmentID}" }, "status":"SUCCESS", "lastSyncAt":"2023-02-15T17:03:39.763Z", "details":"", "_links":{ "environment":{ "id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "self":{ "href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/d9e48a06-e691-4adc-a8c7-4bc53e171e85/syncedGroups/1d7cbf0f-134c-42dc-9dbc-be57fa0828a0" } } } ] }, "_links":{ "self":{ "href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rule/d9e48a06-e691-4adc-a8c7-4bc53e171e85/syncedGroups" } } } ```