Get User Groups

Get User Groups

Retrieve the list of existing user-groups. Only admin users can retrieve this information. This action is currently restricted to user-groups mapped through VMware Identity Manager.

Request
URI
GET
https://vrni.example.com/api/ni/settings/user-groups
COPY
Query Parameters
number
size
Optional

page size of results

string
cursor
Optional

cursor from previous response

string
type
Required

type of user-group

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns PagedUserGroupListResponse of type(s) application/json 
{
    "results": [
        {
            "id": "[email protected]",
            "group_type": "VIDM",
            "group_name": "testgroup",
            "domain": "vidmlabs.com",
            "role": "ADMIN"
        }
    ],
    "cursor": "string",
    "total_count": 0
}
array of UserGroupResponse
results
Optional

results

string
cursor
Optional

cursor

integer
total_count
Optional

total_count


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


403

Forbidden

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Operation doesn't return any data structure

On This Page
Settings Operations
POST
Add new SNMP destination profile
POST
Add new User defined event
POST
Add Ip Tag
POST
Add Vidm User
POST
Add Vidm User Group
POST
Create Subnet Mapping
DELETE
Delete An existing SNMP destination profile
DELETE
Delete Subnet Mapping
DELETE
Delete User
DELETE
Delete User Defined Event
DELETE
Delete User Group
DELETE
Delete Vidm Configuration
POST
Disable User Defined Event
POST
Disable Vidm
POST
Enable User Defined Event
POST
Enable Vidm
GET
Get details Of An existing SNMP destination profile
GET
Get All User Defined Events
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Subnet Mappings
GET
Get User
GET
Get User Defined Event
GET
Get User Group
GET
Get User Groups
GET
Get Users
GET
Get Vidm Configuration
GET
List the configured SNMP destination profiles
POST
Migrate event subscriptions To other SNMP destination profiles
POST
Remove Ip Tag
POST
Save Vidm Configuration
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
PUT
Update Subnet Mapping
PUT
Update User Defined Event
PUT
Update Vidm Configuration
PUT
Update Vidm User Group Role
PUT
Update Vidm User Role