org.wso2.am.integration.clients.admin.api

Class SystemScopesApi

java.lang.Object

org.wso2.am.integration.clients.admin.api.SystemScopesApi

public class SystemScopesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SystemScopesApi()
SystemScopesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
ScopeListDTO	systemScopesGet() Get Role Scope Mappings This operation is used to get the list of role scope mapping from tenant-conf for the apim admin dashboard
okhttp3.Call	systemScopesGetAsync(ApiCallback<ScopeListDTO> _callback) Get Role Scope Mappings (asynchronously) This operation is used to get the list of role scope mapping from tenant-conf for the apim admin dashboard
okhttp3.Call	systemScopesGetCall(ApiCallback _callback) Build call for systemScopesGet
ApiResponse<ScopeListDTO>	systemScopesGetWithHttpInfo() Get Role Scope Mappings This operation is used to get the list of role scope mapping from tenant-conf for the apim admin dashboard
RoleAliasListDTO	systemScopesRoleAliasesGet() Retrieve Role Alias Mappings This operation can be used to retreive role alias mapping
okhttp3.Call	systemScopesRoleAliasesGetAsync(ApiCallback<RoleAliasListDTO> _callback) Retrieve Role Alias Mappings (asynchronously) This operation can be used to retreive role alias mapping
okhttp3.Call	systemScopesRoleAliasesGetCall(ApiCallback _callback) Build call for systemScopesRoleAliasesGet
ApiResponse<RoleAliasListDTO>	systemScopesRoleAliasesGetWithHttpInfo() Retrieve Role Alias Mappings This operation can be used to retreive role alias mapping
RoleAliasListDTO	systemScopesRoleAliasesPut(RoleAliasListDTO roleAliasListDTO) Add a New Role Alias This operation can be used to add a new role alias mapping for system scope roles
okhttp3.Call	systemScopesRoleAliasesPutAsync(RoleAliasListDTO roleAliasListDTO, ApiCallback<RoleAliasListDTO> _callback) Add a New Role Alias (asynchronously) This operation can be used to add a new role alias mapping for system scope roles
okhttp3.Call	systemScopesRoleAliasesPutCall(RoleAliasListDTO roleAliasListDTO, ApiCallback _callback) Build call for systemScopesRoleAliasesPut
ApiResponse<RoleAliasListDTO>	systemScopesRoleAliasesPutWithHttpInfo(RoleAliasListDTO roleAliasListDTO) Add a New Role Alias This operation can be used to add a new role alias mapping for system scope roles
ScopeSettingsDTO	systemScopesScopeNameGet(String scopeName, String username) Retrieve Scopes for a Particular User This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter
okhttp3.Call	systemScopesScopeNameGetAsync(String scopeName, String username, ApiCallback<ScopeSettingsDTO> _callback) Retrieve Scopes for a Particular User (asynchronously) This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter
okhttp3.Call	systemScopesScopeNameGetCall(String scopeName, String username, ApiCallback _callback) Build call for systemScopesScopeNameGet
ApiResponse<ScopeSettingsDTO>	systemScopesScopeNameGetWithHttpInfo(String scopeName, String username) Retrieve Scopes for a Particular User This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter
ScopeListDTO	updateRolesForScope(ScopeListDTO scopeListDTO) Update Roles For Scope This operation is used to update the roles for all scopes
okhttp3.Call	updateRolesForScopeAsync(ScopeListDTO scopeListDTO, ApiCallback<ScopeListDTO> _callback) Update Roles For Scope (asynchronously) This operation is used to update the roles for all scopes
okhttp3.Call	updateRolesForScopeCall(ScopeListDTO scopeListDTO, ApiCallback _callback) Build call for updateRolesForScope
ApiResponse<ScopeListDTO>	updateRolesForScopeWithHttpInfo(ScopeListDTO scopeListDTO) Update Roles For Scope This operation is used to update the roles for all scopes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SystemScopesApi

public SystemScopesApi()

SystemScopesApi

public SystemScopesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

systemScopesGetCall

public okhttp3.Call systemScopesGetCall(ApiCallback _callback)
                                 throws ApiException

Build call for systemScopesGet

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

systemScopesGet

public ScopeListDTO systemScopesGet()
                             throws ApiException

Get Role Scope Mappings This operation is used to get the list of role scope mapping from tenant-conf for the apim admin dashboard

Returns:

ScopeListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesGetWithHttpInfo

public ApiResponse<ScopeListDTO> systemScopesGetWithHttpInfo()
                                                      throws ApiException

Get Role Scope Mappings This operation is used to get the list of role scope mapping from tenant-conf for the apim admin dashboard

Returns:

ApiResponse<ScopeListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesGetAsync

public okhttp3.Call systemScopesGetAsync(ApiCallback<ScopeListDTO> _callback)
                                  throws ApiException

Get Role Scope Mappings (asynchronously) This operation is used to get the list of role scope mapping from tenant-conf for the apim admin dashboard

Parameters:

_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

systemScopesRoleAliasesGetCall

