Get User Groups Using GET

Get User Groups Using GET

If none of the parameters are specified, all the user groups in the system are returned.

Request
URI
GET
https://{api_host}/api/auth/usergroups
COPY
Query Parameters
string of array
id
Optional

The identifiers of the local user groups

string of array
name
Optional

The names of the local user groups

Authentication
This operation uses the following authentication methods.
Responses
200

List of local user group objects. Groups are returned using both exact and substring matches

Returns user-groups of type(s) application/json 
{
    "userGroups": [
        {
            "authSourceId": "string",
            "description": "string",
            "displayName": "string",
            "id": "string",
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "name": "string",
            "role-permissions": [
                {
                    "allowAllObjects": false,
                    "links": [
                        {
                            "description": "string",
                            "href": "string",
                            "name": "string",
                            "rel": "string"
                        }
                    ],
                    "roleName": "string",
                    "scopeId": "string",
                    "traversal-spec-instances": [
                        {
                            "adapterKind": "string",
                            "includedAdapterKinds": [
                                "string"
                            ],
                            "name": "string",
                            "resourceKind": "string",
                            "resourceSelection": [
                                {
                                    "resourceId": [
                                        "string"
                                    ],
                                    "type": "string"
                                }
                            ],
                            "selectAllResources": false
                        }
                    ]
                }
            ],
            "roleNames": [
                "string"
            ],
            "userIds": [
                "string"
            ]
        }
    ]
}
array of user-group
userGroups
Optional

Collection of UserGroups


On This Page
Auth Operations
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
POST
Create Scope Using POST
POST
Create User Group Using POST
POST
Create User Role Using POST
DELETE
Delete Scopes Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
GET
Get All Object Scopes Using GET
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Scope Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
PUT
Modify Scope Using PUT
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
DELETE
Remove Role Privileges Using DELETE
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update User Role Using PUT