[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Add VIdm User

Description

Add a new VMware Identity manager user to vRealize Network Insight. Only admin users can perform this action. VMware Identity Manager must be configured prior to this action.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/settings/users/vidm
Copy

Request Body

Request Body

VidmUserRequest of type(s) application/json Required

User details

{
	"display_name": "alley martin",
	"domain": "vidmlabs.com",
	"role": "ADMIN",
	"username": "alleyMartin123"
}
string
display_name Optional

Provide user’s display name (could be “givenName familyName”)


string
domain Optional

Provide domain name to which user belongs to.


role Optional

Role assigned the user/group.

Possible values are: MEMBERADMINAUDITOR


string
username Optional

Provide username (domain should not be part of username).

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns UserResponse of type(s) application/json
{
	"display_name": "alley martin",
	"domain": "vidmlabs.com",
	"id": "alleymartin123@vidmlabs.com",
	"role": "ADMIN",
	"user_type": "VIDM",
	"username": "alleyMartin123"
}
string
display_name Optional

User’s display name


string
domain Optional

Domain name to which group belongs to.


string
id Optional

Unique identifier assigned to user.


role Optional

Role assigned the user/group.

Possible values are: MEMBERADMINAUDITOR


user_type Optional

The type of user.

Possible values are: LDAPLOCALVIDM


string
username Optional

Username of the user

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


409

Already Exists


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"display_name":"alley martin","domain":"vidmlabs.com","role":"ADMIN","username":"alleyMartin123"}' https://vrni.example.com/api/ni/settings/users/vidm


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?