Update Role Definition

Update VCF Role

Updates an existing custom VCF role definition with new component roles and permissions. This operation allows modification of role assignments, descriptions, and component role mappings. Built-in roles cannot be updated, only custom roles are supported for updates.

Request

URI

PUT

https://{api_host}/suite-api/api/fleet-management/iam/roles

COPY

Request Body

Updated VCF role object containing modified role display name, description, and component roles

VcfRole of type(s) application/json

Required

Show optional properties

{
    "componentRoles": [
        {
            "componentType": "string",
            "roles": [
                {}
            ]
        }
    ],
    "roleName": "string"
}

"{\n  \"roleName\" : \"custom-administrator\",\n  \"roleDisplayName\" : \"multi-component-administrator\",\n  \"roleDescription\" : \"Updated Multi-Component Administrator Role with permissions across multiple VCF components\",\n  \"componentRoles\" : [ {\n    \"componentType\" : \"VCENTER\",\n    \"roles\" : [ \"Admin\" ]\n  }, {\n    \"componentType\" : \"NSX_MANAGER\",\n    \"roles\" : [ \"network_engineer\" ]\n  }, {\n    \"componentType\" : \"VCF_AUTOMATION\",\n    \"roles\" : [ \"System Administrator\" ]\n  }, {\n    \"componentType\" : \"VCF_ORCHESTRATOR\",\n    \"roles\" : [ \"Orchestrator Administrator\" ]\n  }, {\n    \"componentType\" : \"HCX\",\n    \"roles\" : [ \"System Administrator\" ]\n  } ]\n}"

array of object

componentRoles

Required

Constraints: minItems: 1

List of VCF Component Roles

integer As int64 As int64

createdAt

Optional

Role creation timestamp

string

createdBy

Optional

VCF Role Created By

string

roleDescription

Optional

VCF Role Description

string

roleDisplayName

Optional

VCF Display Role Name

string

roleName

Required

Constraints: minLength: 1

VCF Role Name

string

type

Optional

VCF Role type

Possible values are : BUILT_IN, CUSTOM, UNKNOWN,

integer As int64 As int64

updatedAt

Optional

Role last updated timestamp

string

updatedBy

Optional

VCF Role Updated By

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

VCF role updated successfully

Returns VcfRole of type(s) application/json

{
    "componentRoles": [
        {
            "componentType": "string",
            "roles": [
                "string"
            ]
        }
    ],
    "createdAt": 0,
    "createdBy": "string",
    "roleDescription": "string",
    "roleDisplayName": "string",
    "roleName": "string",
    "type": "string",
    "updatedAt": 0,
    "updatedBy": "string"
}

array of object

componentRoles

Required

Constraints: minItems: 1

List of VCF Component Roles

integer As int64 As int64

createdAt

Optional

Role creation timestamp

string

createdBy

Optional

VCF Role Created By

string

roleDescription

Optional

VCF Role Description

string

roleDisplayName

Optional

VCF Display Role Name

string

roleName

Required

Constraints: minLength: 1

VCF Role Name

string

type

Optional

VCF Role type

Possible values are : BUILT_IN, CUSTOM, UNKNOWN,

integer As int64 As int64

updatedAt

Optional

Role last updated timestamp

string

updatedBy

Optional

VCF Role Updated By

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"componentRoles":["object"],"roleName":"string"}' https://{api_host}/suite-api/api/fleet-management/iam/roles

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Iam Apis Operations