List privilegedRoles

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Retrieve a list of privilegedRole objects.

To filter the results from the query, use the standard OData $filter expressions in the URIs.

Prerequisites

The following scopes are required to execute this API: Directory.AccessAsUser.All

The requestor needs to have one of the following roles: Privileged Role Administrator, Global Administrator, Security Administrator, or Security Reader.

HTTP request

GET /privilegedRoles

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of privilegedRole objects in the response body.

Note that the tenant needs to be registered to PIM. Otherwise, the HTTP 403 Forbidden status code will be returned.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/beta/privilegedRoles
Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 83

{
  "value": [
    {
      "id": "id-value",
      "name": "name-value"
    }
  ]
}