Resources

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/ugsyncAudits
  • /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}
  • /assets/ugsyncAudits/{syncSource}
  • GET
  • GET POST
  • GET POST PUT
  • GET
  • GET
  • GET POST
  • GET
  • GET
  • POST
  • DELETE GET PUT
  • GET
  • DELETE GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • DELETE GET PUT
  • GET
MetricsREST
  • /metrics/json
  • /metrics/prometheus
  • /metrics/status
  • GET
  • GET
  • GET
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/roles
  • /public/v2/api/service
  • /public/v2/api/servicedef
  • /public/v2/api/zone-headers
  • /public/v2/api/zones
  • /public/v2/api/plugins/info
  • /public/v2/api/policy/apply
  • /public/v2/api/policy/{id}
  • /public/v2/api/roles/names
  • /public/v2/api/roles/{id}
  • /public/v2/api/server/policydeltas
  • /public/v2/api/server/tagdeltas
  • /public/v2/api/service/{id}
  • /public/v2/api/servicedef/{id}
  • /public/v2/api/zones/{id}
  • /public/v2/api/policies/{serviceDefName}/for-resource
  • /public/v2/api/policy/guid/{guid}
  • /public/v2/api/roles/grant/{serviceName}
  • /public/v2/api/roles/name/{name}
  • /public/v2/api/roles/revoke/{serviceName}
  • /public/v2/api/roles/user/{user}
  • /public/v2/api/roles/{id}/addUsersAndGroups
  • /public/v2/api/roles/{id}/removeAdminFromUsersAndGroups
  • /public/v2/api/roles/{id}/removeUsersAndGroups
  • /public/v2/api/server/purgepolicies/{serviceName}
  • /public/v2/api/service/name/{name}
  • /public/v2/api/service/{serviceName}/tags
  • /public/v2/api/service/{servicename}/policy
  • /public/v2/api/servicedef/name/{name}
  • /public/v2/api/zone-names/{serviceName}/resource
  • /public/v2/api/zones/name/{name}
  • /public/v2/api/zones/{zoneId}/service-headers
  • /public/v2/api/service/{servicename}/policy/{policyname}
  • DELETE GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET
  • GET POST
  • GET
  • POST
  • DELETE GET PUT
  • GET
  • DELETE GET PUT
  • DELETE
  • DELETE
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • GET
  • DELETE GET
  • PUT
  • DELETE GET
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
  • DELETE
  • DELETE GET PUT
  • GET PUT
  • GET
  • DELETE GET PUT
  • GET
  • DELETE GET
  • GET
  • GET PUT
RoleREST
  • /roles/roles
  • /roles/download/{serviceName}
  • /roles/lookup/roles
  • /roles/roles/names
  • /roles/roles/{id}
  • /roles/roles/grant/{serviceName}
  • /roles/roles/name/{name}
  • /roles/roles/revoke/{serviceName}
  • /roles/roles/user/{user}
  • /roles/roles/{id}/addUsersAndGroups
  • /roles/roles/{id}/removeAdminFromUsersAndGroups
  • /roles/roles/{id}/removeUsersAndGroups
  • /roles/secure/download/{serviceName}
  • GET POST
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • PUT
  • DELETE GET
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
  • GET
SecurityZoneREST
  • /zones/zones
  • /zones/zones/{id}
  • /zones/zone-names/{serviceName}/resource
  • /zones/zones/name/{name}
  • GET POST
  • DELETE GET PUT
  • GET
  • DELETE GET
ServiceREST
  • /plugins/checksso
  • /plugins/csrfconf
  • /plugins/definitions
  • /plugins/policies
  • /plugins/policyLabels
  • /plugins/services
  • /plugins/cluster-services/{clusterName}
  • /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/server/policydeltas
  • /plugins/services/count
  • /plugins/services/validateConfig
  • /plugins/services/{id}
  • /plugins/definitions/name/{name}
  • /plugins/metrics/type/{type}
  • /plugins/policies/cache/reset
  • /plugins/policies/cache/reset-all
  • /plugins/policies/download/{serviceName}
  • /plugins/policies/guid/{guid}
  • /plugins/policies/service/{id}
  • /plugins/policies/{serviceDefName}/for-resource
  • /plugins/policy/{policyId}/versionList
  • /plugins/server/purgepolicies/{serviceName}
  • /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
  • GET POST
  • DELETE
  • DELETE GET PUT
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE GET PUT
  • DELETE
  • GET
  • POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE GET
  • GET
  • GET
  • GET
  • DELETE
  • 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/server/tagdeltas
  • /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/cache/reset
  • /tags/tags/cache/reset-all
  • /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
  • DELETE GET PUT
  • DELETE GET PUT
  • GET
  • DELETE GET
  • DELETE GET PUT
  • GET
  • GET
  • DELETE GET PUT
  • DELETE GET
  • GET
  • DELETE GET
  • GET
  • GET
  • GET
  • GET
UserREST
  • /users
  • /users/default
  • /users/profile
  • /users/{userId}
  • /users/{userId}/deactivate
  • /users/{userId}/emailchange
  • /users/{userId}/passwordchange
  • /users/{userId}/roles
  • GET POST PUT
  • POST
  • 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/permissionlist
  • /xusers/permmaps
  • /xusers/users
  • /xusers/auditmaps/count
  • /xusers/auditmaps/{id}
  • /xusers/authSessions/info
  • /xusers/download/{serviceName}
  • /xusers/groupgroups/count
  • /xusers/groupgroups/{id}
  • /xusers/groups/count
  • /xusers/groups/groupinfo
  • /xusers/groups/{id}
  • /xusers/groupusers/count
  • /xusers/groupusers/{id}
  • /xusers/lookup/groups
  • /xusers/lookup/users
  • /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/ugsync/auditinfo
  • /xusers/ugsync/groups
  • /xusers/ugsync/groupusers
  • /xusers/ugsync/users
  • /xusers/users/count
  • /xusers/users/external
  • /xusers/users/roleassignments
  • /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/download/{serviceName}
  • /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/ugsync/groups/visibility
  • /xusers/ugsync/users/visibility
  • /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
  • GET POST PUT
  • GET POST PUT
  • GET
  • DELETE GET
  • GET
  • GET
  • GET
  • DELETE GET
  • GET
  • POST
  • DELETE GET
  • GET
  • DELETE GET
  • GET
  • GET
  • GET
  • GET POST
  • GET POST
  • DELETE GET PUT
  • GET
  • DELETE GET
  • POST
  • POST
  • POST
  • POST
  • GET POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • DELETE GET
  • GET
  • GET
  • DELETE GET
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • DELETE GET PUT
  • GET
  • DELETE
  • PUT
  • DELETE
  • GET PUT
  • PUT
  • DELETE
  • PUT
  • GET PUT
  • DELETE
  • POST
  • POST
  • DELETE GET
  • DELETE
  • DELETE
  • GET
  • DELETE
  • PUT
  • GET PUT