com.vmware.nsx.aaa

Interface RoleBindings

All Superinterfaces:

RoleBindingsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RoleBindingsStub

public interface RoleBindings
extends com.vmware.vapi.bindings.Service, RoleBindingsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.aaa.RoleBindingsTypes

_VAPI_SERVICE_ID, DELETE_IDENTITY_SOURCE_TYPE_LDAP, DELETE_IDENTITY_SOURCE_TYPE_OIDC, DELETE_IDENTITY_SOURCE_TYPE_VIDM, DELETE_TYPE_LOCAL_USER, DELETE_TYPE_PRINCIPAL_IDENTITY, DELETE_TYPE_REMOTE_GROUP, DELETE_TYPE_REMOTE_USER, DELETESTALEBINDINGS_IDENTITY_SOURCE_TYPE_LDAP, DELETESTALEBINDINGS_IDENTITY_SOURCE_TYPE_OIDC, DELETESTALEBINDINGS_IDENTITY_SOURCE_TYPE_VIDM, DELETESTALEBINDINGS_TYPE_LOCAL_USER, DELETESTALEBINDINGS_TYPE_PRINCIPAL_IDENTITY, DELETESTALEBINDINGS_TYPE_REMOTE_GROUP, DELETESTALEBINDINGS_TYPE_REMOTE_USER, GET_IDENTITY_SOURCE_TYPE_LDAP, GET_IDENTITY_SOURCE_TYPE_OIDC, GET_IDENTITY_SOURCE_TYPE_VIDM, GET_TYPE_LOCAL_USER, GET_TYPE_PRINCIPAL_IDENTITY, GET_TYPE_REMOTE_GROUP, GET_TYPE_REMOTE_USER, LIST_IDENTITY_SOURCE_TYPE_LDAP, LIST_IDENTITY_SOURCE_TYPE_OIDC, LIST_IDENTITY_SOURCE_TYPE_VIDM, LIST_TYPE_LOCAL_USER, LIST_TYPE_PRINCIPAL_IDENTITY, LIST_TYPE_REMOTE_GROUP, LIST_TYPE_REMOTE_USER

Method Summary

