--- title: Get IdPs Using a Key description: Use GET {{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}/idps to return the list of SAML identity providers associated with the specified key. component: pingone-api page_id: pingone-api:platform:certificate-management/get-key-idps canonical_url: https://developer.pingidentity.com/pingone-api/platform/certificate-management/get-key-idps.html llms_txt: https://developer.pingidentity.com/pingone-api/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md section_ids: headers: Headers example-request: Example Request example-response: Example Response --- # Get IdPs Using a Key ## ```none GET {{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}/idps ``` Use `GET {{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}/idps` to return the list of SAML identity providers associated with the specified key. To associate a key with a SAML identity provider, specify the key ID in the `spSigning.key.id` property when creating or updating the identity provider. Refer to [Create Identity Provider (SAML)](../identity-provider-management/identity-providers/create-identity-provider-saml.html) and [Update Identity Provider](../identity-provider-management/identity-providers/update-identity-provider.html). ### 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}}/keys/{{keyID}}/idps' \ --header 'Authorization: Bearer {{accessToken}}' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}/idps") { 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}}/keys/{{keyID}}/idps" 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}}/keys/{{keyID}}/idps 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}}/keys/{{keyID}}/idps") .method("GET", body) .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}/idps", "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}}/keys/{{keyID}}/idps', '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}}/keys/{{keyID}}/idps" payload = {} headers = { 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}/idps'); $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}}/keys/{{keyID}}/idps") 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}}/keys/{{keyID}}/idps")!,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": { "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/keys/c7ec74f0-c744-4aae-b3c7-89191dea61e1/idps?limit=5000" }, "key": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/c7ec74f0-c744-4aae-b3c7-89191dea61e1" } }, "_embedded": { "idps": [ { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/c7ec74f0-c744-4aae-b3c7-89191dea61e1/idps/343d2fa1-a405-45b2-ace7-22abcd208fea" } }, "id": "343d2fa1-a405-45b2-ace7-22abcd208fea", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "name": "New SAMLIdP" } ] }, "size": 1 } ```