PingOne Platform APIs

Read Application Role Users

 

GET {{apiPath}}/environments/{{envID}}/applicationRoles/{{appRoleID}}/users?limit=2&expand=user

The GET {{apiPath}}/environments/{{envID}}/applicationRoles/{{appRoleID}}/users request returns a list of users assigned to the application role identified by its ID in the request URL.

To obtain additional user data, the expand=user query parameter can be provided. Doing so will result in the inclusion of an additional _embedded.user property in each item in the collection.

Query parameters
Query parameter Description

cursor

The opaque page cursor.

expand

Shows additional user information. Only expand=user is accepted.

limit

Sets the number of records returned per page. Value must be between 1 and 1024 inclusive. The default value is 25.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

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

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}}/applicationRoles/{{appRoleID}}/users?limit=2&expand=user');
$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}}/applicationRoles/{{appRoleID}}/users?limit=2&expand=user")

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}}/applicationRoles/{{appRoleID}}/users?limit=2&expand=user")!,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": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationRoles/c1e0a1fe-a310-4ad1-a021-ad523e11027c/users?limit=2&expand=user"
        },
        "next": {
            "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationRoles/c1e0a1fe-a310-4ad1-a021-ad523e11027c/users?limit=2&expand=user"
        }
    },
    "_embedded": {
        "users": [
            {
                "_links": {
                    "self": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationRoles/c1e0a1fe-a310-4ad1-a021-ad523e11027c/users/1cad5204-f138-4360-ab92-5153b4f3167c"
                    },
                    "environment": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/1cad5204-f138-4360-ab92-5153b4f3167c"
                    },
                    "role": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationRoles/c1e0a1fe-a310-4ad1-a021-ad523e11027c"
                    }
                },
                "_embedded": {
                    "user": {
                        "_links": {
                            "self": {
                                "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/1cad5204-f138-4360-ab92-5153b4f3167c"
                            },
                            "environment": {
                                "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                            },
                            "population": {
                                "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/677082e9-26ac-4371-835a-27470cb7bdd4"
                            }
                        },
                        "environment": {
                            "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        },
                        "population": {
                            "id": "677082e9-26ac-4371-835a-27470cb7bdd4"
                        },
                        "id": "1cad5204-f138-4360-ab92-5153b4f3167c",
                        "username": "msample",
                        "email": "msample@example.com",
                        "name": {
                            "family": "Sample",
                            "given": "Mary",
                            "middle": "Gordon",
                            "honorificPrefix": "Ms.",
                            "honorificSuffix": "Esq.",
                            "formatted": "Ms. Mary Sample, Esq."
                        },
                        "nickname": "Example",
                        "title": "CEO",
                        "locale": "en-US"
                    }
                },
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "id": "1cad5204-f138-4360-ab92-5153b4f3167c"
            },
            {
                "_links": {
                    "self": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationRoles/c1e0a1fe-a310-4ad1-a021-ad523e11027c/users/a2e435ea-f108-4b83-a192-1a3740487a30"
                    },
                    "environment": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a2e435ea-f108-4b83-a192-1a3740487a30"
                    },
                    "role": {
                        "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationRoles/c1e0a1fe-a310-4ad1-a021-ad523e11027c"
                    }
                },
                "_embedded": {
                    "user": {
                        "_links": {
                            "self": {
                                "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a2e435ea-f108-4b83-a192-1a3740487a30"
                            },
                            "environment": {
                                "href": "/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                            }
                        },
                        "environment": {
                            "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        },
                        "id": "a2e435ea-f108-4b83-a192-1a3740487a30"
                    }
                },
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "id": "a2e435ea-f108-4b83-a192-1a3740487a30"
            }
        ]
    },
    "count": 2,
    "size": 2
}