PingOne Platform APIs

Step 4: Get all scopes

   

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

The GET /environments/{{envID}}/resources/{{resourceID}}/scopes operation returns information about the scopes associated with the resource ID specified in the request URL. The value for {{resourceID}} is the ID associated with the openid resource returned in Step 3.

From the list of scopes returned, note the ID of offline_access scope. You will use this value when creating the resource access grant in Step 5.

There are several scopes returned by this GET request. In this activity, you need only the offline_access scope.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

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

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/{{oidcResID}}/scopes');
$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/{{oidcResID}}/scopes")

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/{{oidcResID}}/scopes")!,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/66563974-b980-4307-b45b-b0b945e08ecf/scopes"
        }
    },
    "_embedded": {
        "scopes": [
            {
                "_links": {
                    "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/66563974-b980-4307-b45b-b0b945e08ecf"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/66563974-b980-4307-b45b-b0b945e08ecf/scopes/16c4f974-7c7f-4578-b1ae-e4630b87d97f"
                    }
                },
                "id": "16c4f974-7c7f-4578-b1ae-e4630b87d97f",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "address",
                "description": "Access to the address Claim",
                "resource": {
                    "id": "66563974-b980-4307-b45b-b0b945e08ecf"
                },
                "createdAt": "2022-06-13T18:51:37.346Z",
                "updatedAt": "2022-06-13T18:51:37.346Z"
            },
            {
                "_links": {
                    "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/66563974-b980-4307-b45b-b0b945e08ecf"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/66563974-b980-4307-b45b-b0b945e08ecf/scopes/30c2f01d-9f96-45aa-8895-62f5002d57aa"
                    }
                },
                "id": "30c2f01d-9f96-45aa-8895-62f5002d57aa",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "phone",
                "description": "Access to the phone_number and phone_number_verified Claims",
                "resource": {
                    "id": "66563974-b980-4307-b45b-b0b945e08ecf"
                },
                "createdAt": "2022-06-13T18:51:37.346Z",
                "updatedAt": "2022-06-13T18:51:37.346Z"
            },
            {
                "_links": {
                    "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/66563974-b980-4307-b45b-b0b945e08ecf"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/66563974-b980-4307-b45b-b0b945e08ecf/scopes/434a0612-3179-4692-bcf9-2d12ecf42690"
                    }
                },
                "id": "434a0612-3179-4692-bcf9-2d12ecf42690",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "email",
                "description": "Access to the email and email_verified Claims",
                "resource": {
                    "id": "66563974-b980-4307-b45b-b0b945e08ecf"
                },
                "createdAt": "2022-06-13T18:51:37.346Z",
                "updatedAt": "2022-06-13T18:51:37.346Z"
            },
            {
                "_links": {
                    "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/66563974-b980-4307-b45b-b0b945e08ecf"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/66563974-b980-4307-b45b-b0b945e08ecf/scopes/851dec00-ab51-482f-9e29-099edf8d2e7b"
                    }
                },
                "id": "851dec00-ab51-482f-9e29-099edf8d2e7b",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "openid",
                "description": "Access to the required Claims",
                "resource": {
                    "id": "66563974-b980-4307-b45b-b0b945e08ecf"
                },
                "createdAt": "2022-06-13T18:51:37.346Z",
                "updatedAt": "2022-06-13T18:51:37.346Z"
            },
            {
                "_links": {
                    "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/66563974-b980-4307-b45b-b0b945e08ecf"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/66563974-b980-4307-b45b-b0b945e08ecf/scopes/a0d75abd-fc47-403e-ad83-a7b436ed0d55"
                    }
                },
                "id": "a0d75abd-fc47-403e-ad83-a7b436ed0d55",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "offline_access",
                "description": "Allow applications to access previously approved resources without user interactions",
                "resource": {
                    "id": "66563974-b980-4307-b45b-b0b945e08ecf"
                },
                "createdAt": "2024-08-21T03:33:20.745Z",
                "updatedAt": "2024-08-21T03:33:20.745Z"
            },
            {
                "_links": {
                    "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/66563974-b980-4307-b45b-b0b945e08ecf"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/66563974-b980-4307-b45b-b0b945e08ecf/scopes/b03c3eab-2814-496d-84d9-0b7614c47ec6"
                    }
                },
                "id": "b03c3eab-2814-496d-84d9-0b7614c47ec6",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "profile",
                "description": "Access to the default profile Claims: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, profile, gender, birthdate, website and updated_at",
                "resource": {
                    "id": "66563974-b980-4307-b45b-b0b945e08ecf"
                },
                "createdAt": "2022-06-13T18:51:37.346Z",
                "updatedAt": "2022-06-13T18:51:37.346Z"
            }
        ]
    },
    "count": 6,
    "size": 6
}