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

Harness Roles API

This contains APIs for CRUD on roles

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

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

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

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 5

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

Roles 5

This contains APIs for CRUD on roles

GET
/authz/api/roles
List Roles
getRoleList 9 params → 400403500default
POST
/authz/api/roles
Create Role
postRole 3 params body → 400403500default
GET
/authz/api/roles/{identifier}
Get Role
getRole 4 params → 400403500default
PUT
/authz/api/roles/{identifier}
Update Role
putRole 4 params body → 400403500default
DELETE
/authz/api/roles/{identifier}
Delete Role
deleteRole 4 params → 400403500default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AccessDeniedError (8 properties), RoleWithPrincipalCountResponse (8 properties), PageResponseRoleWithPrincipalCountResponse (8 properties), ResponseMessage (7 properties). Each schema is shown below with its type and property counts.

AccessDeniedError
object
8 properties
ResponseDTORoleResponse
object
4 properties
ResponseMessage
object
7 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
AuthzErrorMetadata
object
This implements different error meta data objects
1 property
PermissionCheck
object
5 properties 2 required
Role
object
6 properties 2 required
SortOrder
object
2 properties
AuthzError
object
This is Error entity as defined in Harness
7 properties
ResourceScope
object
3 properties
RoleWithPrincipalCountResponse
object
8 properties 1 required
ValidationError
object
2 properties
ResponseDTOPageResponseRoleWithPrincipalCountResponse
object
4 properties
AuthzRoleResponse
object
5 properties 1 required
AuthzScope
object
3 properties
PageResponseRoleWithPrincipalCountResponse
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-roles-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

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