NSX-T Data Center REST API

Create/update object permission mappings (Experimental)

This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:

PATCH

URI Path(s):

/policy/api/v1/aaa/object-permissions

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ObjectRolePermissionGroup+

ObjectRolePermissionGroup (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
inheritance_disabled	Does children of this object inherit this rule	boolean	Default: "False"
operation	Allowed operation	string	Enum: crud, read, execute, none
path_prefix	Path prefix	string	Required
resource_type	Must be set to the value ObjectRolePermissionGroup	string
role_name	Role name	string	Required
rule_disabled	Is rule disabled or not	boolean	Default: "False"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PATCH https://<policy-mgr>/policy/api/v1/aaa/object-permissions { "role_name": "cloud_admin", "operation": "crud", "path_prefix": "infra/MGW" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

n/a

Example Response:

200 OK

Required Permissions:

crud

Feature:

policy_rbac

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable