How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Venafi Permission APIs API

The Permissions interface enables the management and querying of permissions within CyberArk Trust Protection Foundation™. Permissions grant principals (users and groups) privileges to objects within Trust Protection Foundation.In the Permissions interface, when a HTTP GET retrieves the permissions for a specific principal, both the effective and Implicit Permissions are returned.POST, PUT, or DELETE operations in this interface can successfully apply Effective Permissions parameters to principals in different identity providers.**What is the difference between Credentials, Permissions, and Identity?*** Credentials endpoints manage certificate and other activities. For more information, see Credentials APIs.* Identity endpoints manage CyberArk users. For more information, see Identity APIs.* Permissions endpoints grant principals (users and groups) privileges to objects within Trust Protection Foundation.

Venafi Permission APIs API is one of 58 APIs that Venafi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Permission APIs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 14 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 26.1.1.

Requests are made against 3 base URLs: /, https://REPLACEdnsnameME/, https://{dnsname}/.

19 operations 14 paths 18 schemas 2 DELETE7 GET8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.1.1
Base URL
https://api.venafi.cloud
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Venafi Permission APIs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (AccessToken). By default, every request must be authenticated.

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 2 DELETE, 7 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Permission APIs 19

The Permissions interface enables the management and querying of permissions within CyberArk Trust Protection Foundation™.

POST
/vedsdk/permissions/getprincipals
Get trustees
Venafi_Core_WebSDK_PermissionsRest_GetPrincipals body → 200403400401
POST
/vedsdk/permissions/getpermissions
Get assigned permissions
Venafi_Core_WebSDK_PermissionsRest_GetPermissions body → 200403400401
POST
/vedsdk/permissions/geteffectivepermissions
Get effective permissions
Venafi_Core_WebSDK_PermissionsRest_GetEffectivePermissions body → 200403400401
POST
/vedsdk/permissions/grantpermissions
Grant permissions
Venafi_Core_WebSDK_PermissionsRest_GrantPermissions body → 200403400401
POST
/vedsdk/permissions/revokepermissions
Revoke permissions
Venafi_Core_WebSDK_PermissionsRest_RevokePermissions body → 200403400401
POST
/vedsdk/permissions/replacepermissions
Update permissions
Venafi_Core_WebSDK_PermissionsRest_ReplacePermissions body → 200403400401
GET
/vedsdk/permissions/refresh
Refresh permissions
Venafi_Core_WebSDK_PermissionsRest_Refresh → 200403400401
GET
/vedsdk/permissions/object/{guid}deprecated
Gets object trustees
Venafi_Core_WebSDK_PermissionsRest_GetPrincipalsForObject 1 param → 200
GET
/vedsdk/permissions/object/{guid}/local/{identity}deprecated
Get assigned permissions of a local identity
Venafi_Core_WebSDK_PermissionsRest_GetLocalPermissions 2 params → 200
GET
/vedsdk/permissions/object/{guid}/local/{identity}/effectivedeprecated
Get effective permissions of local identity
Venafi_Core_WebSDK_PermissionsRest_GetLocalEffectivePermissions 2 params → 200
GET
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Get assigned permissions of an identity
Venafi_Core_WebSDK_PermissionsRest_GetExtProviderPermissions 4 params → 200
DELETE
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Delete permissions
Venafi_Core_WebSDK_PermissionsRest_DeleteExtProviderPermission 4 params → 200
POST
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Add permissions
Venafi_Core_WebSDK_PermissionsRest_AddExtProviderPermission 4 params → 200
PUT
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Update permissions
Venafi_Core_WebSDK_PermissionsRest_UpdateExtProviderPermission 4 params → 200
GET
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}/effectivedeprecated
Get effective permissions of an identity
Venafi_Core_WebSDK_PermissionsRest_GetExtProviderEffectivePermissions 4 params → 200
GET
/vedsdk/permissions/object/{guid}/myeffectivedeprecated
Gets the effective permissions of the session's user for the given object
Venafi_Core_WebSDK_PermissionsRest_GetMyEffectivePermissions 1 param → 200
DELETE
/vedsdk/permissions/object/{guid}/local/{principal}deprecated
Delete permissions
Venafi_Core_WebSDK_PermissionsRest_DeleteLocalPermission 2 params → 200
POST
/vedsdk/permissions/object/{guid}/local/{principal}deprecated
Add permissions
Venafi_Core_WebSDK_PermissionsRest_AddLocalPermission 2 params → 200
PUT
/vedsdk/permissions/object/{guid}/local/{principal}deprecated
Update permissions
Venafi_Core_WebSDK_PermissionsRest_UpdateLocalPermission 2 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Core_WebSDK_PermissionsWebRequest (4 properties), Core_WebSDK_AssignedPermissionsResponse (3 properties), Core_WebSDK_PermissionsWebRequest_getpermissions (3 properties), Core_WebSDK_PermissionsWebRequest_geteffectivepermissions (3 properties). Each schema is shown below with its type and property counts.

Web_SDK_Authentication_OAuthError
object
REST OAuth Error Response
2 properties
Core_WebSDK_EffectivePermissionsResponse
object
Data class representing REST permission response
2 properties
Permissions_PermissionsResult
integer
0: None No result set 1: Success The operation completed successfully 2: RemoteError A remote request failed; see Error property for details 3: MissingObjectAr…
Core_WebSDK_PermissionsWebResponse_revokepermissions
object
1 property
Core_WebSDK_PermissionsWebResponse_geteffectivepermissions
object
2 properties
Core_WebSDK_PermissionsWebRequest_getpermissions
object
3 properties
Core_WebSDK_PermissionsWebResponse_getpermissions
object
2 properties
Core_WebSDK_PermissionsWebResponse_replacepermissions
object
1 property
Core_WebSDK_AssignedPermissionsResponse
object
3 properties
Core_IdentityType
integer
0: Undefined Undefined 1: User User object 2: Group Group object 4: Container Container of users and groups 8: DistributionList Distribution List 16: Machine M…
Core_WebSDK_PermissionsWebResponse_refresh
object
1 property
Core_WebSDK_PermissionsWebRequest
object
4 properties
Core_WebSDK_PermissionsWebResponse_grantpermissions
object
1 property
Core_WebSDK_PermissionsWebResponse_getprincipals
object
2 properties
Core_WebSDK_PermissionsWebRequest_getprincipals
object
2 properties
Core_IdentityEntry_EntryState
integer
0: Normal No special state associated with the entry 1: Disabled The identity has been disabled 2: LockedOut The identity has been locked out 4: Deleted The id…
Core_WebSDK_PermissionsWebRequest_revokepermissions
object
3 properties
Core_WebSDK_PermissionsWebRequest_geteffectivepermissions
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

venafi-permission-apis-api-openapi.yml Raw ↑

Other APIs Venafi publishes across the network.

Venafi Access Management APIs API
Venafi AlgorithmSelector APIs API
Venafi Application API
Venafi Authentication Server APIs API
Venafi Certificate Approvals API
Venafi Certificate Auto-renewal Monitoring API
Venafi Certificate Discovery API
Venafi Certificate Expiration Reports API
Venafi Certificate Import API
Venafi Certificate Installations API
Venafi Certificate Inventory Monitoring API
Venafi Certificate Management APIs API
Where this information came from

This is an independent, third-party profile of Venafi Permission APIs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.