User Groups REST Interface

For a description of user data, see Users REST Interface.

User group data essentially reflect the structure as it can be seen in the group management user interface (see Group Management). For example, the rights for an application administration group look like follows:

Permissions is a list of the rights that are assigned to the group. A right consists of:

In all entries there can also be an asterisk, which matches all rights. So, a stingrayafzeusafm Administrator, who has all rights, has:

The following request retrieves a list of all user groups. In this case, there are the two standard groups “master_admin” and “pci_auditor”, plus the Application Administrator group for one application. The group name for this Application Administrator group consists of the prefix “app_group_” plus the internal UUID of the application.

$ curl -u admin:admin -H 'Content-Type: application/json' http://127.0.0.1:8087/api/af/2.0/auth/groups {    "__name": "groups",    "__path": "/api/af/2.0/auth/groups/",    "__subnodes": [        "master_admin",        "pci_auditor",        "app_group_f011694d47d73578-e440fd26a125de02c57dc7efa1f1bc17"    ],    "groups": [        "master_admin",        "app_group_f011694d47d73578-e440fd26a125de02c57dc7efa1f1bc17",        "pci_auditor"    ] }

The following request retrieves the data of the user group "master_admin", which is named "hyperguard Admin" in the user interface.

(In the example, the response is truncated.)

$ curl -u admin:admin -H 'Content-Type: application/json' http://127.0.0.1:8087/api/af/2.0/auth/groups/master_admin { "__name": "master_admin", "__path": "/api/af/2.0/auth/groups/master_admin/", "__subnodes": [], "internal": true, "name": "hyperguard Admin", "permissions": [ { "access": "*", "category": "*", "element": "*", "element_name": "*", "name": "*" } ] }