NSX-T Data Center REST API

Update User or Group's roles

This API is used to update a user/group any role(s) of choice. It is
recommended to use the new property roles_for_paths instead of
roles. When using the roles_for_paths, set the read_roles_for_paths
as true. User has union of all the roles assigned to it on a particular
path and its sub-tree. User name is dealt case-insensitively.
This API will merge the existing roles_for_paths with the newly provided
roles_for_paths excluding roles_for_paths those are marked for deletion.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/aaa/role-bindings/{binding-id}
/api/v1/aaa/role-bindings/{binding-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

RoleBinding+

RoleBinding (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
identity_source_id	ID of the external identity source The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.	string
identity_source_type	Identity source type	string	Enum: VIDM, LDAP, OIDC, CSP Default: "VIDM"
name	User/Group's name	string	Required Readonly
read_roles_for_paths	Read from roles_for_paths instead of roles Set this property to true to cause the user's role definition to be read from the roles_for_paths property. Set it to false to cause the user's role definition to be read from the roles property.	boolean
resource_type	Must be set to the value RoleBinding	string
roles	Roles	array of Role	Deprecated Readonly
roles_for_paths	Roles for Paths The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere i.e. it is same as the deprecated property roles.	array of RolesForPath
stale	Stale in vIDM Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings	string	Readonly Enum: TRUE, FALSE, UNKNOWN
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Type Indicates the type of the user. remote_user - This is a user which is external to NSX. remote_group - This is a group of users which is external to NSX. local_user - This is a user local to NSX. These are linux users. principal_identity - This is a principal identity user. remote - The the principal is remote but whether it is a user or group is not known. Currently this is applicable only to LDAP identity_source_type.	string	Required Readonly Enum: remote_user, remote_group, local_user, principal_identity, remote
user_id	Local user's numeric id Local user's numeric id on the system.	string	Readonly

Example Request:

1. { "name": "[email protected]", "type": "remote_user", "roles":[ { "role": "security_engineer" } ] } 2. { "name": "[email protected]", "type": "remote_user", "read_roles_for_paths": true, "roles_for_paths": [ { "path": "/orgs/default", "roles": [ { "role": "network_engineer" } ] } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

RoleBinding+

RoleBinding (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
identity_source_id	ID of the external identity source The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.	string
identity_source_type	Identity source type	string	Enum: VIDM, LDAP, OIDC, CSP Default: "VIDM"
name	User/Group's name	string	Required Readonly
read_roles_for_paths	Read from roles_for_paths instead of roles Set this property to true to cause the user's role definition to be read from the roles_for_paths property. Set it to false to cause the user's role definition to be read from the roles property.	boolean
resource_type	Must be set to the value RoleBinding	string
roles	Roles	array of Role	Deprecated Readonly
roles_for_paths	Roles for Paths The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere i.e. it is same as the deprecated property roles.	array of RolesForPath
stale	Stale in vIDM Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings	string	Readonly Enum: TRUE, FALSE, UNKNOWN
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Type Indicates the type of the user. remote_user - This is a user which is external to NSX. remote_group - This is a group of users which is external to NSX. local_user - This is a user local to NSX. These are linux users. principal_identity - This is a principal identity user. remote - The the principal is remote but whether it is a user or group is not known. Currently this is applicable only to LDAP identity_source_type.	string	Required Readonly Enum: remote_user, remote_group, local_user, principal_identity, remote
user_id	Local user's numeric id Local user's numeric id on the system.	string	Readonly

Example Response:

{ "resource_type": "RoleBinding", "description": "", "id": "7e672b0e-f0bd-48bc-b579-9e6f1b2b3969", "display_name": "[email protected]", "roles": [ { "role": "security_engineer" } ], "name": "[email protected]", "type": "remote_user", "_create_user": "admin", "_create_time": 1493960803006, "_last_modified_user": "admin", "_last_modified_time": 1493960803006, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } 2. { "resource_type": "RoleBinding", "description": "", "id": "7e672b0e-f0bd-48bc-b579-9e6f1b2b3969", "display_name": "[email protected]", "roles_for_paths": [ { "path": "/orgs/default", "roles": [ { "role": "network_engineer" } ] } ], "name": "[email protected]", "type": "remote_user", "_create_user": "admin", "_create_time": 1493960803006, "_last_modified_user": "admin", "_last_modified_time": 1493960803006, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 }

Required Permissions:

crud

Feature:

users_role_assignments

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