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 Users API

The Users API from Venafi — 7 operation(s) for users.

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

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

This API exposes 7 operations across 7 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://api.venafi.cloud, https://api.eu.venafi.cloud, https://api.au.venafi.cloud, https://api.uk.venafi.cloud, https://api.sg.venafi.cloud, https://api.ca.venafi.cloud.

7 operations 7 paths 15 schemas 3 GET4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.venafi.cloud
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Venafi Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as service-account (service-account). An API key is passed in the header as tppl-api-key (tppl-api-key).

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 7
GET
/v1/users
Retrieve users matching specified criteria
get-v1-users 4 params → 200
GET
/v1/users/{id}
Retrieve user details by user ID
get-v1-users-byId 1 param → 200400404412
PUT
/v1/users/{id}/accounttype
Update user account type
put-v1-users-byId-accounttype 1 param body → 200400404412
PUT
/v1/users/{id}/locallogin
Enable/disable local login for user
put-v1-users-byId-locallogin 1 param body → 200400404412
PUT
/v1/users/{id}/roles
Update user roles
put-v1-users-byId-roles 1 param body → 200400404412
GET
/v1/users/username/{username}
Retrieve user details by username
get-v1-users-username-byUsername 1 param → 200400404412
PUT
/v1/users/{id}/passwordexpiration
Update if a user must change their password at next login
put-v1-users-byId-passwordexpiration 1 param body → 200400404412

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are UserInformation2 (22 properties), ErrorInformation6 (3 properties), RolesRequest (2 properties), LocalLoginRequest (1 property). Each schema is shown below with its type and property counts.

UserAccountType
string
UserResponse
object
1 property
RolesRequest
object
2 properties
UserType
string
AnyValue6
Can be any value - string, number, boolean, array or object.
ErrorResponse8
object
1 property
LocalLoginRequest
object
1 property
UserAccountTypeRequest
object
1 property 1 required
UserForceLocalPasswordExpirationRequest
object
1 property 1 required
SystemRole
string
SSOStatus
string
ErrorInformation6
object
3 properties
UserInformation2
object
22 properties
Role2
string
UserStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

venafi-users-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 Users 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.