See api-docs Menu

List Privileges

Use this API to list the Privileges created in an account.

Limited Availability

This API is only available as a very limited preview and is currently closed.

Resource URL

GET https://<api-domain>/api/1/privileges

Header Parameters

Authorization

required

string

Set to Bearer <access_token>.

Set <access_token> to the access token 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.

Sample Response

[
    {
        "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."
}

Sample Code

cURL

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

Postman Collection

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

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?

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.