For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTCreate a group
        • POSTCreate a role
        • DELDelete a group
        • DELDelete a role
        • GETExtract CSV data of accounts, groups, and roles
        • POSTForce a user to log out
        • GETGet a list of groups
        • GETGet a list of methods
        • GETGet a list of roles
        • GETGet a list of views
        • GETGet a simplified list of groups
        • GETGet an individual account
        • GETGet an individual group
        • GETGet an individual role
        • GETList all accounts
        • PATCHUpdate a group
        • PATCHUpdate a role
        • PATCHUpdate an account
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAuthorization

Get a list of roles

GET
http://localhost:3000/authorization/roles
GET
/authorization/roles
$curl http://localhost:3000/authorization/roles \
>     -u "<username>:<password>"
1{
2  "results": {
3    "provenance": "Custom",
4    "name": "role_1",
5    "description": "description of role_1",
6    "allowedMethods": [
7      {
8        "name": "methodName",
9        "provenance": "ApplicationName"
10      }
11    ],
12    "allowedViews": [
13      {
14        "path": "/manual/task/path",
15        "provenance": "ApplicationName"
16      }
17    ],
18    "_meta": {
19      "created": "2018-08-02T15:56:12.912Z",
20      "updated": "2018-08-02T15:56:12.912Z"
21    }
22  },
23  "total": 1
24}
Returns a list of roles.
Was this page helpful?
Previous

Get a list of views

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

multiContainsobjectOptional
multiContains
multiEqualsobjectOptional
multiEquals
multiStartsWithobjectOptional
multiStartsWith
inactivebooleanOptional
inactive
skipintegerOptional>=0Defaults to 0
skip
limitintegerOptional>=0Defaults to 25
limit
sortenumOptionalDefaults to name
sort
Allowed values:
orderenumOptionalDefaults to 1
order
Allowed values:

Response

The roles matching the specified query.
resultsobject
This is the schema for an IAP role stored in Mongo
totalinteger>=0
The total number of documents

Errors

500
Internal Server Error