Update User By Id V2 Using PATCH

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

Request

URI

PATCH

https://{api_host}/lcm/authzn/api/v2/users/{vmid}

COPY

Path Parameters

string

vmid

Required

vmid

Request Body

UserRequestDTO of type(s) application/json

Optional

{
    "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": [
            "[email protected]"
        ],
        "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

isDisabled

array of string

mappedRoles

Optional

mappedRoles

string

password

Optional

Password

string

providerIdentifier

Optional

Provider ID

UserMetadataDTO

userMetadata

Optional

userMetadata

string

userPrincipalName

Optional

User Principal Name

string

userType

Optional

User type

string

username

Optional

Username

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

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": [
            "[email protected]"
        ],
        "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

isDisabled

string

password

Optional

password

string

providerIdentifier

Optional

Provider ID

array of RoleDTO

roleMappings

Optional

roleMappings

UserMetadataDTO

userMetadata

Optional

userMetadata

string

userPrincipalName

Optional

User Principal Name

string

userType

Optional

User Type

string

username

Optional

Username

string

vmid

Optional

User ID

204

No Content

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message

array of string

recommendations

Optional

recommendations

500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message