Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Organization Custom Role API

The Organization Custom Role API from Qovery — 2 operation(s) for organization custom role.

Qovery Organization Custom Role API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Organization Custom Role API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

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.

Organization Custom Role 5
GET
/organization/{organizationId}/customRole
List organization custom roles
listOrganizationCustomRoles 1 param → 200401403404
POST
/organization/{organizationId}/customRole
Create an organization custom role
createOrganizationCustomRole 1 param body → 201400401403
GET
/organization/{organizationId}/customRole/{customRoleId}
Get an organization custom role
getOrganizationCustomRole 2 params → 200401403404
PUT
/organization/{organizationId}/customRole/{customRoleId}
Edit an organization custom role
editOrganizationCustomRole 2 params body → 200400401403404
DELETE
/organization/{organizationId}/customRole/{customRoleId}
Delete organization custom role
deleteOrganizationCustomRole 2 params → 204401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are OrganizationCustomRole (5 properties), OrganizationCustomRoleUpdateRequest (4 properties), OrganizationCustomRoleCreateRequest (2 properties), OrganizationCustomRoleList (1 property). Each schema is shown below with its type and property counts.

EnvironmentModeEnum
string
OrganizationCustomRoleClusterPermission
string
Indicates the permission for a target cluster, from the lowest to the highest: - VIEWER user has only read access on target cluster - ENVCREATOR user can deplo…
OrganizationCustomRoleProjectPermission
string
Indicates the permission for a target project and a given environment type, from the lowest to the highest: - NOACCESS user has no access - VIEWER user can acc…
OrganizationCustomRoleUpdateRequest
object
4 properties 3 required
OrganizationCustomRoleList
object
1 property
OrganizationCustomRole
object
5 properties
OrganizationCustomRoleCreateRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-organization-custom-role-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API