Security Admin Web Application

- - - - - - -

- The resources use a data model that is supported by a set of client-side libraries that are made available on the - files and libraries page. -

- -

- There is a WADL document available that describes the resources API. -

- -

- You may also enjoy the interactive interface provided for this API by Swagger. -

- Try it out! -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name	path	methods	description
AssetREST -	`/assets/accessAudit -` `/assets/assets -` `/assets/credstores -` `/assets/exportAudit -` `/assets/report -` `/assets/resources -` `/assets/assets/count -` `/assets/assets/testConfig -` `/assets/assets/{id} -` `/assets/credstores/count -` `/assets/credstores/{id} -` `/assets/policyList/{repository} -` `/assets/report/{transactionId} -` `/assets/resource/{id} -` `/assets/resources/count -` `/assets/resources/grant -` `/assets/resources/revoke -` `/assets/resources/{id} -`	`GET -` `GET POST -` `GET POST PUT -` `GET -` `GET -` `GET POST -` `GET -` `POST -` `DELETE GET PUT -` `GET -` `DELETE GET -` `GET -` `GET -` `GET -` `GET -` `POST -` `POST -` `DELETE GET PUT -`	-
PublicAPIs -	`/public/api/policy -` `/public/api/repository -` `/public/api/policy/count -` `/public/api/policy/{id} -` `/public/api/repository/count -` `/public/api/repository/{id} -`	`GET POST -` `GET POST -` `GET -` `DELETE GET PUT -` `GET -` `DELETE GET PUT -`	-
PublicAPIsv2 -	`/public/v2/api/policy -` `/public/v2/api/service -` `/public/v2/api/servicedef -` `/public/v2/api/plugins/info -` `/public/v2/api/policy/apply -` `/public/v2/api/policy/{id} -` `/public/v2/api/service/{id} -` `/public/v2/api/servicedef/{id} -` `/public/v2/api/policies/{serviceDefName}/for-resource -` `/public/v2/api/service/name/{name} -` `/public/v2/api/service/{servicename}/policy -` `/public/v2/api/servicedef/name/{name} -` `/public/v2/api/service/{servicename}/policy/{policyname} -`	`DELETE GET POST -` `GET POST -` `GET POST -` `GET -` `POST -` `DELETE GET PUT -` `DELETE GET PUT -` `DELETE GET PUT -` `GET -` `DELETE GET PUT -` `GET -` `DELETE GET PUT -` `GET PUT -`	-
ServiceREST -	`/plugins/checksso -` `/plugins/csrfconf -` `/plugins/definitions -` `/plugins/policies -` `/plugins/services -` `/plugins/definitions/{id} -` `/plugins/plugins/info -` `/plugins/policies/apply -` `/plugins/policies/count -` `/plugins/policies/csv -` `/plugins/policies/downloadExcel -` `/plugins/policies/eventTime -` `/plugins/policies/exportJson -` `/plugins/policies/importPoliciesFromFile -` `/plugins/policies/{id} -` `/plugins/services/count -` `/plugins/services/validateConfig -` `/plugins/services/{id} -` `/plugins/definitions/name/{name} -` `/plugins/policies/download/{serviceName} -` `/plugins/policies/service/{id} -` `/plugins/policies/{serviceDefName}/for-resource -` `/plugins/policy/{policyId}/versionList -` `/plugins/services/grant/{serviceName} -` `/plugins/services/lookupResource/{serviceName} -` `/plugins/services/name/{name} -` `/plugins/services/revoke/{serviceName} -` `/plugins/policies/service/name/{name} -` `/plugins/policy/{policyId}/version/{versionNo} -` `/plugins/secure/policies/download/{serviceName} -` `/plugins/secure/services/grant/{serviceName} -` `/plugins/secure/services/revoke/{serviceName} -`	`GET -` `GET -` `GET POST -` `GET POST -` `GET POST -` `DELETE GET PUT -` `GET -` `POST -` `GET -` `GET -` `GET -` `GET -` `GET -` `POST -` `DELETE GET PUT -` `GET -` `POST -` `DELETE GET PUT -` `GET -` `GET -` `GET -` `GET -` `GET -` `POST -` `POST -` `GET -` `POST -` `GET -` `GET -` `GET -` `POST -` `POST -`	-
TagREST -	`/tags/importservicetags -` `/tags/resources -` `/tags/tagdefs -` `/tags/tagresourcemaps -` `/tags/tags -` `/tags/types -` `/tags/download/{serviceName} -` `/tags/resource/{id} -` `/tags/tag/{id} -` `/tags/tagdef/{id} -` `/tags/tagresourcemap/tag-resource-guid -` `/tags/tagresourcemap/{id} -` `/tags/resource/guid/{guid} -` `/tags/resources/service/{serviceName} -` `/tags/secure/download/{serviceName} -` `/tags/tag/guid/{guid} -` `/tags/tagdef/guid/{guid} -` `/tags/tagdef/name/{name} -` `/tags/tagresourcemap/guid/{guid} -` `/tags/tags/type/{type} -` `/tags/resource/service/{serviceName}/signature/{resourceSignature} -`	`PUT -` `GET POST -` `GET POST -` `DELETE GET POST -` `GET POST -` `GET -` `GET -` `DELETE GET PUT -` `DELETE GET PUT -` `DELETE GET PUT -` `GET -` `DELETE GET -` `DELETE GET PUT -` `GET -` `GET -` `DELETE GET PUT -` `DELETE GET -` `GET -` `DELETE GET -` `GET -` `GET -`	-
UserREST -	`/users -` `/users/default -` `/users/firstnames -` `/users/profile -` `/users/{userId} -` `/users/{userId}/deactivate -` `/users/{userId}/emailchange -` `/users/{userId}/passwordchange -` `/users/{userId}/roles -`	`GET POST PUT -` `POST -` `GET -` `GET -` `GET -` `POST -` `POST -` `POST -` `PUT -`	-
XAuditREST -	`/xaudit/access_audit -` `/xaudit/trx_log -` `/xaudit/access_audit/count -` `/xaudit/trx_log/count -` `/xaudit/trx_log/{id} -`	`GET -` `GET POST PUT -` `GET -` `GET -` `DELETE GET -`	-
XKeyREST -	`/keys/key -` `/keys/keys -` `/keys/key/{alias} -`	`POST PUT -` `GET -` `DELETE GET -`	-
XUserREST -	`/xusers/auditmaps -` `/xusers/authSessions -` `/xusers/groupgroups -` `/xusers/groups -` `/xusers/groupusers -` `/xusers/permission -` `/xusers/permmaps -` `/xusers/users -` `/xusers/auditmaps/count -` `/xusers/auditmaps/{id} -` `/xusers/authSessions/info -` `/xusers/groupgroups/count -` `/xusers/groupgroups/{id} -` `/xusers/groups/count -` `/xusers/groups/groupinfo -` `/xusers/groups/{id} -` `/xusers/groupusers/count -` `/xusers/groupusers/{id} -` `/xusers/permission/count -` `/xusers/permission/group -` `/xusers/permission/user -` `/xusers/permission/{id} -` `/xusers/permmaps/count -` `/xusers/permmaps/{id} -` `/xusers/secure/groups -` `/xusers/secure/users -` `/xusers/users/count -` `/xusers/users/userinfo -` `/xusers/users/{id} -` `/xusers/{groupId}/users -` `/xusers/{userId}/groups -` `/xusers/groups/groupName/{groupName} -` `/xusers/groupusers/groupName/{groupName} -` `/xusers/permission/group/count -` `/xusers/permission/group/{id} -` `/xusers/permission/user/count -` `/xusers/permission/user/{id} -` `/xusers/secure/groups/delete -` `/xusers/secure/groups/visibility -` `/xusers/secure/groups/{groupName} -` `/xusers/secure/groups/{id} -` `/xusers/secure/users/activestatus -` `/xusers/secure/users/delete -` `/xusers/secure/users/visibility -` `/xusers/secure/users/{id} -` `/xusers/secure/users/{userName} -` `/xusers/users/userName/{userName} -` `/xusers/group/{groupName}/user/{userName} -` `/xusers/secure/groups/id/{groupId} -` `/xusers/secure/users/external/{userId} -` `/xusers/secure/users/id/{userId} -` `/xusers/secure/users/roles/{userId} -` `/xusers/secure/users/roles/userName/{userName} -`	`GET POST PUT -` `GET -` `GET POST PUT -` `GET POST PUT -` `GET POST PUT -` `GET POST -` `GET POST PUT -` `GET POST PUT -` `GET -` `DELETE GET -` `GET -` `GET -` `DELETE GET -` `GET -` `POST -` `DELETE GET -` `GET -` `DELETE GET -` `GET -` `GET POST -` `GET POST -` `DELETE GET PUT -` `GET -` `DELETE GET -` `POST -` `POST -` `GET -` `POST -` `DELETE GET -` `GET -` `GET -` `DELETE GET -` `GET -` `GET -` `DELETE GET PUT -` `GET -` `DELETE GET PUT -` `DELETE -` `PUT -` `DELETE -` `GET PUT -` `PUT -` `DELETE -` `PUT -` `GET PUT -` `DELETE -` `DELETE GET -` `DELETE -` `DELETE -` `GET -` `DELETE -` `PUT -` `GET PUT -`	-

