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

C1 Role API

The Role API from C1 — 2 operation(s) for role.

C1 Role API is one of 47 APIs that C1 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Role. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0-alpha.

Requests are made against a single base URL, https://{tenantDomain}.conductor.one.

3 operations 2 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0-alpha
Base URL
https://example.conductor.one
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

C1 Role API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth — This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, re…

Paths & Operations 3

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

Role 3
GET
/api/v1/iam/roles
List
c1.api.iam.v1.Roles.List 2 params → 200
GET
/api/v1/iam/roles/{role_id}
Get
c1.api.iam.v1.Roles.Get 1 param → 200
POST
/api/v1/iam/roles/{role_id}
Update
c1.api.iam.v1.Roles.Update 1 param body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are c1.api.iam.v1.Role (10 properties), c1.api.iam.v1.ListRolesResponse (2 properties), c1.api.iam.v1.UpdateRoleRequestInput (2 properties), c1.api.iam.v1.GetRolesResponse (1 property). Each schema is shown below with its type and property counts.

c1.api.iam.v1.UpdateRoleRequestInput
object
The UpdateRoleRequest message contains the role to update and the update mask.
2 properties
c1.api.iam.v1.ListRolesResponse
object
The ListRolesResponse message contains a list of results and a nextPageToken if applicable.
2 properties
c1.api.iam.v1.UpdateRolesResponse
object
UpdateRolesResponse is the response message containing the updated role.
1 property
c1.api.iam.v1.GetRolesResponse
object
The GetRolesResponse message contains the retrieved role.
1 property
c1.api.iam.v1.Role
object
Role is a role that can be assigned to a user in ConductorOne.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

c1-role-api-openapi.yml Raw ↑

Other APIs C1 publishes across the network.

Baton Connector Framework
C1 Access Conflict API
C1 App API
C1 App Entitlement API
C1 App Entitlement Automation API
C1 App Entitlement Automation Exclusion API
C1 App Entitlement Monitor Binding API
C1 App Entitlement Owner API
C1 App Entitlement Proxy Binding API
C1 App Entitlement User Binding API
C1 App Entitlement User Binding Feed API
C1 App Entitlement User Binding History API