Package org.wso2.am.integration.clients.publisher.api.v1

Class RolesApi

  • public class RolesApi
extends Object

    • Constructor Detail

      • RolesApi

        public RolesApi()

      • RolesApi

        public RolesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • validateSystemRoleCall

        public okhttp3.Call validateSystemRoleCall​(String roleId,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for validateSystemRole
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • validateSystemRole

        public void validateSystemRole​(String roleId)
                        throws ApiException
        Check Whether Given Role Name already Exist Using this operation, user can check a given role name exists or not.
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateSystemRoleWithHttpInfo

        public ApiResponse<Void> validateSystemRoleWithHttpInfo​(String roleId)
                                                 throws ApiException
        Check Whether Given Role Name already Exist Using this operation, user can check a given role name exists or not.
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateSystemRoleAsync

        public okhttp3.Call validateSystemRoleAsync​(String roleId,
                                            ApiCallback<Void> _callback)
                                     throws ApiException
        Check Whether Given Role Name already Exist (asynchronously) Using this operation, user can check a given role name exists or not.
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • validateUserRoleCall

        public okhttp3.Call validateUserRoleCall​(String roleId,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for validateUserRole
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • validateUserRole

        public void validateUserRole​(String roleId)
                      throws ApiException
        Validate Whether the Logged-in User has the Given Role Using this operation, logged-in user can check whether he has given role.
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateUserRoleWithHttpInfo

        public ApiResponse<Void> validateUserRoleWithHttpInfo​(String roleId)
                                               throws ApiException
        Validate Whether the Logged-in User has the Given Role Using this operation, logged-in user can check whether he has given role.
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateUserRoleAsync

        public okhttp3.Call validateUserRoleAsync​(String roleId,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Validate Whether the Logged-in User has the Given Role (asynchronously) Using this operation, logged-in user can check whether he has given role.
        Parameters:
        roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object