com.vmware.nsx.aaa

Interface UserInfo

All Superinterfaces:

com.vmware.vapi.bindings.Service, UserInfoTypes

All Known Implementing Classes:

UserInfoStub

public interface UserInfo
extends com.vmware.vapi.bindings.Service, UserInfoTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
UserInfo	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath) This API will return the name and role information of the user invoking this API request.
void	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath, com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback) This API will return the name and role information of the user invoking this API request.
void	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath, com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will return the name and role information of the user invoking this API request.
UserInfo	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will return the name and role information of the user invoking this API request.

Method Detail

get

UserInfo get(java.lang.Boolean provideFlatListing,
             java.lang.String rootPath)

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

Returns:

com.vmware.nsx.model.UserInfo

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

UserInfo get(java.lang.Boolean provideFlatListing,
             java.lang.String rootPath,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UserInfo

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.Boolean provideFlatListing,
         java.lang.String rootPath,
         com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback)

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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

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

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

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

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

get

void get(java.lang.Boolean provideFlatListing,
         java.lang.String rootPath,
         com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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.UserInfo

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

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

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

invocationConfig - Configuration for the method invocation.