Get All Role Bindings

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

URI

GET

https://nsxmanager.your.domain/api/v1/aaa/role-bindings

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

identity_source_id

Optional

Identity source ID

string

identity_source_type

Optional

Identity source type

Possible values are : VIDM, LDAP, OIDC,

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

name

Optional

User/Group name

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

string

path

Optional

Exact path of the context

string

role

Optional

Role ID

string

root_path

Optional

Prefix path of the context

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

type

Optional

Type

Possible values are : remote_user, remote_group, local_user, principal_identity,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns RoleBindingListResult of type(s) application/json

This response body class contains all of the following: InlineRoleBindingListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "identity_source_id": "string",
            "identity_source_type": "string",
            "name": "string",
            "read_roles_for_paths": false,
            "roles": [
                {
                    "role": "string",
                    "role_display_name": "string"
                }
            ],
            "roles_for_paths": [
                {
                    "delete_path": false,
                    "path": "string",
                    "roles": [
                        {
                            "role": "string",
                            "role_display_name": "string"
                        }
                    ]
                }
            ],
            "stale": "string",
            "type": "string",
            "user_id": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json