Class RestAPIAdminImpl
java.lang.Object
org.wso2.am.integration.test.impl.RestAPIAdminImpl
This util class performs the actions related to APIDTOobjects.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRestAPIAdminImpl(String username, String password, String tenantDomain, String adminURl) -
Method Summary
Modifier and TypeMethodDescriptionaddAdvancedThrottlingPolicy(AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO) This method is used to create an advanced throttling policy.addAIServiceProvider(String name, String apiVersion, String description, Boolean multipleModelProviderSupport, String configurations, File apiDefinition, String modelProviders) Add the details of a specific AI Service Provider.addApiCategory(APICategoryDTO apiCategoryDTO) This method is used to add an API category.addApplicationThrottlingPolicy(ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO) This method is used to create an application throttling policy.addCustomThrottlingPolicy(CustomRuleDTO customRuleDTO) This method is used to create an custom throttling policy.addDenyThrottlingPolicy(BlockingConditionDTO denyPolicyDTO) Creates an deny throttling policy.addEnvironment(EnvironmentDTO environmentDTO) This method is used to add an environment.addKeyManager(KeyManagerDTO keyManagerDTO) This method is used to add a label.addLLMProvider(String name, String apiVersion, String description, String configuration, File apiDefinition, String modelList) Add the details of a specific LLM Provider.addOrganization(OrganizationDTO organizationDto) This method is used to add an Organization.addRoleAliasMappingForSystemScopeRoles(int count, String role, String[] aliases) This method is used to add a new role alias mapping for system scope roles.addSubscriptionThrottlingPolicy(SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO) This method is used to create a subscription throttling policy.changeApiProvider(String newProvider, String apiId) changeApplicationOwner(String newOwner, String applicationId) This method is used to change the owner of an application.deleteAdvancedThrottlingPolicy(String policyId) This method is used to delete an advanced throttling policy.deleteAIServiceProvider(String aiServiceProviderId) Deletes a specific AI Service Provider by its ID.deleteApiCategory(String uuid) This method is used to delete an API category.deleteApplicationThrottlingPolicy(String policyId) This method is used to delete an application throttling policy.deleteCustomThrottlingPolicy(String policyId) This method is used to delete a custom throttling policy.deleteDenyThrottlingPolicy(String policyId) Deletes a deny throttling policy.deleteEnvironment(String environmentId) This method is used to delete an environment.deleteKeyManager(String uuid) deleteLabel(String labelId) This method is used to delete a label.deleteLLMProvider(String llmProviderId) Deletes a specific LLM Provider by its ID.voiddeleteOrganization(String organizationId) This method is used to delete organizatoindeleteSubscriptionThrottlingPolicy(String policyId) This method is used to delete a subscription throttling policy.exportThrottlePolicy(String policyName, String policyType) This method is used to export a Throttling PolicygetAdvancedThrottlingPolicy(String policyId) This method is used to retrieve an advanced throttling policy.getAIServiceProvider(String aiServiceProviderId) Retrieves details of a specific AI Service Provider by its ID.Retrieves a list of AI Service Providers.This method is used to retrieve all API categories.This method is used to retrieve applications.getApplicationThrottlingPolicy(String policyId) This method is used to retrieve an application throttling policy.This method is used to retrieve blocking conditions by condition type and condition value.getCustomThrottlingPolicy(String policyId) This method is used to retrieve a custom throttling policy.getDenyThrottlingPolicy(String policyId) Retrieves a deny throttling policy.This method is used to retrieve all environments.getKeyManager(String uuid) This method is used to retrieve all labels.getLLMProvider(String llmProviderId) Retrieves details of a specific LLM Provider by its ID.Retrieves a list of LLM Providers.This method is used to add get Organization.This method is used to get role aliases.getSubscriptionThrottlingPolicy(String policyId) This method is used to retrieve a subscription throttling policy.This method is used to retrieve tenant Config.This method is used to retrieve tenant Config Schema.getThrottlePolicies(String query) This method is used to get a list throttling policy detailsgetWorkflowByExternalWorkflowReference(String externalWorkflowRef) getWorkflows(String workflowType) getWorkflowsByWorkflowType(String workflowType) importThrottlePolicy(File file, Boolean overwrite) This method is used to import a Throttling PolicyputRoleAliases(RoleAliasListDTO roleAliasListDTO) This method is used to put an system scopes mapping.rejectWorkflowStatus(String workflowReferenceId) This method is used to reject a workflowretrieveScopesForParticularUser(String scopeName, String username) This method is used to retrieve scopes for a particular user.updateAdvancedThrottlingPolicy(String policyId, AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO) This method is used to update an advanced throttling policy.updateAIServiceProvider(String aiServiceProviderId, String name, String apiVersion, String description, Boolean multipleModelProviderSupport, String configurations, File apiDefinition, String modelProviders) Updates the details of a specific AI Service Provider by its ID.updateApiCategory(String uuid, APICategoryDTO apiCategoryDTO) This method is used to update an API categoryupdateApplicationThrottlingPolicy(String policyId, ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO) This method is used to update an application throttling policy.updateCustomThrottlingPolicy(String policyId, CustomRuleDTO customRuleDTO) This method is used to update a custom throttling policy.updateDenyThrottlingPolicy(String conditionId, String conditionType, BlockingConditionStatusDTO blockingConditionStatusDTO) Updates an deny throttling policy.updateEnvironment(String environmentId, EnvironmentDTO environmentDTO) This method is used to update an environment.updateKeyManager(String uuid, KeyManagerDTO keyManagerDTO) updateLabel(String labelId, LabelDTO labelDTO) This method is used to update a label.updateLLMProvider(String llmProviderId, String name, String apiVersion, String description, String configuration, File apiDefinition, String modelList) Updates the details of a specific LLM Provider by its ID.updateSubscriptionThrottlingPolicy(String policyId, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO) This method is used to update a subscription throttling policy.updateTenantConfig(Object tenantConf) This method is used to update tenant config.updateWorkflowStatus(String workflowReferenceId)
-
Field Details
-
apiAdminClient
-
workflowCollectionApi
-
workflowsIndividualApi
-
applicationPolicyCollectionApi
-
appName
- See Also:
-
callBackURL
- See Also:
-
tokenScope
- See Also:
-
appOwner
- See Also:
-
grantType
- See Also:
-
username
- See Also:
-
password
- See Also:
-
tenantDomain
-
-
Constructor Details
-
RestAPIAdminImpl
-
-
Method Details
-
getThrottlePolicies
This method is used to get a list throttling policy details- Parameters:
query- Filters by throttling policy type- Returns:
- Throttling Policy details list
- Throws:
ApiException- Throws if an error occurred while getting throttling policy details
-
exportThrottlePolicy
public ApiResponse<ExportThrottlePolicyDTO> exportThrottlePolicy(String policyName, String policyType) throws ApiException This method is used to export a Throttling Policy- Parameters:
policyName- Throttling Policy name to be exportedpolicyType- Throttling Policy type- Returns:
- ExportThrottlePolicyApi response returned by the API call
- Throws:
ApiException- Throws if an error occurred while exporting Throttling policy
-
importThrottlePolicy
This method is used to import a Throttling Policy- Parameters:
file- Exported throttling policy fileoverwrite- overwrites already existing throttling policy- Returns:
- ImportThrottlePolicyApi response returned by the API call
- Throws:
ApiException- Throws if an error occurred while importing Throttling policy
-
addApiCategory
public ApiResponse<APICategoryDTO> addApiCategory(APICategoryDTO apiCategoryDTO) throws ApiException This method is used to add an API category.- Parameters:
apiCategoryDTO- API category DTO to be added- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while adding the new API category.
-
updateApiCategory
public ApiResponse<APICategoryDTO> updateApiCategory(String uuid, APICategoryDTO apiCategoryDTO) throws ApiException This method is used to update an API category- Parameters:
uuid- UUID of the API category to be updatedapiCategoryDTO- API category DTO to be updated- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while updating the new API category.
-
getApiCategories
This method is used to retrieve all API categories.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while retrieving all API categories.
-
deleteApiCategory
This method is used to delete an API category.- Parameters:
uuid- uuid of the API category to be deleted.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while deleting the API category.
-
getLLMProviders
Retrieves a list of LLM Providers.- Returns:
- ApiResponse containing a list of LLMProviderSummaryResponseListDTO with details about available LLM providers.
- Throws:
ApiException- if there is an error during the API call.
-
getLLMProvider
Retrieves details of a specific LLM Provider by its ID.- Parameters:
llmProviderId- The unique identifier of the LLM provider.- Returns:
- ApiResponse containing LLMProviderResponseDTO with details of the specified LLM provider.
- Throws:
ApiException- if there is an error during the API call.
-
addLLMProvider
public ApiResponse<LLMProviderResponseDTO> addLLMProvider(String name, String apiVersion, String description, String configuration, File apiDefinition, String modelList) throws ApiException Add the details of a specific LLM Provider.- Parameters:
name- The new name of the LLM provider.apiVersion- The API version of the LLM provider.description- A brief description of the LLM provider.configuration- Configuration details for the LLM provider.apiDefinition- The API definition file for the LLM provider.modelList- The list of models for the LLM provider.- Returns:
- ApiResponse containing LLMProviderResponseDTO with the updated details of the LLM provider.
- Throws:
ApiException- if there is an error during the API call.
-
updateLLMProvider
public ApiResponse<LLMProviderResponseDTO> updateLLMProvider(String llmProviderId, String name, String apiVersion, String description, String configuration, File apiDefinition, String modelList) throws ApiException Updates the details of a specific LLM Provider by its ID.- Parameters:
llmProviderId- The unique identifier of the LLM provider.name- The new name of the LLM provider.apiVersion- The API version of the LLM provider.description- A brief description of the LLM provider.configuration- Configuration details for the LLM provider.apiDefinition- The API definition file for the LLM provider.modelList- The list of models for the LLM provider.- Returns:
- ApiResponse containing LLMProviderResponseDTO with the updated details of the LLM provider.
- Throws:
ApiException- if there is an error during the API call.
-
deleteLLMProvider
Deletes a specific LLM Provider by its ID.- Parameters:
llmProviderId- The unique identifier of the LLM provider to be deleted.- Returns:
- ApiResponse containing void, indicating successful deletion of the LLM provider.
- Throws:
ApiException- if there is an error during the API call.
-
getAIServiceProviders
public ApiResponse<AIServiceProviderSummaryResponseListDTO> getAIServiceProviders() throws ApiExceptionRetrieves a list of AI Service Providers.- Returns:
- ApiResponse containing a list of AIServiceProviderSummaryResponseListDTO with details about available AI service providers.
- Throws:
ApiException- if there is an error during the API call.
-
getAIServiceProvider
public ApiResponse<AIServiceProviderResponseDTO> getAIServiceProvider(String aiServiceProviderId) throws ApiException Retrieves details of a specific AI Service Provider by its ID.- Parameters:
aiServiceProviderId- The unique identifier of the AI service provider.- Returns:
- ApiResponse containing AIServiceProviderResponseDTO with details of the specified AI service provider.
- Throws:
ApiException- if there is an error during the API call.
-
addAIServiceProvider
public ApiResponse<AIServiceProviderResponseDTO> addAIServiceProvider(String name, String apiVersion, String description, Boolean multipleModelProviderSupport, String configurations, File apiDefinition, String modelProviders) throws ApiException Add the details of a specific AI Service Provider.- Parameters:
name- The new name of the AI service provider.apiVersion- The API version of the AI service provider.description- A brief description of the AI service provider.multipleModelProviderSupport- Whether the provider supports multiple model providers.configurations- Configuration details for the AI service provider.apiDefinition- The API definition file for the AI service provider.modelProviders- The list of model providers for the AI service provider.- Returns:
- ApiResponse containing AIServiceProviderResponseDTO with the created details of the AI service provider.
- Throws:
ApiException- if there is an error during the API call.
-
updateAIServiceProvider
public ApiResponse<AIServiceProviderResponseDTO> updateAIServiceProvider(String aiServiceProviderId, String name, String apiVersion, String description, Boolean multipleModelProviderSupport, String configurations, File apiDefinition, String modelProviders) throws ApiException Updates the details of a specific AI Service Provider by its ID.- Parameters:
aiServiceProviderId- The unique identifier of the AI service provider.name- The new name of the AI service provider.apiVersion- The API version of the AI service provider.description- A brief description of the AI service provider.multipleModelProviderSupport- Whether the provider supports multiple model providers.configurations- Configuration details for the AI service provider.apiDefinition- The API definition file for the AI service provider.modelProviders- The list of model providers for the AI service provider.- Returns:
- ApiResponse containing AIServiceProviderResponseDTO with the updated details of the AI service provider.
- Throws:
ApiException- if there is an error during the API call.
-
deleteAIServiceProvider
Deletes a specific AI Service Provider by its ID.- Parameters:
aiServiceProviderId- The unique identifier of the AI service provider to be deleted.- Returns:
- ApiResponse containing void, indicating successful deletion of the AI service provider.
- Throws:
ApiException- if there is an error during the API call.
-
putRoleAliases
public ApiResponse<RoleAliasListDTO> putRoleAliases(RoleAliasListDTO roleAliasListDTO) throws ApiException This method is used to put an system scopes mapping.- Parameters:
roleAliasListDTO- Role Alias DTO to be updated- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while adding the new API category.
-
getRoleAliases
This method is used to get role aliases.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while adding the new API category.
-
addKeyManager
- Throws:
ApiException
-
getKeyManagers
- Throws:
ApiException
-
getKeyManager
- Throws:
ApiException
-
updateKeyManager
public ApiResponse<KeyManagerDTO> updateKeyManager(String uuid, KeyManagerDTO keyManagerDTO) throws ApiException - Throws:
ApiException
-
deleteKeyManager
- Throws:
ApiException
-
getSettings
- Throws:
ApiException
-
addApplicationThrottlingPolicy
public ApiResponse<ApplicationThrottlePolicyDTO> addApplicationThrottlingPolicy(ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO) throws ApiException This method is used to create an application throttling policy.- Parameters:
applicationThrottlePolicyDTO- Application throttling policy DTO to be added.- Returns:
- API response returned by the API call.
- Throws:
ApiException- if an error occurs while creating the application throttling policy.
-
getApplicationThrottlingPolicy
public ApiResponse<ApplicationThrottlePolicyDTO> getApplicationThrottlingPolicy(String policyId) throws ApiException This method is used to retrieve an application throttling policy.- Returns:
- API response returned by the API call.
- Throws:
ApiException- if an error occurs while retrieving the application throttling policy.
-
updateApplicationThrottlingPolicy
public ApiResponse<ApplicationThrottlePolicyDTO> updateApplicationThrottlingPolicy(String policyId, ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO) throws ApiException This method is used to update an application throttling policy.- Parameters:
policyId- Policy Id of the application throttling policy to be updated.applicationThrottlePolicyDTO- Application throttling policy DTO which contains the update content.- Returns:
- API response returned by the API call.
- Throws:
ApiException- if an error occurs while updating the application throttling policy.
-
deleteApplicationThrottlingPolicy
This method is used to delete an application throttling policy.- Parameters:
policyId- Policy Id of the application throttling policy to be deleted.- Returns:
- API response returned by the API call.
- Throws:
ApiException- if an error occurs while deleting the application throttling policy.
-
addSubscriptionThrottlingPolicy
public ApiResponse<SubscriptionThrottlePolicyDTO> addSubscriptionThrottlingPolicy(SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO) throws ApiException This method is used to create a subscription throttling policy.- Parameters:
subscriptionThrottlePolicyDTO- Subscription throttling policy DTO to be added.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while creating the new subscription throttling policy.
-
getSubscriptionThrottlingPolicy
public ApiResponse<SubscriptionThrottlePolicyDTO> getSubscriptionThrottlingPolicy(String policyId) throws ApiException This method is used to retrieve a subscription throttling policy.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving the subscription throttling policy.
-
updateSubscriptionThrottlingPolicy
public ApiResponse<SubscriptionThrottlePolicyDTO> updateSubscriptionThrottlingPolicy(String policyId, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO) throws ApiException This method is used to update a subscription throttling policy.- Parameters:
policyId- Policy Id of the subscription throttling policy to be updated.subscriptionThrottlePolicyDTO- Subscription throttling policy DTO which contains the updated content.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while updating the subscription throttling policy.
-
deleteSubscriptionThrottlingPolicy
This method is used to delete a subscription throttling policy.- Parameters:
policyId- Subscription throttling policy Id.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while deleting the subscription throttling policy.
-
addCustomThrottlingPolicy
public ApiResponse<CustomRuleDTO> addCustomThrottlingPolicy(CustomRuleDTO customRuleDTO) throws ApiException This method is used to create an custom throttling policy.- Parameters:
customRuleDTO- Custom throttling policy DTO to be added.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while creating the custom throttling policy.
-
getCustomThrottlingPolicy
This method is used to retrieve a custom throttling policy.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving the custom throttling policy.
-
updateCustomThrottlingPolicy
public ApiResponse<CustomRuleDTO> updateCustomThrottlingPolicy(String policyId, CustomRuleDTO customRuleDTO) throws ApiException This method is used to update a custom throttling policy.- Parameters:
policyId- Policy Id of the custom throttling policy to be updated.customRuleDTO- Custom throttling policy DTO which contains the updated content.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while updating the custom throttling policy.
-
deleteCustomThrottlingPolicy
This method is used to delete a custom throttling policy.- Parameters:
policyId- Policy Id of the custom throttling policy to be deleted.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while deleting the custom throttling policy.
-
addDenyThrottlingPolicy
public ApiResponse<BlockingConditionDTO> addDenyThrottlingPolicy(BlockingConditionDTO denyPolicyDTO) throws ApiException Creates an deny throttling policy.- Parameters:
denyPolicyDTO- deny throttling policy DTO to be added.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while creating the deny throttling policy.
-
updateDenyThrottlingPolicy
public ApiResponse<BlockingConditionDTO> updateDenyThrottlingPolicy(String conditionId, String conditionType, BlockingConditionStatusDTO blockingConditionStatusDTO) throws ApiException Updates an deny throttling policy.- Parameters:
conditionId- policy id of the deny throttling policy to be updated.conditionType- condition type of the deny throttling policy to be.blockingConditionStatusDTO- deny throttling policy status DTO to be updated.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while creating the deny throttling policy.
-
getDenyThrottlingPolicy
public ApiResponse<BlockingConditionDTO> getDenyThrottlingPolicy(String policyId) throws ApiException Retrieves a deny throttling policy.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving the deny throttling policy.
-
getBlockingConditionsByConditionTypeAndValue
public BlockingConditionListDTO getBlockingConditionsByConditionTypeAndValue(String query) throws ApiException This method is used to retrieve blocking conditions by condition type and condition value.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving the blocking conditions.
-
deleteDenyThrottlingPolicy
Deletes a deny throttling policy.- Parameters:
policyId- policy id of the deny throttling policy to be deleted.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while deleting the deny throttling policy.
-
addAdvancedThrottlingPolicy
public ApiResponse<AdvancedThrottlePolicyDTO> addAdvancedThrottlingPolicy(AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO) throws ApiException This method is used to create an advanced throttling policy.- Parameters:
advancedThrottlePolicyDTO- Advanced throttling policy DTO to be added.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while creating the new advanced policy.
-
getAdvancedThrottlingPolicy
public ApiResponse<AdvancedThrottlePolicyDTO> getAdvancedThrottlingPolicy(String policyId) throws ApiException This method is used to retrieve an advanced throttling policy.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving the advanced throttling policy.
-
updateAdvancedThrottlingPolicy
public ApiResponse<AdvancedThrottlePolicyDTO> updateAdvancedThrottlingPolicy(String policyId, AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO) throws ApiException This method is used to update an advanced throttling policy.- Parameters:
policyId- Policy Id of the advanced throttling policy to be updated.advancedThrottlePolicyDTO- Advanced throttling policy DTO which contains the updated content.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while updating the advanced throttling policy.
-
deleteAdvancedThrottlingPolicy
This method is used to delete an advanced throttling policy.- Parameters:
policyId- Policy Id of the advanced throttling policy to be deleted.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while deleting the advanced throttling policy.
-
addLabel
This method is used to add a label.- Parameters:
labelDTO- Label DTO to be added.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while adding the new label.
-
getLabels
This method is used to retrieve all labels.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while retrieving all labels.
-
updateLabel
This method is used to update a label.- Parameters:
labelId- Label Id of the label to be updated.labelDTO- Label DTO which contains the updated content.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while updating the label.
-
deleteLabel
This method is used to delete a label.- Parameters:
labelId- Label Id of the label to be updated.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while deleting the label.
-
addEnvironment
public ApiResponse<EnvironmentDTO> addEnvironment(EnvironmentDTO environmentDTO) throws ApiException This method is used to add an environment.- Parameters:
environmentDTO- Environment DTO to be added.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while adding the new environment.
-
getEnvironments
This method is used to retrieve all environments.- Returns:
- API response returned by the API call.
- Throws:
ApiException- Throws if an error occurred while retrieving all environments of tenant.
-
updateEnvironment
public ApiResponse<EnvironmentDTO> updateEnvironment(String environmentId, EnvironmentDTO environmentDTO) throws ApiException This method is used to update an environment.- Parameters:
environmentId- Environment Id of the label to be updated.environmentDTO- Environment DTO which contains the updated content.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while updating the environment.
-
deleteEnvironment
This method is used to delete an environment.- Parameters:
environmentId- Environment Id of the label to be deleted.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while deleting the environment.
-
getApplications
public ApiResponse<ApplicationListDTO> getApplications(String user, Integer limit, Integer offset, String appTenantDomain, String name) throws ApiException This method is used to retrieve applications.- Parameters:
user- Username of the application creator.limit- Maximum number of applications to return.offset- Starting point within the complete list of applications qualified.appTenantDomain- Tenant domain of the applications to get.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving applications.
-
changeApplicationOwner
public ApiResponse<Void> changeApplicationOwner(String newOwner, String applicationId) throws ApiException This method is used to change the owner of an application.- Parameters:
newOwner- New owner of the application.applicationId- Application ID of the application.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while changing the owner of an application.
-
changeApiProvider
- Throws:
ApiException
-
retrieveScopesForParticularUser
public ScopeSettingsDTO retrieveScopesForParticularUser(String scopeName, String username) throws ApiException This method is used to retrieve scopes for a particular user.- Parameters:
scopeName- Scope name.username- Username of the user.- Returns:
- ScopeSettingsDTO returned by API call.
- Throws:
ApiException- if an error occurs while retrieving the scopes of a particular user.
-
addRoleAliasMappingForSystemScopeRoles
public RoleAliasListDTO addRoleAliasMappingForSystemScopeRoles(int count, String role, String[] aliases) throws ApiException This method is used to add a new role alias mapping for system scope roles.- Parameters:
count- The number of role aliases.role- Name of the role.aliases- List of aliases.- Returns:
- RoleAliasListDTO returned by API call.
- Throws:
ApiException- if an error occurs while adding role aliases mappings for system scope roles.
-
getWorkflowByExternalWorkflowReference
public HttpResponse getWorkflowByExternalWorkflowReference(String externalWorkflowRef) throws ApiException - Throws:
ApiException
-
getWorkflows
- Throws:
ApiException
-
updateWorkflowStatus
- Throws:
ApiException
-
rejectWorkflowStatus
This method is used to reject a workflow- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while rejecting a workflow
-
getTenantConfig
This method is used to retrieve tenant Config.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving tenant Config.
-
updateTenantConfig
This method is used to update tenant config.- Parameters:
tenantConf- Tenant Configuration.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs updating the tenant conf.
-
getTenantConfigSchema
This method is used to retrieve tenant Config Schema.- Returns:
- API response returned by API call.
- Throws:
ApiException- if an error occurs while retrieving tenant Config schema.
-
getWorkflowsByWorkflowType
- Throws:
ApiException
-
addOrganization
public ApiResponse<OrganizationDTO> addOrganization(OrganizationDTO organizationDto) throws ApiException This method is used to add an Organization.- Parameters:
organizationDto- organization- Returns:
- created organization
- Throws:
ApiException- Throws if an error occurred while adding the new organization.
-
getOrganizations
This method is used to add get Organization.- Parameters:
organizationDto- organization- Returns:
- created organization
- Throws:
ApiException- Throws if an error occurred while adding the new organization.
-
deleteOrganization
This method is used to delete organizatoin- Parameters:
organizationId- id of the organization to delete- Throws:
ApiException
-