See api-docs Menu
  1. Home >
  2. API >
  3. 1 >
  4. Privileges >
  5. Get a Privilege

Get a Privilege

Use this API to return a single privilege.

Required Feature

A OneLogin subscription that includes Delegated Administration is required to use the privileges API.

Resource URL

GET https://<subdomain>/api/1/privileges/:id

Header Parameters

Authorization

required

string

Set to Bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

Generate the access token with the API credential pair created using the scope required to call this API. Call this API using the Manage All scope.

Resource Parameter

id

required

string

Set to the id of the privilege you want to retrieve.

Sample Response

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
{
  "id": "2c963197-bee2-4607-abc0-4786f1bfa55a",
  "name": "User Administrator",
  "description": "Can administer users",
  "privilege": {
      "Version": "2018-05-18",
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "users:Delete",
                  "users:ForceLogout",
                  "users:ResetPassword",
                  "users:Unlock",
                  "users:Get"
              ],
              "Scope": [
                  "*"
              ]
          }
      ]
  }
}

This error indicates an invalid access token.

{
    "statusCode": 401,
    "name": "UnauthorizedError",
    "message": "The request requires user authentication."
}
{
    "statusCode": 404,
    "name": "NotFoundError",
    "message": "The resource can't be found or the server has not found anything matching the Request-URI"
}

Sample Code

cURL

curl 'https://<subdomain>/api/1/privileges<privilege_id>' \
-X GET \
-H "Authorization: Bearer <access_token>"

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.