PingOne Platform APIs

Read All Resources

   

GET {{apiPath}}/environments/{{envID}}/resources

The GET {{apiPath}}/environments/{{envID}}/resources endpoint returns a list of all resource entities associated with the specified environment resource.

Query parameters
Query parameter Attributes (or allowed limits)

filter

N/A

limit

N/A

expand

scopes

order

N/A

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/resources' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/resources")
{
  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);
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/resources"
  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))
}
GET /environments/{{envID}}/resources HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/resources")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/resources",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/resources',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envID}}/resources"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/resources');
$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();
}
require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/resources")

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
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/resources")!,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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources"
        }
    },
    "_embedded": {
        "resources": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/01d6ab7f-73fb-4950-aa22-d0004eb92fe8"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/01d6ab7f-73fb-4950-aa22-d0004eb92fe8/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/01d6ab7f-73fb-4950-aa22-d0004eb92fe8/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/01d6ab7f-73fb-4950-aa22-d0004eb92fe8/secret"
                    }
                },
                "id": "01d6ab7f-73fb-4950-aa22-d0004eb92fe8",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource_1676592651",
                "description": "this is my resource",
                "type": "CUSTOM",
                "audience": "CustomResource_1676592651",
                "createdAt": "2023-02-17T00:10:50.809Z",
                "updatedAt": "2023-02-17T00:10:50.809Z",
                "accessTokenValiditySeconds": 3600,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": false
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/0d3be395-5267-4c32-ac3b-a50843c6e342"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/0d3be395-5267-4c32-ac3b-a50843c6e342/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/0d3be395-5267-4c32-ac3b-a50843c6e342/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/0d3be395-5267-4c32-ac3b-a50843c6e342/secret"
                    }
                },
                "id": "0d3be395-5267-4c32-ac3b-a50843c6e342",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource_1633386113",
                "description": "this is my resource",
                "type": "CUSTOM",
                "audience": "CustomResource_1633386113",
                "createdAt": "2021-10-04T22:21:53.372Z",
                "updatedAt": "2022-08-19T20:26:47.412Z",
                "accessTokenValiditySeconds": 3600,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": false
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/15bbe48c-33e2-4b16-8148-d849ba8ad643"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/15bbe48c-33e2-4b16-8148-d849ba8ad643/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/15bbe48c-33e2-4b16-8148-d849ba8ad643/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/15bbe48c-33e2-4b16-8148-d849ba8ad643/secret"
                    }
                },
                "id": "15bbe48c-33e2-4b16-8148-d849ba8ad643",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource_1677098466",
                "description": "this is my resource",
                "type": "CUSTOM",
                "audience": "CustomResource_1677098466",
                "createdAt": "2023-02-22T20:41:05.986Z",
                "updatedAt": "2023-02-22T20:41:05.986Z",
                "accessTokenValiditySeconds": 3600,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": false
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/4ae5e950-6cf5-4109-87de-ccadd1363c13"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/4ae5e950-6cf5-4109-87de-ccadd1363c13/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/4ae5e950-6cf5-4109-87de-ccadd1363c13/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/4ae5e950-6cf5-4109-87de-ccadd1363c13/secret"
                    }
                },
                "id": "4ae5e950-6cf5-4109-87de-ccadd1363c13",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource11",
                "description": "This is my custom resource",
                "type": "CUSTOM",
                "audience": "https://api.custom.com",
                "createdAt": "2023-12-05T16:34:49.917Z",
                "updatedAt": "2023-12-05T16:34:49.917Z",
                "accessTokenValiditySeconds": 7200,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": false
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/5f650ccb-42e0-4880-8140-4d2c2b194a0e"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/5f650ccb-42e0-4880-8140-4d2c2b194a0e/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/5f650ccb-42e0-4880-8140-4d2c2b194a0e/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/5f650ccb-42e0-4880-8140-4d2c2b194a0e/secret"
                    }
                },
                "id": "5f650ccb-42e0-4880-8140-4d2c2b194a0e",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource_1676592098",
                "description": "This is my custom resource",
                "type": "CUSTOM",
                "audience": "https://api.custom-resource.com",
                "createdAt": "2023-02-17T00:01:38.383Z",
                "updatedAt": "2023-02-17T00:01:38.383Z",
                "accessTokenValiditySeconds": 7200,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": false
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566/secret"
                    }
                },
                "id": "9fd86709-4faf-4b59-b789-f46574ffb566",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource1709685712",
                "description": "This is my custom resource",
                "type": "CUSTOM",
                "audience": "https://api.customresource1709685712.com",
                "createdAt": "2024-03-06T00:41:52.636Z",
                "updatedAt": "2024-03-06T00:41:52.636Z",
                "accessTokenValiditySeconds": 7200,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/f458e70b-685f-4f21-b930-caf70d13a0d2"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/f458e70b-685f-4f21-b930-caf70d13a0d2/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/f458e70b-685f-4f21-b930-caf70d13a0d2/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/f458e70b-685f-4f21-b930-caf70d13a0d2/secret"
                    }
                },
                "id": "f458e70b-685f-4f21-b930-caf70d13a0d2",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "CustomResource1709684665",
                "description": "This is my custom resource",
                "type": "CUSTOM",
                "audience": "https://api.customresource.com",
                "createdAt": "2024-03-06T00:24:25.162Z",
                "updatedAt": "2024-03-06T00:24:25.162Z",
                "accessTokenValiditySeconds": 7200,
                "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                "applicationPermissionsSettings": {
                    "claimEnabled": false
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/685099a0-8e66-4663-af07-60c46f7f964d"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/685099a0-8e66-4663-af07-60c46f7f964d/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/685099a0-8e66-4663-af07-60c46f7f964d/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/685099a0-8e66-4663-af07-60c46f7f964d/secret"
                    }
                },
                "id": "685099a0-8e66-4663-af07-60c46f7f964d",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "PingOne API",
                "description": "This is the resource you’re using to talk to Ping servers.",
                "type": "PINGONE_API"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "scopes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8/scopes"
                    },
                    "attributes": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8/attributes"
                    },
                    "secret": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8/secret"
                    }
                },
                "id": "71ff29d5-c666-4348-b54e-c5b64f0a80b8",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "openid",
                "description": "OpenID Connect scopes can be used to request that specific sets of information be made available as Claim Values in the ID token and the UserInfo endpoint.",
                "type": "OPENID_CONNECT"
            }
        ]
    },
    "count": 9,
    "size": 9
}