This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
API Permissions
The following table lists out all the available APIs and their operations and specifies the permissions of each operation.Â
Service | Operation | Permission Level |
---|---|---|
IdentityProviderMgtService | addIdP | /permission/admin/manage |
deleteIdP | /permission/admin/manage | |
getAllFederatedAuthenticators | /permission/admin/manage | |
getAllIdPs | /permission/admin/login | |
getAllLocalClaimUris | /permission/admin/manage | |
getAllProvisioningConnectors | /permission/admin/manage | |
getEnabledAllIdPs | /permission/admin/manage | |
getIdPByName | /permission/admin/manage | |
getResidentIdP | /permission/admin/manage | |
updateIdP | /permission/admin/manage | |
updateResidentIdP | /permission/admin/manage | |
Generic-Operations | /permission/admin/manage | |
IdentityApplicationManagementService | createApplication | /permission/admin/manage |
deleteApplication | /permission/admin/manage | |
getAllApplicationBasicInfo | /permission/admin/manage | |
getAllIdentityProviders | /permission/admin/login | |
getAllLocalAuthenticators | /permission/admin/manage | |
getAllLocalClaimUris | /permission/admin/manage | |
getAllRequestPathAuthenticators | /permission/admin/manage | |
getApplication | /permission/admin/manage | |
getIdentityProvider | /permission/admin/manage | |
updateApplication | /permission/admin/manage | |
TenantMgtAdminService | activateTenant | /permission/protected/manage/modify/tenants |
addSkeletonTenant | /permission/protected/manage/monitor/tenants | |
addTenant | /permission/protected/manage/monitor/tenants | |
deactivateTenant | /permission/protected/manage/modify/tenants | |
deleteTenant | /permission/protected/manage/modify/tenants | |
getTenant | /permission/protected/manage/monitor/tenants | |
retrievePaginatedPartialSearchTenants | /permission/protected/manage/monitor/tenants | |
retrievePaginatedTenants | /permission/protected/manage/monitor/tenants | |
retrievePartialSearchTenants | /permission/protected/manage/monitor/tenants | |
retrieveTenants | /permission/protected/manage/monitor/tenants | |
updateTenant | /permission/protected/manage/modify/tenants | |
UserStoreConfigAdminService | addUserStore | /permission/admin/manage |
changeUserStoreState | /permission/admin/manage | |
deleteUserStore | /permission/admin/manage | |
deleteUserStoresSet | /permission/admin/manage | |
editUserStore | /permission/admin/manage | |
editUserStoreWithDomainName | /permission/admin/manage | |
getAvailableUserStoreClasses | /permission/admin/manage | |
getSecondaryRealmConfigurations | /permission/admin/manage | |
getUserStoreManagerProperties | /permission/admin/manage | |
testRDBMSConnection | /permission/admin/manage | |
OAuthAdminService | getAllOAuthApplicationData | /permission/admin/manage |
getAllowedGrantTypes | /permission/admin/manage | |
getAppsAuthorizedByUser | /permission/admin/login | |
getOAuthApplicationData | /permission/admin/manage | |
getOAuthApplicationDataByAppName | /permission/admin/manage | |
getOauthApplicationState | /permission/admin/manage | |
isPKCESupportEnabled | /permission/admin/manage | |
registerOAuthApplicationData | /permission/admin/manage | |
registerOAuthConsumer | /permission/admin/manage | |
removeOAuthApplicationData | /permission/admin/manage | |
revokeAuthzForAppsByResoureOwner | /permission/admin/manage | |
updateApproveAlwaysForAppConsentByResourceOwner | /permission/admin/login | |
updateConsumerApplication | /permission/admin/manage | |
updateConsumerAppState | /permission/admin/manage | |
updateOauthSecretKey | /permission/admin/manage | |
OAuth2TokenValidationService | buildIntrospectionResponse | /permission/admin/manage |
findOAuthConsumerIfTokenIsValid | /permission/admin/manage | |
validate | /permission/admin/manage | |
ClaimManagementService | addNewClaimDialect | /permission/admin/manage |
addNewClaimMapping | /permission/admin/manage | |
getClaimMappingByDialect | /permission/admin/manage | |
getClaimMappings | /permission/admin/manage | |
removeClaimDialect | /permission/admin/manage | |
removeClaimMapping | /permission/admin/manage | |
upateClaimMapping | /permission/admin/manage | |
RemoteUserStoreManagerService | addRole | /permission/admin/configure/security |
addUser | /permission/admin/configure/security | |
addUserClaimValue | /permission/admin/configure/security | |
addUserClaimValues | /permission/admin/configure/security | |
authenticate | /permission/admin/configure/security | |
deleteRole | /permission/admin/configure/security | |
deleteUser | /permission/admin/configure/security | |
deleteUserClaimValue | /permission/admin/configure/security | |
deleteUserClaimValues | /permission/admin/configure/security | |
getAllProfileNames | /permission/admin/configure/security | |
getHybridRoles | /permission/admin/configure/security | |
getPasswordExpirationTime | /permission/admin/configure/security | |
getProfileNames | /permission/admin/configure/security | |
getProperties | /permission/admin/configure/security | |
getRoleListOfUser | /permission/admin/configure/security | |
getRoleNames | /permission/admin/configure/security | |
getTenantId | /permission/admin/configure/security | |
getTenantIdofUser | /permission/admin/configure/security | |
getUserClaimValue | /permission/admin/configure/security | |
getUserClaimValues | /permission/admin/configure/security | |
getUserClaimValuesForClaims | /permission/admin/configure/security | |
getUserId | /permission/admin/configure/security | |
getUserList | /permission/admin/configure/security | |
getUserListOfRole | /permission/admin/configure/security | |
isExistingRole | /permission/admin/configure/security | |
isExistingUser | /permission/admin/configure/security | |
isReadOnly | /permission/admin/configure/security | |
listUsers | /permission/admin/configure/security | |
setUserClaimValue | /permission/admin/configure/security | |
setUserClaimValues | /permission/admin/configure/security | |
updateCredential | /permission/admin/configure/security | |
updateCredentialByAdmin | /permission/admin/configure/security | |
updateRoleListOfUser | /permission/admin/configure/security | |
updateRoleName | /permission/admin/configure/security | |
updateUserListOfRole | /permission/admin/configure/security | |
RemoteAuthorizationManagerService | authorizeRole | /permission/admin/configure/security |
authorizeUser | /permission/admin/configure/security | |
clearAllRoleAuthorization | /permission/admin/configure/security | |
clearAllUserAuthorization | /permission/admin/configure/security | |
clearResourceAuthorizations | /permission/admin/configure/security | |
clearRoleActionOnAllResources | /permission/admin/configure/security | |
clearRoleAuthorization | /permission/admin/configure/security | |
clearUserAuthorization | /permission/admin/configure/security | |
denyRole | /permission/admin/configure/security | |
denyUser | /permission/admin/configure/security | |
getAllowedRolesForResource | /permission/admin/configure/security | |
getAllowedUIResourcesForUser | /permission/admin/configure/security | |
getDeniedRolesForResource | /permission/admin/configure/security | |
getExplicitlyAllowedUsersForResource | /permission/admin/configure/security | |
getExplicitlyDeniedUsersForResource | /permission/admin/configure/security | |
isRoleAuthorized | /permission/admin/configure/security | |
isUserAuthorized | /permission/admin/configure/security | |
resetPermissionOnUpdateRole | /permission/admin/configure/security | |
RemoteProfileConfigurationManagerService | addProfileConfig | /permission/admin/configure/security |
deleteProfileConfig | /permission/admin/configure/security | |
getAllProfiles | /permission/admin/configure/security | |
getProfileConfig | /permission/admin/configure/security | |
updateProfileConfig | /permission/admin/configure/security | |
RemoteClaimManagerService | addNewClaimMapping | /permission/admin/configure/security |
deleteClaimMapping | /permission/admin/configure/security | |
getAllClaimMappings | /permission/admin/configure/security | |
getAllClaimUris | /permission/admin/configure/security | |
getAllRequiredClaimMappings | /permission/admin/configure/security | |
getAllSupportClaimMappingsByDefault | /permission/admin/configure/security | |
getAttributeName | /permission/admin/configure/security | |
getAttributeNameFromDomain | /permission/admin/configure/security | |
getClaim | /permission/admin/configure/security | |
getClaimMapping | /permission/admin/configure/security | |
updateClaimMapping | /permission/admin/configure/security | |
RemoteUserRealmService | getRealmConfiguration | /permission/protected/tenant-admin |
RemoteTenantManagerService | activateTenant | /permission/protected/tenant-admin |
addTenant | /permission/protected/tenant-admin | |
deactivateTenant | /permission/protected/tenant-admin | |
deleteTenant | /permission/protected/tenant-admin | |
getAllTenants | /permission/protected/tenant-admin | |
getDomain | /permission/protected/tenant-admin | |
getSuperTenantDomain | /permission/protected/tenant-admin | |
getTenant | /permission/protected/tenant-admin | |
getTenantId | /permission/protected/tenant-admin | |
isTenantActive | /permission/protected/tenant-admin | |
updateTenant | /permission/protected/tenant-admin | |
UserIdentityManagementAdminService | changeUserPassword | /permission/admin/manage |
enableUserAccount | /permission/admin/manage | |
deleteUser | /permission/admin/manage | |
disableUserAccount | /permission/admin/manage | |
getAllChallengeQuestions | /permission/admin/manage | |
getAllPromotedUserChallenge | /permission/admin/manage | |
getAllUserIdentityClaims | /permission/admin/manage | |
getChallengeQuestionsOfUser | /permission/admin/manage | |
isReadOnlyUserStore | /permission/admin/manage | |
lockUserAccount | /permission/admin/manage | |
resetUserPassword | /permission/admin/manage | |
setChallengeQuestions | /permission/admin/manage | |
setChallengeQuestionsOfUser | /permission/admin/manage | |
unlockUserAccount | /permission/admin/manage | |
updateUserIdentityClaims | /permission/admin/manage | |
AccountCredentialMgtConfigService | getEmailConfig | /permission/admin/login |
saveEmailConfig | /permission/admin/login | |
UserInformationRecoveryService | confirmUserSelfRegistration | /permission/admin/login |
getAllChallengeQuestions | /permission/admin/login | |
getCaptcha | /permission/admin/login | |
getUserChallengeQuestion | /permission/admin/login | |
getUserChallengeQuestionIds | /permission/admin/login | |
getUserIdentitySupportedClaims | /permission/admin/login | |
registerUser | /permission/admin/login | |
sendRecoveryNotification | /permission/admin/login | |
updatePassword | /permission/admin/login | |
verifyAccount | /permission/admin/login | |
verifyConfirmationCode | /permission/admin/login | |
verifyUser | /permission/admin/login | |
verifyUserChallengeAnswer | /permission/admin/login | |
EntitlementAdminService | clearAllAttributeCaches | /permission/admin/manage |
clearAllResourceCaches | /permission/admin/manage | |
clearAttributeFinderCache | /permission/admin/manage | |
clearAttributeFinderCacheByAttributes | /permission/admin/manage | |
clearCarbonAttributeCache | /permission/admin/manage | |
clearCarbonResourceCache | /permission/admin/manage | |
clearDecisionCache | /permission/admin/manage | |
clearPolicyCache | /permission/admin/manage | |
clearResourceFinderCache | /permission/admin/manage | |
doTestRequest | /permission/admin/manage | |
doTestRequestForGivenPolicies | /permission/admin/manage | |
getGlobalPolicyAlgorithm | /permission/admin/manage | |
getPDPData | /permission/admin/manage | |
getPIPAttributeFinderData | /permission/admin/manage | |
getPIPResourceFinderData | /permission/admin/manage | |
getPolicyFinderData | /permission/admin/manage | |
refreshAttributeFinder | /permission/admin/manage | |
refreshPolicyFinders | /permission/admin/manage | |
refreshResourceFinder | /permission/admin/manage | |
setGlobalPolicyAlgorithm | /permission/admin/manage | |
EntitlementPolicyAdminService | addPolicies | /permission/admin/manage |
addPolicy | /permission/admin/manage | |
addSubscriber | /permission/admin/manage | |
deleteSubscriber | /permission/admin/manage | |
dePromotePolicy | /permission/admin/manage | |
enableDisablePolicy | /permission/admin/manage | |
getAllPolicies | /permission/admin/manage | |
getAllPolicyIds | /permission/admin/manage | |
getEntitlementData | /permission/admin/manage | |
getEntitlementDataModules | /permission/admin/manage | |
getLightPolicy | /permission/admin/manage | |
getPolicy | /permission/admin/manage | |
getPolicyByVersion | /permission/admin/manage | |
getPolicyVersions | /permission/admin/manage | |
getPublisherModuleData | /permission/admin/manage | |
getStatusData | /permission/admin/manage | |
getSubscriber | /permission/admin/manage | |
getSubscriberIds | /permission/admin/manage | |
importPolicyFromRegistry | /permission/admin/manage | |
orderPolicy | /permission/admin/manage | |
publish | /permission/admin/manage | |
publishPolicies | /permission/admin/manage | |
publishToPDP | /permission/admin/manage | |
removePolicies | /permission/admin/manage | |
removePolicy | /permission/admin/manage | |
rollBackPolicy | /permission/admin/manage | |
updatePolicy | /permission/admin/manage | |
updateSubscriber | /permission/admin/manage | |
EntitlementService | getAllEntitlements | /permission/admin/manage |
getBooleanDecision | /permission/admin/manage | |
getDecision | /permission/admin/manage | |
getDecisionByAttributes | /permission/admin/manage | |
getEntitledAttributes | /permission/admin/manage | |
XACMLAuthzDecisionQuery | /permission/admin/manage | |
ws-xacml | XACMLAuthzDecisionQuery | /permission/admin/manage |
UserProfileMgtService | associateID | /permission/admin/login |
deleteUserProfile | /permission/admin/manage | |
getAssociatedIDs | /permission/admin/login | |
getInstance | /permission/admin/login | |
getNameAssociatedWith | /permission/admin/manage | |
getProfileFieldsForInternalStore | /permission/admin/login | |
getUserProfile | /permission/admin/login | |
getUserProfiles | /permission/admin/manage | |
isAddProfileEnabled | /permission/admin/manage | |
isAddProfileEnabledForDomain | /permission/admin/manage | |
isReadOnlyUserStore | /permission/admin/manage | |
removeAssociateID | /permission/admin/manage | |
setUserProfile | /permission/admin/login | |
UserAdmin | addInternalRole | /permission/admin/configure/security |
addRemoveRolesOfUser | /permission/admin/configure/security | |
addRemoveUsersOfRole | /permission/admin/configure/security | |
addRole | /permission/admin/configure/security | |
addUser | /permission/admin/manage | |
bulkImportUsers | /permission/admin/configure/security | |
changePassword | /permission/admin/manage | |
changePasswordByUser | /permission/admin/login | |
deleteRole | /permission/admin/configure/security | |
deleteUser | /permission/admin/manage | |
getAllRolesNames | /permission/admin/manage | |
getAllSharedRoleNames | /permission/admin/configure/security | |
getAllUIPermissions | /permission/admin/configure/security | |
getRolePermissions | /permission/admin/configure/security | |
getRolesOfCurrentUser | /permission/admin/manage | |
getRolesOfUser | /permission/admin/configure/security | |
getUserRealmInfo | /permission/admin/manage | |
getUsersOfRole | /permission/admin/manage | |
hasMultipleUserStores | /permission/admin/manage | |
isSharedRolesEnabled | /permission/admin/configure/security | |
listAllUsers | /permission/admin/manage | |
listUserByClaim | /permission/admin/configure/security | |
listUsers | /permission/admin/manage | |
setRoleUIPermission | /permission/admin/configure/security | |
updateRoleName | /permission/admin/configure/security | |
updateRolesOfUser | /permission/admin/configure/security | |
updateUsersOfRole | /permission/admin/manage | |
MultipleCredentialsUserAdmin | addCredential | /permission/admin/manage |
addUser | /permission/admin/manage | |
addUsers | /permission/admin/manage | |
addUserWithUserId | /permission/admin/manage | |
authenticate | /permission/admin/manage | |
deleteCredential | /permission/admin/manage | |
deleteUser | /permission/admin/manage | |
deleteUserClaimValue | /permission/admin/manage | |
deleteUserClaimValues | /permission/admin/manage | |
getAllUserClaimValues | /permission/admin/manage | |
getCredentials | /permission/admin/manage | |
getUserClaimValue | /permission/admin/manage | |
getUserClaimValues | /permission/admin/manage | |
getUserId | /permission/admin/manage | |
setUserClaimValue | /permission/admin/manage | |
setUserClaimValues | /permission/admin/manage | |
updateCredential | /permission/admin/manage | |
IdentityProviderAdminService | addOpenID | /permission/admin/login |
extractPrimaryUserName | /permission/admin/login | |
getAllOpenIDs | /permission/admin/login | |
getPrimaryOpenID | /permission/admin/login | |
removeOpenID | /permission/admin/login | |
XMPPConfigurationService | addUserXmppSettings | /permission/admin/login |
editXmppSettings | /permission/admin/login | |
getUserIM | /permission/admin/login | |
getXmppSettings | /permission/admin/login | |
hasXMPPSettings | /permission/admin/login | |
isXMPPSettingsEnabled | /permission/admin/login | |
IdentitySAMLSSOConfigService | addRPServiceProvider | /permission/admin/manage |
getCertAliasOfPrimaryKeyStore | /permission/admin/manage | |
getClaimURIs | /permission/admin/manage | |
getServiceProviders | /permission/admin/manage | |
removeServiceProvider | /permission/admin/manage | |
IdentitySTSAdminService | readCardIssuerConfiguration | /permission/admin/manage |
updateCardIssueConfiguration | /permission/admin/manage | |
IWAAuthenticator | canHandle | /permission/admin/login |
login | /permission/admin/login | |
ProvisioningAdminService | getAllInstalledFeatures | /permission/protected/configure/components |
getInstalledFeatureInfo | /permission/protected/configure/components | |
getInstalledFeaturesWithProperty | /permission/protected/configure/components | |
getLicensingInformation | /permission/protected/configure/components | |
getProfileHistory | /permission/protected/configure/components | |
performProvisioningAction | /permission/protected/configure/components | |
removeAllConsoleFeatures | /permission/protected/configure/components | |
removeAllServerFeatures | /permission/protected/configure/components | |
reviewProvisioningAction | /permission/protected/configure/components | |
ProfilesAdminService | getUserProfile | /permission/admin/manage/modify/user-profile |
putUserProfile | /permission/admin/manage/modify/user-profile | |
SecurityAdminService | activateUsernameTokenAuthentication | /permission/admin/manage/modify/service |
applyKerberosSecurityPolicy | /permission/admin/manage/modify/service | |
applySecurity | /permission/admin/manage/modify/service | |
disableSecurityOnService | /permission/admin/manage/modify/service | |
getScenarios | /permission/admin/manage/modify/service | |
getSecurityConfigData | /permission/admin/manage/modify/service | |
getSecurityScenario | /permission/admin/manage/modify/service | |
STSAdminService | addTrustedService | /permission/admin/manage |
getCertAliasOfPrimaryKeyStore | /permission/admin/manage | |
getProofKeyType | /permission/admin/manage | |
getTrustedServices | /permission/admin/manage | |
removeTrustedService | /permission/admin/manage | |
setProofKeyType | /permission/admin/manage | |
KeyStoreAdminService | addKeyStore | /permission/admin/manage |
addTrustStore | /permission/admin/manage | |
deleteStore | /permission/admin/manage | |
getKeystoreInfo | /permission/admin/manage | |
getKeyStores | /permission/admin/manage | |
getPaginatedKeystoreInfo | /permission/admin/manage | |
getStoreEntries | /permission/admin/manage | |
importCertToStore | /permission/admin/manage | |
removeCertFromStore | /permission/admin/manage | |
SCIMConfigAdminService | addGlobalProvider | /permission/admin/configure/security |
addUserProvider | /permission/admin/configure/security/usermgt/provisioning | |
deleteGlobalProvider | /permission/admin/configure/security | |
deleteUserProvider | /permission/admin/configure/security/usermgt/provisioning | |
getAllGlobalProviders | /permission/admin/configure/security | |
getAllUserProviders | /permission/admin/configure/security/usermgt/provisioning | |
getGlobalProvider | /permission/admin/configure/security | |
getUserProvider | /permission/admin/configure/security/usermgt/provisioning | |
updateGlobalProvider | /permission/admin/configure/security | |
updateUserProvider | /permission/admin/configure/security/usermgt/provisioning | |
DirectoryServerManager | addServer | /permission/admin/configure/security,/permission/admin/manage/modify/service |
changePassword | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
getPasswordConformanceRegularExpression | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
getServiceNameConformanceRegularExpression | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
isExistingServicePrinciple | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
isKDCEnabled | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
listServicePrinciples | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
removeServer | /permission/admin/configure/security,/permission/admin/manage/modify/service | |
LoggedUserInfoAdmin | getUserInfo | /permission/admin/login |
LoggingAdmin | getAllLoggerData | /permission/protected/configure/logging |
getAppenderData | /permission/protected/configure/logging | |
getLoggerData | /permission/protected/configure/logging | |
getSyslogData | /permission/protected/configure/logging | |
getSystemLog | /permission/protected/configure/logging | |
isStratosService | /permission/protected/configure/logging | |
removeSyslogPattern | /permission/protected/configure/logging | |
restoreDefaults | /permission/protected/configure/logging | |
updateAllAppenderData | /permission/protected/configure/logging | |
updateLoggerData | /permission/protected/configure/logging | |
updateSyslogConfig | /permission/protected/configure/logging | |
updateSystemLog | /permission/protected/configure/logging | |
LoginStatisticsAdmin | getLoginAttempts | Not available |
getUserBasedLoginAttempts | Not available | |
WorkflowAdminService | getWorkflow | /permission/admin/manage/identity/workflow/definition/view |
listWorkflowEvents | /permission/admin/manage/identity/workflow/association/view | |
listTemplates | /permission/admin/manage/identity/workflow/definition/view | |
getTemplate | /permission/admin/manage/identity/workflow/definition/view | |
getWorkflowImpl | /permission/admin/manage/identity/workflow/definition/view | |
listWorkflowImpls | /permission/admin/manage/identity/workflow/definition/view | |
addWorkflow | /permission/admin/manage/identity/workflow/definition/create | |
addAssociation | /permission/admin/manage/identity/workflow/association/create | |
changeAssociationState | /permission/admin/manage/identity/workflow/association/update | |
listWorkflows | /permission/admin/manage/identity/workflow/definition/view | |
removeWorkflow | /permission/admin/manage/identity/workflow/definition/delete | |
removeAssociation | /permission/admin/manage/identity/workflow/association/delete | |
listAssociations | /permission/admin/manage/identity/workflow/association/view | |
listAllAssociations | /permission/admin/manage/identity/workflow/association/view | |
getEvent | /permission/admin/manage/identity/workflow/association/view | |
getRequestsCreatedByUser | /permission/admin/manage/identity/workflow/monitor/view | |
getRequestsInFilter | /permission/admin/manage/identity/workflow/monitor/view | |
deleteWorkflowRequest | /permission/admin/manage/identity/workflow/monitor/delete | |
getWorkflowsOfRequest | /permission/admin/manage/identity/workflow/monitor/view | |
WorkflowImplAdminService | addBPSProfile | /permission/admin/manage/identity/workflow/profile/create |
listBPSProfiles | /permission/admin/manage/identity/workflow/profile/view | |
getBPSProfile | /permission/admin/manage/identity/workflow/profile/view | |
updateBPSProfile | /permission/admin/manage/identity/workflow/profile/update | |
removeBPSProfile | /permission/admin/manage/identity/workflow/profile/delete | |
removeBPSPackage | /permission/admin/manage/identity/workflow/profile/delete |