public okhttp3.Call systemScopesRoleAliasesGetCall(ApiCallback _callback)
                                            throws ApiException

Build call for systemScopesRoleAliasesGet

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

systemScopesRoleAliasesGet

public RoleAliasListDTO systemScopesRoleAliasesGet()
                                            throws ApiException

Retrieve Role Alias Mappings This operation can be used to retreive role alias mapping

Returns:

RoleAliasListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesRoleAliasesGetWithHttpInfo

public ApiResponse<RoleAliasListDTO> systemScopesRoleAliasesGetWithHttpInfo()
                                                                     throws ApiException

Retrieve Role Alias Mappings This operation can be used to retreive role alias mapping

Returns:

ApiResponse<RoleAliasListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesRoleAliasesGetAsync

public okhttp3.Call systemScopesRoleAliasesGetAsync(ApiCallback<RoleAliasListDTO> _callback)
                                             throws ApiException

Retrieve Role Alias Mappings (asynchronously) This operation can be used to retreive role alias mapping

Parameters:

_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

systemScopesRoleAliasesPutCall

public okhttp3.Call systemScopesRoleAliasesPutCall(RoleAliasListDTO roleAliasListDTO,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for systemScopesRoleAliasesPut

Parameters:

roleAliasListDTO - role-alias mapping (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

systemScopesRoleAliasesPut

public RoleAliasListDTO systemScopesRoleAliasesPut(RoleAliasListDTO roleAliasListDTO)
                                            throws ApiException

Add a New Role Alias This operation can be used to add a new role alias mapping for system scope roles

Parameters:

roleAliasListDTO - role-alias mapping (required)

Returns:

RoleAliasListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesRoleAliasesPutWithHttpInfo

public ApiResponse<RoleAliasListDTO> systemScopesRoleAliasesPutWithHttpInfo(RoleAliasListDTO roleAliasListDTO)
                                                                     throws ApiException

Add a New Role Alias This operation can be used to add a new role alias mapping for system scope roles

Parameters:

roleAliasListDTO - role-alias mapping (required)

Returns:

ApiResponse<RoleAliasListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesRoleAliasesPutAsync

public okhttp3.Call systemScopesRoleAliasesPutAsync(RoleAliasListDTO roleAliasListDTO,
                                                    ApiCallback<RoleAliasListDTO> _callback)
                                             throws ApiException

Add a New Role Alias (asynchronously) This operation can be used to add a new role alias mapping for system scope roles

Parameters:

roleAliasListDTO - role-alias mapping (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

systemScopesScopeNameGetCall

public okhttp3.Call systemScopesScopeNameGetCall(String scopeName,
                                                 String username,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for systemScopesScopeNameGet

Parameters:

scopeName - scope name to be validated (required)

username - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

systemScopesScopeNameGet

public ScopeSettingsDTO systemScopesScopeNameGet(String scopeName,
                                                 String username)
                                          throws ApiException

Retrieve Scopes for a Particular User This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Parameters:

scopeName - scope name to be validated (required)

username - (optional)

Returns:

ScopeSettingsDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesScopeNameGetWithHttpInfo

public ApiResponse<ScopeSettingsDTO> systemScopesScopeNameGetWithHttpInfo(String scopeName,
                                                                          String username)
                                                                   throws ApiException

Retrieve Scopes for a Particular User This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Parameters:

scopeName - scope name to be validated (required)

username - (optional)

Returns:

ApiResponse<ScopeSettingsDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

systemScopesScopeNameGetAsync

public okhttp3.Call systemScopesScopeNameGetAsync(String scopeName,
                                                  String username,
                                                  ApiCallback<ScopeSettingsDTO> _callback)
                                           throws ApiException

Retrieve Scopes for a Particular User (asynchronously) This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Parameters:

scopeName - scope name to be validated (required)

username - (optional)

_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

updateRolesForScopeCall

public okhttp3.Call updateRolesForScopeCall(ScopeListDTO scopeListDTO,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for updateRolesForScope

Parameters:

scopeListDTO - Scope list object with updated scope to role mappings (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateRolesForScope

public ScopeListDTO updateRolesForScope(ScopeListDTO scopeListDTO)
                                 throws ApiException

Update Roles For Scope This operation is used to update the roles for all scopes

Parameters:

scopeListDTO - Scope list object with updated scope to role mappings (required)

Returns:

ScopeListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateRolesForScopeWithHttpInfo

public ApiResponse<ScopeListDTO> updateRolesForScopeWithHttpInfo(ScopeListDTO scopeListDTO)
                                                          throws ApiException

Update Roles For Scope This operation is used to update the roles for all scopes

Parameters:

scopeListDTO - Scope list object with updated scope to role mappings (required)

Returns:

ApiResponse<ScopeListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateRolesForScopeAsync

public okhttp3.Call updateRolesForScopeAsync(ScopeListDTO scopeListDTO,
                                             ApiCallback<ScopeListDTO> _callback)
                                      throws ApiException

Update Roles For Scope (asynchronously) This operation is used to update the roles for all scopes

Parameters:

scopeListDTO - Scope list object with updated scope to role mappings (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