Modifier and Type	Method and Description
RoleBinding	create(RoleBinding roleBinding) This API is used to assign a user/group any role(s) of choice.
void	create(RoleBinding roleBinding, com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback) This API is used to assign a user/group any role(s) of choice.
void	create(RoleBinding roleBinding, com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API is used to assign a user/group any role(s) of choice.
RoleBinding	create(RoleBinding roleBinding, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API is used to assign a user/group any role(s) of choice.
void	delete(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type) Delete the user/group's role assignment.
void	delete(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete the user/group's role assignment.
void	delete(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the user/group's role assignment.
void	delete(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the user/group's role assignment.
void	deletestalebindings(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type) Delete all stale role assignments
void	deletestalebindings(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete all stale role assignments
void	deletestalebindings(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete all stale role assignments
void	deletestalebindings(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete all stale role assignments
RoleBinding	get(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type) Get user/group's role information
void	get(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback) Get user/group's role information
void	get(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get user/group's role information
RoleBinding	get(java.lang.String bindingId, java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get user/group's role information
RoleBindingListResult	list(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type) Get all users and groups with their roles.
void	list(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<RoleBindingListResult> asyncCallback) Get all users and groups with their roles.
void	list(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<RoleBindingListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all users and groups with their roles.
RoleBindingListResult	list(java.lang.String cursor, java.lang.String identitySourceId, java.lang.String identitySourceType, java.lang.String includedFields, java.lang.String name, java.lang.Long pageSize, java.lang.String path, java.lang.String role, java.lang.String rootPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all users and groups with their roles.
RoleBinding	update(java.lang.String bindingId, RoleBinding roleBinding) This API is used to update a user/group any role(s) of choice.
void	update(java.lang.String bindingId, RoleBinding roleBinding, com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback) This API is used to update a user/group any role(s) of choice.
void	update(java.lang.String bindingId, RoleBinding roleBinding, com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API is used to update a user/group any role(s) of choice.
RoleBinding	update(java.lang.String bindingId, RoleBinding roleBinding, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API is used to update a user/group any role(s) of choice.

Method Detail

create

RoleBinding create(RoleBinding roleBinding)

This API is used to assign 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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

roleBinding - (required)

Returns:

com.vmware.nsx.model.RoleBinding

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

RoleBinding create(RoleBinding roleBinding,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API is used to assign 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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

roleBinding - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RoleBinding

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

void create(RoleBinding roleBinding,
            com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback)

This API is used to assign 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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.RoleBinding

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

roleBinding - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(RoleBinding roleBinding,
            com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API is used to assign 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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.RoleBinding

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

roleBinding - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String bindingId,
            java.lang.String cursor,
            java.lang.String identitySourceId,
            java.lang.String identitySourceType,
            java.lang.String includedFields,
            java.lang.String name,
            java.lang.Long pageSize,
            java.lang.String path,
            java.lang.String role,
            java.lang.String rootPath,
            java.lang.Boolean sortAscending,
            java.lang.String sortBy,
            java.lang.String type)

Delete the user/group's role assignment. If the path is provided then deletes only the roles_for_paths that matches the path. If path is provided for the last roles_for_paths then the whole role binding is deleted provided it is not that of a local user.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String bindingId,
            java.lang.String cursor,
            java.lang.String identitySourceId,
            java.lang.String identitySourceType,
            java.lang.String includedFields,
            java.lang.String name,
            java.lang.Long pageSize,
            java.lang.String path,
            java.lang.String role,
            java.lang.String rootPath,
            java.lang.Boolean sortAscending,
            java.lang.String sortBy,
            java.lang.String type,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete the user/group's role assignment. If the path is provided then deletes only the roles_for_paths that matches the path. If path is provided for the last roles_for_paths then the whole role binding is deleted provided it is not that of a local user.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String bindingId,
            java.lang.String cursor,
            java.lang.String identitySourceId,
            java.lang.String identitySourceType,
            java.lang.String includedFields,
            java.lang.String name,
            java.lang.Long pageSize,
            java.lang.String path,
            java.lang.String role,
            java.lang.String rootPath,
            java.lang.Boolean sortAscending,
            java.lang.String sortBy,
            java.lang.String type,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete the user/group's role assignment. If the path is provided then deletes only the roles_for_paths that matches the path. If path is provided for the last roles_for_paths then the whole role binding is deleted provided it is not that of a local user.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String bindingId,
            java.lang.String cursor,
            java.lang.String identitySourceId,
            java.lang.String identitySourceType,
            java.lang.String includedFields,
            java.lang.String name,
            java.lang.Long pageSize,
            java.lang.String path,
            java.lang.String role,
            java.lang.String rootPath,
            java.lang.Boolean sortAscending,
            java.lang.String sortBy,
            java.lang.String type,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete the user/group's role assignment. If the path is provided then deletes only the roles_for_paths that matches the path. If path is provided for the last roles_for_paths then the whole role binding is deleted provided it is not that of a local user.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

deletestalebindings

void deletestalebindings(java.lang.String cursor,
                         java.lang.String identitySourceId,
                         java.lang.String identitySourceType,
                         java.lang.String includedFields,
                         java.lang.String name,
                         java.lang.Long pageSize,
                         java.lang.String path,
                         java.lang.String role,
                         java.lang.String rootPath,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         java.lang.String type)

Delete all stale role assignments

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

deletestalebindings

void deletestalebindings(java.lang.String cursor,
                         java.lang.String identitySourceId,
                         java.lang.String identitySourceType,
                         java.lang.String includedFields,
                         java.lang.String name,
                         java.lang.Long pageSize,
                         java.lang.String path,
                         java.lang.String role,
                         java.lang.String rootPath,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         java.lang.String type,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete all stale role assignments

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

deletestalebindings

void deletestalebindings(java.lang.String cursor,
                         java.lang.String identitySourceId,
                         java.lang.String identitySourceType,
                         java.lang.String includedFields,
                         java.lang.String name,
                         java.lang.Long pageSize,
                         java.lang.String path,
                         java.lang.String role,
                         java.lang.String rootPath,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         java.lang.String type,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete all stale role assignments

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

deletestalebindings

void deletestalebindings(java.lang.String cursor,
                         java.lang.String identitySourceId,
                         java.lang.String identitySourceType,
                         java.lang.String includedFields,
                         java.lang.String name,
                         java.lang.Long pageSize,
                         java.lang.String path,
                         java.lang.String role,
                         java.lang.String rootPath,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         java.lang.String type,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete all stale role assignments

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

RoleBinding get(java.lang.String bindingId,
                java.lang.String cursor,
                java.lang.String identitySourceId,
                java.lang.String identitySourceType,
                java.lang.String includedFields,
                java.lang.String name,
                java.lang.Long pageSize,
                java.lang.String path,
                java.lang.String role,
                java.lang.String rootPath,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String type)

Get user/group's role information

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

Returns:

com.vmware.nsx.model.RoleBinding

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

RoleBinding get(java.lang.String bindingId,
                java.lang.String cursor,
                java.lang.String identitySourceId,
                java.lang.String identitySourceType,
                java.lang.String includedFields,
                java.lang.String name,
                java.lang.Long pageSize,
                java.lang.String path,
                java.lang.String role,
                java.lang.String rootPath,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String type,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get user/group's role information

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RoleBinding

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String bindingId,
         java.lang.String cursor,
         java.lang.String identitySourceId,
         java.lang.String identitySourceType,
         java.lang.String includedFields,
         java.lang.String name,
         java.lang.Long pageSize,
         java.lang.String path,
         java.lang.String role,
         java.lang.String rootPath,
         java.lang.Boolean sortAscending,
         java.lang.String sortBy,
         java.lang.String type,
         com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback)

Get user/group's role information

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.RoleBinding

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String bindingId,
         java.lang.String cursor,
         java.lang.String identitySourceId,
         java.lang.String identitySourceType,
         java.lang.String includedFields,
         java.lang.String name,
         java.lang.Long pageSize,
         java.lang.String path,
         java.lang.String role,
         java.lang.String rootPath,
         java.lang.Boolean sortAscending,
         java.lang.String sortBy,
         java.lang.String type,
         com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get user/group's role information

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.RoleBinding

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

bindingId - User/Group's id (required)

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

RoleBindingListResult list(java.lang.String cursor,
                           java.lang.String identitySourceId,
                           java.lang.String identitySourceType,
                           java.lang.String includedFields,
                           java.lang.String name,
                           java.lang.Long pageSize,
                           java.lang.String path,
                           java.lang.String role,
                           java.lang.String rootPath,
                           java.lang.Boolean sortAscending,
                           java.lang.String sortBy,
                           java.lang.String type)

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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

Returns:

com.vmware.nsx.model.RoleBindingListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

RoleBindingListResult list(java.lang.String cursor,
                           java.lang.String identitySourceId,
                           java.lang.String identitySourceType,
                           java.lang.String includedFields,
                           java.lang.String name,
                           java.lang.Long pageSize,
                           java.lang.String path,
                           java.lang.String role,
                           java.lang.String rootPath,
                           java.lang.Boolean sortAscending,
                           java.lang.String sortBy,
                           java.lang.String type,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RoleBindingListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String cursor,
          java.lang.String identitySourceId,
          java.lang.String identitySourceType,
          java.lang.String includedFields,
          java.lang.String name,
          java.lang.Long pageSize,
          java.lang.String path,
          java.lang.String role,
          java.lang.String rootPath,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String type,
          com.vmware.vapi.bindings.client.AsyncCallback<RoleBindingListResult> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.RoleBindingListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String cursor,
          java.lang.String identitySourceId,
          java.lang.String identitySourceType,
          java.lang.String includedFields,
          java.lang.String name,
          java.lang.Long pageSize,
          java.lang.String path,
          java.lang.String role,
          java.lang.String rootPath,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String type,
          com.vmware.vapi.bindings.client.AsyncCallback<RoleBindingListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.RoleBindingListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

identitySourceId - Identity source ID (optional)

identitySourceType - Identity source type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

name - User/Group name (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

path - Exact path of the context (optional)

role - Role ID (optional)

rootPath - Prefix path of the context (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

RoleBinding update(java.lang.String bindingId,
                   RoleBinding roleBinding)

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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

bindingId - User/Group's id (required)

roleBinding - (required)

Returns:

com.vmware.nsx.model.RoleBinding

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

RoleBinding update(java.lang.String bindingId,
                   RoleBinding roleBinding,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

bindingId - User/Group's id (required)

roleBinding - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RoleBinding

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

void update(java.lang.String bindingId,
            RoleBinding roleBinding,
            com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.RoleBinding

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

bindingId - User/Group's id (required)

roleBinding - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(java.lang.String bindingId,
            RoleBinding roleBinding,
            com.vmware.vapi.bindings.client.AsyncCallback<RoleBinding> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.RoleBinding

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

bindingId - User/Group's id (required)

roleBinding - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.