PingOne Platform APIs

Step 3: Get all OIDC scopes

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

OpenID Connect scopes control which user claims are included in an access token. This use case requires the profile OIDC scope, which provides access to the end-user’s default profile claims, such as name, family_name, given_name, middle_name, preferred_username, picture, zoneinfo, locale, and updated_at.

The GET /environments/{{envID}}/resources/{{resourceID}}/scopes endpoint returns a list of all scopes associated with the specified resource. The resource entity ID for openid is identified in the request URL.

The response data includes the ID for each defined resource scope associated with the associated with the openid resource entity.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/resources/{{openidResourceID}}/scopes' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/resources/{{openidResourceID}}/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/{{openidResourceID}}/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/{{openidResourceID}}/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/{{openidResourceID}}/scopes")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/resources/{{openidResourceID}}/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/{{openidResourceID}}/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/{{openidResourceID}}/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/{{openidResourceID}}/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/{{openidResourceID}}/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/{{openidResourceID}}/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/ddc0166d-ea9f-4a11-8399-dde0c29c0efa/scopes"
        }
    },
    "_embedded": {
        "scopes": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa/scopes/0baa11b2-7b0b-407b-b31b-662f93b8fef3"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "id": "0baa11b2-7b0b-407b-b31b-662f93b8fef3",
                "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": "ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                },
                "createdAt": "2022-06-13T19:03:52.022Z",
                "updatedAt": "2022-06-13T19:03:52.022Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa/scopes/3e8bc319-f84e-4139-a9eb-64c758f1ae4e"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "id": "3e8bc319-f84e-4139-a9eb-64c758f1ae4e",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "openid",
                "description": "Access to the required Claims",
                "resource": {
                    "id": "ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                },
                "createdAt": "2022-06-13T19:03:52.022Z",
                "updatedAt": "2022-06-13T19:03:52.022Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa/scopes/8b54df04-cc89-4cbc-bf57-0fac8751d79f"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "id": "8b54df04-cc89-4cbc-bf57-0fac8751d79f",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "phone",
                "description": "Access to the phone_number and phone_number_verified Claims",
                "resource": {
                    "id": "ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                },
                "createdAt": "2022-06-13T19:03:52.022Z",
                "updatedAt": "2022-06-13T19:03:52.022Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa/scopes/ad52d66d-2f60-4c6e-866c-893a8cfb594a"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "id": "ad52d66d-2f60-4c6e-866c-893a8cfb594a",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "address",
                "description": "Access to the address Claim",
                "resource": {
                    "id": "ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                },
                "createdAt": "2022-06-13T19:03:52.022Z",
                "updatedAt": "2022-06-13T19:03:52.022Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa/scopes/f8dc290b-6266-4f84-8b3b-404b6b88a6a5"
                    },
                    "resource": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "id": "f8dc290b-6266-4f84-8b3b-404b6b88a6a5",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "email",
                "description": "Access to the email and email_verified Claims",
                "resource": {
                    "id": "ddc0166d-ea9f-4a11-8399-dde0c29c0efa"
                },
                "createdAt": "2022-06-13T19:03:52.022Z",
                "updatedAt": "2022-06-13T19:03:52.022Z"
            }
        ]
    },
    "count": 5,
    "size": 5
}