NSX-T Data Center REST API

Get all users and groups with their roles

Get all users and groups with their roles. If the root_path is
provided then only return role bindings that start-with or are
sub-trees of the provided root path. Also filter the roles_for_paths
such that only those roles_for_paths appear that start-with or are
sub-tree of the provided root path.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/aaa/role-bindings
/api/v1/aaa/role-bindings

Request Headers:

n/a

Query Parameters:

RoleBindingRequestParameters+

RoleBindingRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
identity_source_id	Identity source ID If provided, only return role bindings for the given identity source. Currently only supported for LDAP and OIDC identity source types.	string
identity_source_type	Identity source type	string	Enum: VIDM, LDAP, OIDC
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
name	User/Group name	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
path	Exact path of the context	string
role	Role ID	string
root_path	Prefix path of the context	string
sort_ascending	If true, results are sorted in ascending order	boolean
sort_by	Field by which records are sorted	string
type	Type	string	Enum: remote_user, remote_group, local_user, principal_identity

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/aaa/role-bindings?page_size=2

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

RoleBindingListResult+

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of RoleBinding	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ }

Required Permissions:

read

Feature:

users_role_assignments