See api-docs Menu

Get a Privilege

Use this API to return a single privilege.

Preview Release

This API is part of the OneLogin Delegated Administration Service and only available as a preview release. If you’re interested in using this API please contact your account manager or our support team.

Resource URL

GET https://api.<us_or_eu>.onelogin.com/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

[
    {
        "id": "2c963197-bee2-4607-abc0-4786f1bfa55a",
        "name": "User Administrator",
        "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://api.<us_or_eu>>.onelogin.com/api/1/privileges<privilege_id>' \
-X GET \
-H "Authorization: bearer:<access_token>"

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Privileges API


Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

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