PingOne Platform APIs

Read All Grants for an Application

   

GET {{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants

The GET {{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants endpoint returns a list of all resource access grants for the application specified in the request URL.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants")
{
  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}}/applications/{{appID}}/grants"
  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}}/applications/{{appID}}/grants 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}}/applications/{{appID}}/grants")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants",
  "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}}/applications/{{appID}}/grants',
  '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}}/applications/{{appID}}/grants"

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}}/applications/{{appID}}/grants');
$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}}/applications/{{appID}}/grants")

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}}/applications/{{appID}}/grants")!,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/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8/grants"
        }
    },
    "_embedded": {
        "grants": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8/grants/90c0b478-27fb-4dea-abfb-88ff342bf973"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/e303cdcd-2fce-4181-90a9-ff945280ae4a"
                    },
                    "application": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
                    }
                },
                "id": "90c0b478-27fb-4dea-abfb-88ff342bf973",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "resource": {
                    "id": "e303cdcd-2fce-4181-90a9-ff945280ae4a"
                },
                "application": {
                    "id": "cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
                },
                "scopes": [
                    {
                        "id": "c61ff2ab-a737-4414-980b-623ffb940615"
                    },
                    {
                        "id": "b59704a4-09d8-472c-ac67-2dd8174d772f"
                    },
                    {
                        "id": "93910dcd-ea31-47fe-955c-ab4e1ce7f9fa"
                    },
                    {
                        "id": "3569ca12-be5a-4beb-a02b-445b03a45e43"
                    }
                ],
                "createdAt": "2019-08-13T19:39:58.450Z",
                "updatedAt": "2019-08-13T19:39:58.450Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8/grants/bdbbc71f-5901-4c33-bbe3-3a50f706f01e"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"
                    },
                    "application": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
                    }
                },
                "id": "bdbbc71f-5901-4c33-bbe3-3a50f706f01e",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "resource": {
                    "id": "faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"
                },
                "application": {
                    "id": "cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
                },
                "scopes": [
                    {
                        "id": "760b1244-eb46-4892-a4a7-4ac690fe53c4"
                    },
                    {
                        "id": "45cd01da-a65d-4e2e-974b-a2104d4c6450"
                    },
                    {
                        "id": "67db9776-afc2-40c3-938e-349b21ef9a55"
                    },
                    {
                        "id": "7dd08cb4-bf99-4186-bad3-b8f84e6678de"
                    },
                    {
                        "id": "e620535c-e3da-48be-ba9c-999b2f747d40"
                    },
                    {
                        "id": "a3db1605-8d0f-4b79-929c-c342da84121f"
                    },
                    {
                        "id": "ca118588-0ad4-4543-ae82-c9cf3b4bc105"
                    },
                    {
                        "id": "30d8f2bc-e7b6-457b-bd1f-c0d914d55bb4"
                    },
                    {
                        "id": "17e45f29-e04f-4cd1-af0a-989d72cb0440"
                    },
                    {
                        "id": "4cff30a3-15ea-46b2-94a3-c7cea942597a"
                    },
                    {
                        "id": "ce53b847-de04-4263-8002-7f61858c860f"
                    },
                    {
                        "id": "ab56fbe2-254a-4fc0-acf9-314c86c9e4db"
                    },
                    {
                        "id": "c3db58ac-503d-493b-98c7-f26170f5cbdb"
                    },
                    {
                        "id": "a4d9fce6-fb9e-445c-a419-087cf8c36ae0"
                    },
                    {
                        "id": "bafc2d76-91e2-4f78-a706-ceb641f86d67"
                    }
                ],
                "createdAt": "2019-08-13T19:39:58.442Z",
                "updatedAt": "2019-08-13T19:39:58.442Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8/grants/c95c0f55-524c-4b7e-bbab-07ba2c47aa93"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/b6f08ba7-a50b-44f0-922f-91c03f0390f8"
                    },
                    "application": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
                    }
                },
                "id": "c95c0f55-524c-4b7e-bbab-07ba2c47aa93",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "resource": {
                    "id": "b6f08ba7-a50b-44f0-922f-91c03f0390f8"
                },
                "application": {
                    "id": "cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
                },
                "scopes": [
                    {
                        "id": "a24ec929-f241-4f21-85ea-0d710910239c"
                    }
                ],
                "createdAt": "2020-02-19T20:21:31.756Z",
                "updatedAt": "2020-02-19T20:21:31.756Z"
            }
        ]
    },
    "count": 3,
    "size": 3
}