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

The Directory API from C1 — 2 operation(s) for directory.

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

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

This API exposes 5 operations across 2 paths, and defines 13 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.

5 operations 2 paths 13 schemas 1 DELETE2 GET1 POST1 PUT

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 Directory 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 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.

Directory 5
GET
/api/v1/directories
List
c1.api.directory.v1.DirectoryService.List 2 params → 200
POST
/api/v1/directories
Create
c1.api.directory.v1.DirectoryService.Create body → 200
DELETE
/api/v1/directories/{app_id}
Delete
c1.api.directory.v1.DirectoryService.Delete 1 param body → 200
GET
/api/v1/directories/{app_id}
Get
c1.api.directory.v1.DirectoryService.Get 1 param → 200
PUT
/api/v1/directories/{app_id}
Update
c1.api.directory.v1.DirectoryService.Update 1 param body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are c1.api.directory.v1.Directory (6 properties), c1.api.directory.v1.DirectoryServiceCreateRequest (4 properties), c1.api.directory.v1.DirectoryServiceListResponse (3 properties), c1.api.directory.v1.DirectoryServiceUpdateRequestInput (3 properties). Each schema is shown below with its type and property counts.

c1.api.directory.v1.DirectoryExpandMask
object
The fields to be included in the directory response.
1 property
c1.api.directory.v1.DirectoryServiceCreateResponse
object
The DirectoryServiceCreateResponse message.
2 properties
c1.api.directory.v1.DirectoryServiceGetResponse
object
The Directory Service Get Response returns a directory view with a directory and JSONPATHs indicating the location in the expanded array that items are expande…
2 properties
c1.api.directory.v1.DirectoryServiceListResponse
object
The DirectoryServiceListResponse message contains a list of results and a nextPageToken if applicable.
3 properties
c1.api.directory.v1.Directory
object
This object indicates that an app is also a directory. This message contains a oneof named accountfilter. Only a single field of the following list may be set…
6 properties
c1.api.directory.v1.DirectoryServiceDeleteResponse
object
Empty response with a status code indicating success.
c1.api.directory.v1.DirectoryView
object
The directory view contains a directory and an apppath which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested…
2 properties
c1.api.directory.v1.DirectoryServiceDeleteRequestInput
object
DirectoryServiceDeleteRequest is the request message for deleting a directory. It uses URL values for input.
c1.api.directory.v1.DirectoryServiceUpdateRequestInput
object
Update a directory by appid. This message contains a oneof named accountfilter. Only a single field of the following list may be set at a time: - all - celExpr…
3 properties
c1.api.directory.v1.DirectoryAccountFilterAll
object
The DirectoryAccountFilterAll message.
c1.api.directory.v1.DirectoryServiceCreateRequest
object
Uplevel an app into a full directory. This message contains a oneof named accountfilter. Only a single field of the following list may be set at a time: - all…
4 properties
c1.api.directory.v1.DirectoryAccountFilterCel
object
The DirectoryAccountFilterCel message.
1 property
c1.api.directory.v1.DirectoryServiceUpdateResponse
object
The DirectoryServiceUpdateResponse message.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

c1-directory-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