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

Update User By ID V2

Description

This API is used to update user role(s) by ID.

Request

Request

URL

URL


patch
https://localhost:8080/lcm/authzn/api/v2/users/{vmid}
Copy

Path Parameters

Path Parameters

string
vmid Required

vmid


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

200 OK returns UserDTO of type(s) application/json
{
	"displayName": "lcm user1",
	"domain": "example.com",
	"isDisabled": false,
	"password": "string",
	"providerIdentifier": "3d6701ea-0c5b-43e7-871c-468947e86616",
	"roleMappings": [
		{
			"roleDescription": "vRealize Lifecycle Manager Administrator",
			"roleName": "admin",
			"vmid": "782c2945-3b69-4e29-8b32-b3d0d37ff562"
		}
	],
	"userMetadata": {
		"additionalMeta": [
			"string"
		],
		"distinguishedName": "string",
		"emails": [
			"admin@vmware.com"
		],
		"externalId": "764195c6-5504-4f56-8c34-b372d47f5176",
		"familyName": "user1",
		"givenName": "LCM"
	},
	"userPrincipalName": "string",
	"userType": "VIDM_AD_USER",
	"username": "lcmuser1",
	"vmid": "3eef09c1-ae69-4f20-ba97-07f607227b13"
}
string
displayName Optional

Display Name


string
domain Optional

Domain


boolean
isDisabled Optional

string
password Optional

string
providerIdentifier Optional

Provider ID


array of RoleDTO
roleMappings Optional

userMetadata Optional

string
userPrincipalName Optional

User Principal Name


string
userType Optional

User Type


string
username Optional

Username


string
vmid Optional

User ID

Errors

Errors

401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X PATCH -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/{vmid}


Feedback

Was this page helpful?