[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Create User V2

Description

This API is used to add a user and assign roles to it. You can fetch different roles by triggering get all external roles.

Request

Request

URL

URL


post
https://localhost:8080/lcm/authzn/api/v2/users
Copy

Request Body

Request Body

UserRequestDTO of type(s) application/json Required

userRequestDTO

{
	"displayName": "configadmin configadmin",
	"domain": "System Domain",
	"isDisabled": false,
	"mappedRoles": [
		"string"
	],
	"password": "locker:password:<vmid>:<alias>",
	"providerIdentifier": "6304f1ed-17e0-4128-b86f-e29c6563e32f",
	"userMetadata": {
		"additionalMeta": [
			"string"
		],
		"distinguishedName": "string",
		"emails": [
			"admin@vmware.com"
		],
		"externalId": "764195c6-5504-4f56-8c34-b372d47f5176",
		"familyName": "user1",
		"givenName": "LCM"
	},
	"userPrincipalName": "configadmin_upn",
	"userType": "VIDM_LOCAL_USER",
	"username": "configadmin"
}
string
displayName Optional

Display name


string
domain Optional

Domain


boolean
isDisabled Optional

array of string
mappedRoles Optional

string
password Optional

Password


string
providerIdentifier Optional

Provider ID


userMetadata Optional

User Metadata


string
userPrincipalName Optional

User Principal Name


string
userType Optional

User type


string
username Optional

Username

Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

201 Created returns object of type(s) application/json
Errors

Errors

401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"displayName":"configadmin configadmin","domain":"System Domain","isDisabled":false,"mappedRoles":["string"],"password":"locker:password:<vmid>:<alias>","providerIdentifier":"6304f1ed-17e0-4128-b86f-e29c6563e32f","userMetadata":{"additionalMeta":["string"],"distinguishedName":"string","emails":["admin@vmware.com"],"externalId":"764195c6-5504-4f56-8c34-b372d47f5176","familyName":"user1","givenName":"LCM"},"userPrincipalName":"configadmin_upn","userType":"VIDM_LOCAL_USER","username":"configadmin"}' https://localhost:8080/lcm/authzn/api/v2/users


Feedback

Was this page helpful?