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

Vertesia Roles API

Role endpoints expose the built-in Vertesia role catalog and the permissions granted by each role.

Vertesia Roles API is one of 48 APIs that Vertesia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.6.0-dev.20261019.172735Z.

Requests are made against a single base URL, https://api.{region}.vertesia.io/api/v1.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.6.0-dev.20261019.172735Z
Base URL
https://api.us1.vertesia.io/api/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
License
Apache-2.0
Resource Areas
1

Authentication & Security 2

Vertesia Roles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 33 scopes.

Paths & Operations 2

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

Roles 2

Role endpoints expose the built-in Vertesia role catalog and the permissions granted by each role.

GET
/iam/roles
List built-in roles
ListRoles 1 param → 2005004XX
GET
/iam/roles/system
List system roles
ListSystemRoles 1 param → 2005004XX

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (5 properties), SystemRoleDefinition (3 properties), RoleDefinition (3 properties). Each schema is shown below with its type and property counts.

RoleDefinitionArray
array
RoleDefinition
object
Wire shape of a role returned by the IAM /roles endpoint. Permissions are typed string[] because role names span multiple partitions (system, content, future t…
3 properties 3 required
Permission
string
RoleDomain
string
Logical grouping of roles by the service area that owns them. One domain may declare roles applicable to multiple scopes (e.g. the content domain owns roles ap…
SystemRoleDefinitionArray
array
SystemRoleDefinition
object
Tightly-typed view of a system-domain role: permissions are central Permission enum values. Returned by client.iam.roles.listSystem() and by the server's /role…
3 properties 3 required
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vertesiahq-roles-api-openapi.yml Raw ↑

Other APIs Vertesia publishes across the network.

Vertesia Access Control Entries API
Vertesia Account API
Vertesia Accounts API
Vertesia Agent Runs API
Vertesia API Keys API
Vertesia Apps API
Vertesia Audit Trail API
Vertesia Bulk Operations API
Vertesia Collections API
Vertesia Commands API
Vertesia Content Object Types API
Vertesia Content Query API
Where this information came from

This is an independent, third-party profile of Vertesia Roles 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.