- - - -

JSON

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

type	description
GrantRevokeRequest -	-
Message -	-
RESTResponse -	-
RangerAccessTypeDef -	-
RangerBaseModelObject -	-
RangerContextEnricherDef -	-
RangerDataMaskDef -	-
RangerDataMaskPolicyItem -	-
RangerDataMaskTypeDef -	-
RangerEnumDef -	-
RangerEnumElementDef -	-
RangerExportPolicyList -	-
RangerPluginInfo -	-
RangerPluginInfoList -	-
RangerPolicy -	-
RangerPolicyConditionDef -	-
RangerPolicyItem -	-
RangerPolicyItemAccess -	-
RangerPolicyItemCondition -	-
RangerPolicyItemDataMaskInfo -	-
RangerPolicyItemRowFilterInfo -	-
RangerPolicyList -	-
RangerPolicyResource -	-
RangerResourceDef -	-
RangerRowFilterDef -	-
RangerRowFilterPolicyItem -	-
RangerService -	-
RangerServiceConfigDef -	-
RangerServiceDef -	-
RangerServiceDefList -	-
RangerServiceList -	-
RangerServiceResource -	-
RangerTag -	-
RangerTagAttributeDef -	-
RangerTagDef -	-
RangerTagResourceMap -	-
ResourceLookupContext -	-
ServicePolicies -	-
ServiceTags -	-
TagPolicies -	-
VEnum -	-
VEnumElement -	-
VList -	-
VTrxLogAttr -	-
VXAccessAudit -	-
VXAccessAuditList -	-
VXAsset -	-
VXAssetList -	-
VXAuditMap -	-
VXAuditMapList -	-
VXAuditRecord -	-
VXAuditRecordList -	-
VXAuthSession -	-
VXAuthSessionList -	-
VXCredentialStore -	-
VXCredentialStoreList -	-
VXDataObject -	-
VXGroup -	-
VXGroupGroup -	-
VXGroupGroupList -	-
VXGroupList -	-
VXGroupPermission -	-
VXGroupPermissionList -	-
VXGroupUser -	-
VXGroupUserInfo -	-
VXGroupUserList -	-
VXKmsKey -	-
VXKmsKeyList -	-
VXLong -	-
VXMessage -	-
VXModuleDef -	-
VXModuleDefList -	-
VXPasswordChange -	-
VXPermMap -	-
VXPermMapList -	-
VXPermObj -	-
VXPermObjList -	-
VXPolicy -	-
VXPolicyExportAudit -	-
VXPolicyExportAuditList -	-
VXPolicyList -	-
VXPortalUser -	-
VXPortalUserList -	-
VXRepository -	-
VXRepositoryList -	-
VXResource -	-
VXResourceList -	-
VXResponse -	-
VXString -	-
VXStringList -	-
VXTrxLog -	-
VXTrxLogList -	-
VXUser -	-
VXUserGroupInfo -	-
VXUserList -	-
VXUserPermission -	-
VXUserPermissionList -	-
ViewBaseBean -	-

