Add Vidm User Group

Add Vidm User Group
Add a VMware Identity Manager user-group to VCF Operations for networks

Add a new VMware Identity Manager user-group to VCF Operations for networks. Only admin users can perform this action. VMware Identity Manager must be configured prior to this action.

Request
URI
POST
https://{api_host}/api/ni/settings/user-groups/vidm
COPY
Request Body

User-group details

VidmUserGroupRequest of type(s) application/json
Required 
{
    "group_name": "superAdmins",
    "domain": "vidmlabs.com",
    "role": "ADMIN"
}
string
group_name
Optional

Specify group name (domain should not be part of group name).

string
domain
Optional

Provide domain name to which user-group belongs to.

string
role
Optional

Role assigned the user/group.

Possible values are : MEMBER, ADMIN, AUDITOR,
Authentication
This operation uses the following authentication methods.
Responses
201

Success

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

The type of user-group.

Possible values are : LDAP, LOCAL, VIDM,
string
id
Optional

Unique identifier assigned to user-group.

string
group_name
Optional

Group-name of the user-group.

string
domain
Optional

Domain name to which user-group belongs to.

string
role
Optional

Role assigned the user/group.

Possible values are : MEMBER, ADMIN, AUDITOR,

400

Bad Request

Returns BadRequestResponse 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 object
details
Optional

details


401

Unauthorized

Returns UnauthorizedResponse 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 object
details
Optional

details


403

Forbidden

Returns ForbiddenResponse 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 object
details
Optional

details


409

Conflict

Returns ConflictResponse 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 object
details
Optional

details


500

Internal error

Returns InternalErrorResponse 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 object
details
Optional

details


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/settings/user-groups/vidm
On This Page
Settings Operations
GET
Get Ip Tag Ids
Deprecated
GET
Get Ip Tag
Deprecated
POST
Add Ip Tag
Deprecated
POST
Remove Ip Tag
Deprecated
GET
Get Tag Ids V2
GET
Get Ip Tag V2
POST
Add Tag V2
POST
Remove Tag V2
GET
Get Subnet Mappings
POST
Create Subnet Mapping
PUT
Update Subnet Mapping
DELETE
Delete Subnet Mapping
GET
Get Certificate
GET
Get Vidm Configuration
PUT
Update Vidm Configuration
POST
Save Vidm Configuration
DELETE
Delete Vidm Configuration
POST
Enable Vidm
POST
Disable Vidm
PUT
Update Vidm User Group Role
POST
Add Vidm User Group
GET
Get User Groups
GET
Get User Group
DELETE
Delete User Group
PUT
Update Vidm User Role
POST
Add Vidm User
GET
Get Users
GET
Get All Users
GET
Get User
DELETE
Delete User
PUT
Update user password
GET
Get Web Proxies
POST
Add Web Proxy
GET
Get Web Proxy
PUT
Update Web Proxy
DELETE
Delete Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Web Proxy Migration
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get SNMP Engine Id
PUT
Update SNMP Engine Id
GET
List the configured SNMP Trap destination profiles
POST
Add new SNMP Trap destination profile
POST
Send Test trap To SNMP destination profile
GET
Get details Of An existing SNMP destination profile
PUT
Update An existing SNMP destination profile
DELETE
Delete An existing SNMP Trap destination profile
POST
Migrate event subscriptions To other SNMP Trap destination profiles
GET
Get All Search Based Alert Configs
POST
Add Search Based Alert Config
POST
Enable Search Based Alert Config
POST
Disable Search Based Alert Config
GET
Get Search Based Alert Config
PUT
Update Search Based Alert Config
DELETE
Delete Search Based Alert Config
GET
Get All User Defined Events
Deprecated
POST
Create User Defined Event
Deprecated
POST
Enable User Defined Event
Deprecated
POST
Disable User Defined Event
Deprecated
GET
Get User Defined Event
Deprecated
PUT
Update User Defined Event
Deprecated
DELETE
Delete User Defined Event
Deprecated
GET
Get Backup Config
PUT
Update Backup Config
POST
Add Backup Config
DELETE
Delete Backup Config
GET
Get Backup Status Report
GET
Get Restore Config
POST
Add Restore Config
DELETE
Delete Restore Config
GET
Get Restore Status Report
GET
Get Licenses
Deprecated
GET
Get Licenses V2
POST
Validate Serial Number
Deprecated
POST
Activate Serial Number
Deprecated
DELETE
Deactivate Serial Number
Deprecated
GET
Get All Subscriber
POST
Create Subscriber
GET
Get Subscriber
PUT
Update Subscriber
DELETE
Delete Subscriber
GET
Get Certificates Details
PUT
Update Certificate
GET
Fetch Certificates Update Status
GET
Fetch Certificate Update Status For Update Id
GET
Get Fips Modules Details
GET
Get Login Banner
PUT
Update Login Banner
POST
Add Login Banner
DELETE
Delete Login Banner
GET
Get Syslog Target List
POST
Add Syslog Target
PUT
Update Syslog Target
DELETE
Delete Syslog Target
POST
Send Syslog Test Message
GET
Get Syslog Mapping
POST
Update Syslog Mapping
GET
Get Syslog Status
PATCH
Update Syslog Status