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 an individual role

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

List all accounts

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

roleIdstringRequired
The id for the requested role.

Response

The individual role document.
provenancestring
namestring
descriptionstring
allowedMethodslist of objects
allowedViewslist of objects
_metaobject

Errors

500
Internal Server Error