Edit User Permissions

This can be used to edit permissions assigned to any user on a folder of an Entitlement Account. Permissions can only be edited if isEditableByLoggedInUser is true while getting the permissions for the same user.

Request

URI

POST

https://apigw.vmware.com/v1/m4/api/myvmware/entitlements/accounts/{entAccount}/users/permissions

COPY

Path Parameters

string

entAccount

Required

Entitlement Account to use for this request

entAccount example

12345678

Header Parameters

string

Authorization

Required

Bearer Access Token Generated using API Key

Authorization example

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request Body

Request details for editing user permissions

Array of EditPermissionsRequest of type(s) application/json

Optional

[
    {
        "folderId": 11111111,
        "users": [
            "[email protected]",
            "[email protected]"
        ],
        "newPermissions": {
            "manageRoles": true,
            "viewSupportRequests": false,
            "viewOrdersAndSupportContracts": false,
            "viewLicenseAndUserPerms": true,
            "manageFoldersAndUserPerms": true,
            "divideCombineLicenseKeys": true,
            "upgradeDowngradeLicenseKeys": true,
            "fileSupportRequests": false,
            "downloadProducts": true
        }
    }
]

Authentication

This operation uses the following authentication methods.

bearerAuthentication

Responses

200

Edit user permission request submitted or executed successfully.

Returns GenericResponse of type(s) application/json

{
    "status": "success",
    "requestId": "1uy14hzktpz7n7a9h",
    "requestStatusUrl": "https://apigw.vmware.com/v1/m4/api/myvmware/external/requests/1uy14hzktpz7n7a9h/status"
}

string

status

Optional

Status of the request. Example values are - Success, Request submitted successfully etc.

string

requestId

Optional

Unique ID assigned to this request.

string

requestStatusUrl

Optional

Unique URL generated for this request to check the status.

400

Either request is not valid or input validation has failed.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.

string

requestId

Optional

Unique Request Id assigned to this request.

array of ErrorDesription

errorDetails

Optional

Complete error details.

401

Access Token is not valid or expired.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.

string

requestId

Optional

Unique Request Id assigned to this request.

array of ErrorDesription

errorDetails

Optional

Complete error details.

500

Server error while getting the details.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.