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 group

GET
http://localhost:3000/authorization/groups/:groupId
GET
/authorization/groups/:groupId
$curl http://localhost:3000/authorization/groups/groupId \
>     -u "<username>:<password>"
1{
2  "provenance": "Local AAA",
3  "name": "group_1",
4  "description": "description of group_1",
5  "memberOf": [
6    {
7      "aaaManaged": true,
8      "groupId": "5cb7b531d06cceb89fd21b1c"
9    }
10  ],
11  "assignedRoles": [
12    {
13      "roleId": "5cb7b531d06cceb89fd21b1c"
14    }
15  ],
16  "inactive": true,
17  "_meta": {
18    "created": "2018-08-02T15:56:12.912Z",
19    "updated": "2018-08-02T15:56:12.912Z"
20  }
21}
Returns an individual group.
Was this page helpful?
Previous

Get an individual role

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

groupIdstringRequiredformat: "^[0-9a-f]{24}$"
The id for the requested group.

Response

The individual group document.
provenancestring
AAA provider where group originated
namestring
Name of group
descriptionstring
Description of group
memberOflist of objects
Parent groups which this group is a part of
assignedRoleslist of objects
Roles assigned to this group
inactiveboolean
Setting for whether group is active or not
_metaobject
Metadata for group

Errors

500
Internal Server Error