- -

XML

Default Namespace (schema)
type	description
RESTResponse -	-
message -	-
VEnum -	-
VEnumElement -	-
VList -	-
VTrxLogAttr -	-
viewBaseBean -	-
rangerBaseModelObject -	-
rangerPluginInfo -	-
rangerPolicy -	-
rangerDataMaskPolicyItem -	-
rangerPolicyItem -	-
rangerPolicyItemAccess -	-
rangerPolicyItemCondition -	-
rangerPolicyItemDataMaskInfo -	-
rangerPolicyItemRowFilterInfo -	-
rangerPolicyResource -	-
rangerRowFilterPolicyItem -	-
rangerService -	-
rangerServiceDef -	-
rangerAccessTypeDef -	-
rangerContextEnricherDef -	-
rangerDataMaskDef -	-
rangerDataMaskTypeDef -	-
rangerEnumDef -	-
rangerEnumElementDef -	-
rangerPolicyConditionDef -	-
rangerResourceDef -	-
rangerRowFilterDef -	-
rangerServiceConfigDef -	-
rangerServiceResource -	-
rangerTag -	-
rangerTagDef -	-
rangerTagAttributeDef -	-
rangerTagResourceMap -	-
resourceLookupContext -	-
grantRevokeRequest -	-
servicePolicies -	-
tagPolicies -	-
serviceTags -	-
rangerExportPolicyList -	-
rangerPluginInfoList -	-
rangerPolicyList -	-
rangerServiceDefList -	-
rangerServiceList -	-
VXAccessAudit -	-
VXAccessAuditList -	-
VXAsset -	-
VXAssetList -	-
VXAuditMap -	-
VXAuditMapList -	-
VXAuditRecord -	-
VXAuditRecordList -	-
VXAuthSession -	-
VXAuthSessionList -	-
VXCredentialStore -	-
VXCredentialStoreList -	-
VXDataObject -	-
VXGroup -	-
VXGroupGroup -	-
VXGroupGroupList -	-
VXGroupList -	-
VXGroupPermission -	-
VXGroupPermissionList -	-
VXGroupUser -	-
VXGroupUserInfo -	-
VXGroupUserList -	-
VXKmsKey -	-
VXKmsKeyList -	-
VXLong -	-
VXMessage -	-
VXModuleDef -	-
VXModuleDefList -	-
VXPasswordChange -	-
VXPermMap -	-
VXPermMapList -	-
VXPermObj -	-
VXPermObjList -	-
VXPolicy -	-
VXPolicyExportAudit -	-
VXPolicyExportAuditList -	-
VXPolicyList -	-
VXPortalUser -	-
VXPortalUserList -	-
VXRepository -	-
VXRepositoryList -	-
VXResource -	-
VXResourceList -	-
VXResponse -	-
VXString -	-
VXStringList -	-
VXTrxLog -	-
VXTrxLogList -	-
VXUser -	-
VXUserGroupInfo -	-
VXUserList -	-
VXUserPermission -	-
VXUserPermissionList -	-

- - - -

Security Admin Web Application

Resources

Data Types

JSON

XML