--- title: Read All External OAuth Servers description: The GET {{apiPath}}/v1/environments/{{envID}}/externalOAuthServers operation returns all external OAuth server resources associated with the environment. This request supports the limit, cursor, and filter query parameters. For more information, see Paging and ordering collections. component: pingone-api page_id: pingone-api:authorize:api-access-management/external-oauth-servers/read-all-external-oauth-servers canonical_url: https://developer.pingidentity.com/pingone-api/authorize/api-access-management/external-oauth-servers/read-all-external-oauth-servers.html section_ids: headers: Headers example-request: Example Request example-response: Example Response --- # Read All External OAuth Servers ## ```none GET {{apiPath}}/v1/environments/{{envID}}/externalOAuthServers ``` The `GET {{apiPath}}/v1/environments/{{envID}}/externalOAuthServers` operation returns all external OAuth server resources associated with the environment. This request supports the `limit`, `cursor`, and `filter` query parameters. For more information, see [Paging and ordering collections](../../../platform/reference/paging-ordering-collections.html). When successful, a `200 OK` message and a collection of the requested external OAuth server resources is returned. > **Collapse: Query parameters** > > | Query parameter | Attributes (or allowed limits) | > | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | > | `cursor` | N/A | > | `filter` | Supports filtering the `name` attribute using the `co` operator. See [Paging and ordering collections](../../../platform/reference/paging-ordering-collections.html) for more information. | > | `limit` | (1-25) | ### 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}}/externalOAuthServers' \ --header 'Authorization: Bearer {{accessToken}}' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers") { 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}}/externalOAuthServers" 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}}/externalOAuthServers 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}}/externalOAuthServers") .method("GET", body) .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers", "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}}/externalOAuthServers', '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}}/externalOAuthServers" payload = {} headers = { 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers'); $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}}/externalOAuthServers") 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}}/externalOAuthServers")!,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 { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/externalOAuthServers?limit=100" } }, "_embedded": { "externalOAuthServers": [ { "_links": { "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/externalOAuthServers/60a1fc3b-d08a-4afb-819f-ad461f22cd13" }, "apiServers": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers?filter=authorizationServer.externalOAuthServer.id%20eq%20%2260a1fc3b-d08a-4afb-819f-ad461f22cd13%22" } }, "id": "60a1fc3b-d08a-4afb-819f-ad461f22cd13", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "name": "Example", "description": "Something useful to the admin", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }, { "_links": { "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/externalOAuthServers/29e4c577-fea1-490c-a537-97264419ca81" }, "apiServers": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers?filter=authorizationServer.externalOAuthServer.id%20eq%20%2229e4c577-fea1-490c-a537-97264419ca81%22" } }, "id": "29e4c577-fea1-490c-a537-97264419ca81", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "name": "Example_1", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } } ] }, "size": 2 } ```