| Package | Description |
|---|---|
| org.wso2.am.integration.clients.admin | |
| org.wso2.am.integration.clients.admin.api |
| Modifier and Type | Method and Description |
|---|---|
<T> ApiResponse<T> |
ApiClient.execute(com.squareup.okhttp.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(com.squareup.okhttp.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<Void> |
ApiCategoryIndividualApi.apiCategoriesApiCategoryIdDeleteWithHttpInfo(String apiCategoryId,
String ifMatch,
String ifUnmodifiedSince)
Delete an API Category
Delete an API Category by API Category Id
|
ApiResponse<APICategoryDTO> |
ApiCategoryIndividualApi.apiCategoriesApiCategoryIdPutWithHttpInfo(String apiCategoryId,
APICategoryDTO body)
Update an API Category
Update an API Category by category Id
|
ApiResponse<APICategoryListDTO> |
ApiCategoryCollectionApi.apiCategoriesGetWithHttpInfo()
Get all API categories
Get all API categories
|
ApiResponse<APICategoryDTO> |
ApiCategoryIndividualApi.apiCategoriesPostWithHttpInfo(APICategoryDTO body)
Add a new API Category
Add a new API Category
|
ApiResponse<Void> |
ApplicationApi.applicationsApplicationIdChangeOwnerPostWithHttpInfo(String owner,
String applicationId)
Change Application Owner
This operation is used to change the owner of an Application.
|
ApiResponse<ApplicationListDTO> |
ApplicationCollectionApi.applicationsGetWithHttpInfo(String user,
Integer limit,
Integer offset,
String accept,
String ifNoneMatch,
String tenantDomain)
Retrieve/Search applications
This operation can be used to retrieve list of applications that is belonged to the given user, If no user is provided then the application for the user associated with the provided access token will be returned.
|
ApiResponse<File> |
ApiIndividualApi.exportApiGetWithHttpInfo(String name,
String version,
String providerName,
String format,
Boolean preserveStatus)
Export an API
This operation can be used to export the details of a particular API as a zip file.
|
ApiResponse<File> |
ApiProductIndividualApi.exportApiProductGetWithHttpInfo(String name,
String version,
String providerName,
String format,
Boolean preserveStatus)
Export an API Product
This operation can be used to export the details of a particular API Product as a zip file.
|
ApiResponse<File> |
ApplicationIndividualApi.exportApplicationsGetWithHttpInfo(String appName,
String appOwner,
Boolean withKeys)
Export an Application
This operation can be used to export the details of a particular Application as a zip file.
|
ApiResponse<AlertTypesListDTO> |
AlertsApi.getAdminAlertTypesWithHttpInfo()
Get the list of admin alert types.
|
ApiResponse<BotDetectionAlertSubscriptionListDTO> |
BotDetectionAlertSubscriptionsApi.getBotDetectionAlertSubscriptionsWithHttpInfo()
Get the list of subscriptions for bot detection
Get the list of subscriptions which are subscribed to receive email alerts for bot detection
|
ApiResponse<BotDetectionDataListDTO> |
DefaultApi.getBotDetectionDataWithHttpInfo()
Get all bot detected data
Get all bot detected data
|
ApiResponse<CustomUrlInfoDTO> |
TenantsApi.getCustomUrlInfoByTenantDomainWithHttpInfo(String tenantDomain)
Get custom-url info of a tenant domain
This operation is to get custom-url information of the provided tenant-domain
|
ApiResponse<AlertsSubscriptionDTO> |
AlertSubscriptionsApi.getSubscribedAlertTypesWithHttpInfo()
Get the list of API Admin alert types subscribed by the user.
|
ApiResponse<TenantInfoDTO> |
TenantsApi.getTenantInfoByUsernameWithHttpInfo(String username)
Get tenant id of the user
This operation is to get tenant id of the provided user
|
ApiResponse<Void> |
ApiIndividualApi.importApiPostWithHttpInfo(File file,
Boolean preserveProvider,
Boolean overwrite)
Import an API
This operation can be used to import an API.
|
ApiResponse<Void> |
ApiProductIndividualApi.importApiProductPostWithHttpInfo(File file,
Boolean preserveProvider,
Boolean importAPIs,
Boolean overwriteAPIProduct,
Boolean overwriteAPIs)
Import an API Product
This operation can be used to import an API Product.
|
ApiResponse<ApplicationInfoDTO> |
ApplicationIndividualApi.importApplicationsPostWithHttpInfo(File file,
Boolean preserveOwner,
Boolean skipSubscriptions,
String appOwner,
Boolean skipApplicationKeys,
Boolean update)
Import an Application
This operation can be used to import an Application.
|
ApiResponse<KeyManagerListDTO> |
KeyManagerCollectionApi.keyManagersGetWithHttpInfo()
Get all Key managers
Get all Key managers
|
ApiResponse<Void> |
KeyManagerIndividualApi.keyManagersKeyManagerIdDeleteWithHttpInfo(String keyManagerId)
Delete a Key Manager
Delete a Key Manager by keyManager id
|
ApiResponse<KeyManagerDTO> |
KeyManagerIndividualApi.keyManagersKeyManagerIdGetWithHttpInfo(String keyManagerId)
Get a Key Manager Configuration
Retrieve a single Key Manager Configuration.
|
ApiResponse<KeyManagerDTO> |
KeyManagerIndividualApi.keyManagersKeyManagerIdPutWithHttpInfo(String keyManagerId,
KeyManagerDTO body)
Update a Key Manager
Update a Key Manager by keyManager id
|
ApiResponse<KeyManagerDTO> |
KeyManagerCollectionApi.keyManagersPostWithHttpInfo(KeyManagerDTO body)
Add a new API Key Manager
Add a new API Key Manager
|
ApiResponse<LabelListDTO> |
LabelCollectionApi.labelsGetWithHttpInfo()
Get all registered Labels
Get all registered Labels
|
ApiResponse<Void> |
LabelApi.labelsLabelIdDeleteWithHttpInfo(String labelId,
String ifMatch,
String ifUnmodifiedSince)
Delete a Label
Delete a Label by label Id
|
ApiResponse<LabelDTO> |
LabelApi.labelsLabelIdPutWithHttpInfo(String labelId,
LabelDTO body)
Update a Label
Update a Label by label Id
|
ApiResponse<LabelDTO> |
LabelApi.labelsPostWithHttpInfo(LabelDTO body)
Add a Label
Add a new gateway Label
|
ApiResponse<PublishStatusDTO> |
MonetizationCollectionApi.monetizationPublishUsagePostWithHttpInfo()
Publish Usage Records
Publish Usage Records of Monetized APIs
|
ApiResponse<MonetizationUsagePublishInfoDTO> |
MonetizationCollectionApi.monetizationPublishUsageStatusGetWithHttpInfo()
Get the status of Monetization usage publisher
Get the status of Monetization usage publisher
|
ApiResponse<MediationListDTO> |
MediationPolicyCollectionApi.policiesMediationGetWithHttpInfo(Integer limit,
Integer offset,
String query,
String accept,
String ifNoneMatch)
Get all global mediation policies
This operation provides you a list of available all global level mediation policies.
|
ApiResponse<Void> |
MediationPolicyIndividualApi.policiesMediationMediationPolicyIdDeleteWithHttpInfo(String mediationPolicyId,
String ifMatch,
String ifUnmodifiedSince)
Delete a global mediation policy
This operation can be used to delete an existing global mediation policy providing the Id of the mediation policy.
|
ApiResponse<MediationDTO> |
MediationPolicyIndividualApi.policiesMediationMediationPolicyIdGetWithHttpInfo(String mediationPolicyId,
String accept,
String ifNoneMatch,
String ifModifiedSince)
Get a global mediation policy
This operation can be used to retrieve a particular global mediation policy.
|
ApiResponse<MediationDTO> |
MediationPolicyIndividualApi.policiesMediationMediationPolicyIdPutWithHttpInfo(String mediationPolicyId,
MediationDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Update a global mediation policy
This operation can be used to update an existing global mediation policy.
|
ApiResponse<MediationDTO> |
MediationPolicyCollectionApi.policiesMediationPostWithHttpInfo(MediationDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Add a global mediation policy
This operation can be used to add a new global mediation policy.
|
ApiResponse<SettingsDTO> |
SettingsApi.settingsGetWithHttpInfo()
Retreive admin settings
Retreive admin settings
|
ApiResponse<BotDetectionAlertSubscriptionDTO> |
BotDetectionAlertSubscriptionsApi.subscribeForBotDetectionAlertsWithHttpInfo(BotDetectionAlertSubscriptionDTO body)
Subscribe for bot detection alerts
Register a subscription for bot detection alerts
|
ApiResponse<AlertsSubscriptionDTO> |
AlertSubscriptionsApi.subscribeToAlertsWithHttpInfo(AlertsSubscriptionDTO body)
Subscribe to an admin alert.
|
ApiResponse<ScopeListDTO> |
SystemScopesApi.systemScopesGetWithHttpInfo()
Get the list of role scope mapping.
|
ApiResponse<ScopeSettingsDTO> |
SyatemScopesApi.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
|
ApiResponse<Void> |
DefaultApi.tenantThemeImportPostWithHttpInfo(File file)
Import a DevPortal Tenant Theme
This operation can be used to import a DevPortal tenant theme.
|
ApiResponse<Void> |
BlacklistIndividualApi.throttlingBlacklistConditionIdDeleteWithHttpInfo(String conditionId,
String ifMatch,
String ifUnmodifiedSince)
Delete a Blocking condition
Deletes an existing Blocking condition
|
ApiResponse<BlockingConditionDTO> |
BlacklistIndividualApi.throttlingBlacklistConditionIdGetWithHttpInfo(String conditionId,
String ifNoneMatch,
String ifModifiedSince)
Get a Blocking Condition
Retrieves a Blocking Condition providing the condition Id
|
ApiResponse<BlockingConditionDTO> |
BlacklistIndividualApi.throttlingBlacklistConditionIdPatchWithHttpInfo(String conditionId,
BlockingConditionStatusDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Update a blocking condition
Update a blocking condition by Id
|
ApiResponse<BlockingConditionListDTO> |
BlacklistCollectionApi.throttlingBlacklistGetWithHttpInfo(String accept,
String ifNoneMatch,
String ifModifiedSince)
Get all blocking condtions
Retrieves all existing blocking condtions.
|
ApiResponse<BlockingConditionDTO> |
BlacklistCollectionApi.throttlingBlacklistPostWithHttpInfo(BlockingConditionDTO body,
String contentType)
Add a Blocking condition
Adds a new Blocking condition.
|
ApiResponse<AdvancedThrottlePolicyListDTO> |
AdvancedPolicyCollectionApi.throttlingPoliciesAdvancedGetWithHttpInfo(String accept,
String ifNoneMatch,
String ifModifiedSince)
Get all Advanced throttling policies.
|
ApiResponse<Void> |
AdvancedPolicyIndividualApi.throttlingPoliciesAdvancedPolicyIdDeleteWithHttpInfo(String policyId,
String ifMatch,
String ifUnmodifiedSince)
Delete an Advanced Throttling Policy
Deletes an Advanced level throttling policy.
|
ApiResponse<AdvancedThrottlePolicyDTO> |
AdvancedPolicyIndividualApi.throttlingPoliciesAdvancedPolicyIdGetWithHttpInfo(String policyId,
String ifNoneMatch,
String ifModifiedSince)
Get an Advanced Policy
Retrieves an Advanced Policy.
|
ApiResponse<AdvancedThrottlePolicyDTO> |
AdvancedPolicyIndividualApi.throttlingPoliciesAdvancedPolicyIdPutWithHttpInfo(String policyId,
AdvancedThrottlePolicyDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Update an Advanced Throttling Policy
Updates an existing Advanced level throttling policy.
|
ApiResponse<AdvancedThrottlePolicyDTO> |
AdvancedPolicyCollectionApi.throttlingPoliciesAdvancedPostWithHttpInfo(AdvancedThrottlePolicyDTO body,
String contentType)
Add an Advanced Throttling Policy
Add a new Advanced level throttling policy.
|
ApiResponse<ApplicationThrottlePolicyListDTO> |
ApplicationPolicyCollectionApi.throttlingPoliciesApplicationGetWithHttpInfo(String accept,
String ifNoneMatch,
String ifModifiedSince)
Get all Application Throttling Policies
Retrieves all existing application throttling policies.
|
ApiResponse<Void> |
ApplicationPolicyIndividualApi.throttlingPoliciesApplicationPolicyIdDeleteWithHttpInfo(String policyId,
String ifMatch,
String ifUnmodifiedSince)
Delete an Application Throttling policy
Deletes an Application level throttling policy.
|
ApiResponse<ApplicationThrottlePolicyDTO> |
ApplicationPolicyIndividualApi.throttlingPoliciesApplicationPolicyIdGetWithHttpInfo(String policyId,
String ifNoneMatch,
String ifModifiedSince)
Get an Application Policy
Retrieves an Application Policy.
|
ApiResponse<ApplicationThrottlePolicyDTO> |
ApplicationPolicyIndividualApi.throttlingPoliciesApplicationPolicyIdPutWithHttpInfo(String policyId,
ApplicationThrottlePolicyDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Update an Application Throttling policy
Updates an existing Application level throttling policy.
|
ApiResponse<ApplicationThrottlePolicyDTO> |
ApplicationPolicyCollectionApi.throttlingPoliciesApplicationPostWithHttpInfo(ApplicationThrottlePolicyDTO body,
String contentType)
Add an Application Throttling Policy
This operation can be used to add a new application level throttling policy.
|
ApiResponse<CustomRuleListDTO> |
CustomRulesCollectionApi.throttlingPoliciesCustomGetWithHttpInfo(String accept,
String ifNoneMatch,
String ifModifiedSince)
Get all Custom Rules
Retrieves all Custom Rules.
|
ApiResponse<CustomRuleDTO> |
CustomRulesCollectionApi.throttlingPoliciesCustomPostWithHttpInfo(CustomRuleDTO body,
String contentType)
Add a Custom Rule
Adds a new Custom Rule.
|
ApiResponse<Void> |
CustomRulesIndividualApi.throttlingPoliciesCustomRuleIdDeleteWithHttpInfo(String ruleId,
String ifMatch,
String ifUnmodifiedSince)
Delete a Custom Rule
Delete a Custom Rule.
|
ApiResponse<CustomRuleDTO> |
CustomRulesIndividualApi.throttlingPoliciesCustomRuleIdGetWithHttpInfo(String ruleId,
String ifNoneMatch,
String ifModifiedSince)
Get a Custom Rule
Retrieves a Custom Rule.
|
ApiResponse<CustomRuleDTO> |
CustomRulesIndividualApi.throttlingPoliciesCustomRuleIdPutWithHttpInfo(String ruleId,
CustomRuleDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Update a Custom Rule
Updates an existing Custom Rule.
|
ApiResponse<SubscriptionThrottlePolicyListDTO> |
SubscriptionPolicyCollectionApi.throttlingPoliciesSubscriptionGetWithHttpInfo(String accept,
String ifNoneMatch,
String ifModifiedSince)
Get all Subscription Throttling Policies
This operation can be used to retrieve all Subscription level throttling policies.
|
ApiResponse<Void> |
SubscriptionPolicyIndividualApi.throttlingPoliciesSubscriptionPolicyIdDeleteWithHttpInfo(String policyId,
String ifMatch,
String ifUnmodifiedSince)
Delete a Subscription Policy
This operation can be used to delete a subscription-level throttling policy specifying the Id of the policy as a path paramter.
|
ApiResponse<SubscriptionThrottlePolicyDTO> |
SubscriptionPolicyIndividualApi.throttlingPoliciesSubscriptionPolicyIdGetWithHttpInfo(String policyId,
String ifNoneMatch,
String ifModifiedSince)
Get a Subscription Policy
Retrieve a single subscription-level throttling policy.
|
ApiResponse<SubscriptionThrottlePolicyDTO> |
SubscriptionPolicyIndividualApi.throttlingPoliciesSubscriptionPolicyIdPutWithHttpInfo(String policyId,
SubscriptionThrottlePolicyDTO body,
String contentType,
String ifMatch,
String ifUnmodifiedSince)
Update a Subscription Policy
Updates an existing subscription-level throttling policy.
|
ApiResponse<SubscriptionThrottlePolicyDTO> |
SubscriptionPolicyCollectionApi.throttlingPoliciesSubscriptionPostWithHttpInfo(SubscriptionThrottlePolicyDTO body,
String contentType)
Add a Subscription Throttling Policy
This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.
|
ApiResponse<Void> |
AlertSubscriptionsApi.unsubscribeAllAlertsWithHttpInfo()
Unsubscribe user from all the admin alert types.
|
ApiResponse<Void> |
BotDetectionAlertSubscriptionsApi.unsubscribeFromBotDetectionAlertsWithHttpInfo(String uuid)
Unsubscribe from bot detection alerts.
|
ApiResponse<WorkflowInfoDTO> |
WorkflowsIndividualApi.workflowsExternalWorkflowRefGetWithHttpInfo(String externalWorkflowRef,
String ifNoneMatch)
Get details of a the pending workflow request according to the External Workflow Reference.
|
ApiResponse<WorkflowListDTO> |
WorkflowCollectionApi.workflowsGetWithHttpInfo(Integer limit,
Integer offset,
String accept,
String ifNoneMatch,
String workflowType)
Retrieve All pending workflow processes
This operation can be used to retrieve list of workflow pending processes.
|
ApiResponse<WorkflowDTO> |
WorkflowsIndividualApi.workflowsUpdateWorkflowStatusPostWithHttpInfo(String workflowReferenceId,
WorkflowDTO body)
Update workflow status
This operation can be used to approve or reject a workflow task.
|
Copyright © 2020 WSO2 Inc. All rights reserved.