Update Vidm User Role

Update role for user mapped through VMware Identity Manager. Only admin users can perform this action.

Request

URI

PUT

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

COPY

Path Parameters

string

Required

entity id

Request Body

VidmUserRequest of type(s) application/json

Optional

{
    "username": "alleymartin123",
    "domain": "vidmlabs.com",
    "display_name": "alley martin",
    "role": "ADMIN"
}

string

username

Optional

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

string

domain

Optional

Provide domain name to which user belongs to.

string

display_name

Optional

Provide user's display name (could be "givenName familyName")

Role

role

Optional

role

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns UserResponse of type(s) application/json

{
    "id": "[email protected]",
    "user_type": "VIDM",
    "username": "alleymartin123",
    "domain": "vidmlabs.com",
    "display_name": "alley martin",
    "role": "ADMIN"
}

UserType

user_type

Optional

user_type

string

Optional

Unique identifier assigned to user.

Role

role

Optional

role

string

username

Optional

Username of the user

string

domain

Optional

Domain name to which group belongs to.

string

display_name

Optional

User's display name

400

Bad Request

Returns ApiError 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 ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError 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 ErrorDetail

details

Optional

details

403

Forbidden

Returns ApiError 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 ErrorDetail

details

Optional

details

404

Not Found

Returns ApiError 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 ErrorDetail

details

Optional

details

409

Already Exists

Returns ApiError 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 ErrorDetail

details

Optional

details