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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

C1

C1 Connector API

The Connector API from C1 — 11 operation(s) for connector.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 15 operations across 11 paths, and defines 33 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.

15 operations 11 paths 33 schemas 1 DELETE3 GET11 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 Connector 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 15

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

Connector 15
GET
/api/v1/apps/{app_id}/connectors
List
c1.api.app.v1.ConnectorService.List 3 params → 200
POST
/api/v1/apps/{app_id}/connectors
Create Delegated
c1.api.app.v1.ConnectorService.CreateDelegated 1 param body → 200
POST
/api/v1/apps/{app_id}/connectors/{connector_id}/confirm_sync_valid/{sync_lifecycle_id}
Confirm Sync Valid
c1.api.app.v1.ConnectorService.ConfirmSyncValid 3 params body → 200
GET
/api/v1/apps/{app_id}/connectors/{connector_id}/credentials/{id}
Get Credentials
c1.api.app.v1.ConnectorService.GetCredentials 3 params → 200
POST
/api/v1/apps/{app_id}/connectors/{connector_id}/credentials/{id}
Revoke Credential
c1.api.app.v1.ConnectorService.RevokeCredential 3 params body → 200
POST
/api/v1/apps/{app_id}/connectors/{connector_id}/force_sync
Force Sync
c1.api.app.v1.ConnectorService.ForceSync 2 params body → 200
POST
/api/v1/apps/{app_id}/connectors/{connector_id}/pause
Pause Sync
c1.api.app.v1.ConnectorService.PauseSync 2 params body → 200
POST
/api/v1/apps/{app_id}/connectors/{connector_id}/resume
Resume Sync
c1.api.app.v1.ConnectorService.ResumeSync 2 params body → 200
DELETE
/api/v1/apps/{app_id}/connectors/{id}
Delete
c1.api.app.v1.ConnectorService.Delete 2 params body → 200
GET
/api/v1/apps/{app_id}/connectors/{id}
Get
c1.api.app.v1.ConnectorService.Get 2 params → 200
POST
/api/v1/apps/{app_id}/connectors/{id}
Update
c1.api.app.v1.ConnectorService.Update 2 params body → 200
POST
/api/v1/apps/{app_id}/connectors/create
Create
c1.api.app.v1.ConnectorService.Create 1 param body → 200
POST
/api/v1/apps/{connector_app_id}/connectors/{connector_id}/delegated
Update Delegated
c1.api.app.v1.ConnectorService.UpdateDelegated 2 params body → 200
POST
/api/v1/apps/connectors/credentials
Rotate Credential
c1.api.app.v1.ConnectorService.RotateCredential body → 200
POST
/api/v1/apps/connectors/validate_config/http
Validate Http Connector Config
c1.api.app.v1.ConnectorService.ValidateHTTPConnectorConfig body → 200

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are c1.api.app.v1.Connector (20 properties), c1.api.app.v1.ConnectorCredential (11 properties), c1.api.app.v1.ConnectorServiceCreateDelegatedRequestInput (6 properties), c1.api.editor.v1.EditorMarker (6 properties). Each schema is shown below with its type and property counts.

c1.api.app.v1.OAuth2AuthorizedAs
object
OAuth2AuthorizedAs tracks the user that OAuthed with the connector.
2 properties
c1.api.app.v1.EditorValidateRequest
object
The EditorValidateRequest message.
1 property
c1.api.app.v1.ConnectorServiceGetResponse
object
The ConnectorServiceGetResponse message contains the connectorView, and an expand mask.
2 properties
c1.api.app.v1.ForceSyncRequestInput
object
Signal the connector to start syncing. This puts the sync on the queue. It does not guarantee immediate sync. Long syncs still take minutes to hours.
c1.api.app.v1.ConnectorServiceDeleteRequestInput
object
ConnectorServiceDeleteRequest is a request for deleting a connector. It uses URL values for input.
c1.api.app.v1.PauseSyncRequestInput
object
The PauseSyncRequest message.
c1.api.app.v1.AppManagedStateBindingRef
object
The AppManagedStateBindingRef message.
3 properties
c1.api.app.v1.ConnectorServiceUpdateRequestInput
object
The ConnectorServiceUpdateRequest message contains the fields required to update a connector.
3 properties
c1.api.app.v1.ConnectorServiceGetCredentialsResponse
object
ConnectorServiceGetCredentialsResponse is the response returned by the get method.
1 property
c1.api.app.v1.ConnectorCredential
object
ConnectorCredential is used by a connector to authenticate with conductor one.
11 properties
c1.api.app.v1.ResumeSyncRequestInput
object
The ResumeSyncRequest message.
c1.api.app.v1.ConnectorServiceRotateCredentialRequest
object
ConnectorServiceRotateCredentialRequest is a request for rotating connector credentials. It uses URL values for input.
2 properties
c1.api.editor.v1.EditorMarker
object
The EditorMarker message.
6 properties
c1.api.app.v1.ConnectorServiceRotateCredentialResponse
object
ConnectorServiceRotateCredentialResponse is the response returned by the rotate method.
1 property
c1.api.app.v1.ConnectorStatus
object
The status field on the connector is used to track the status of the connectors sync, and when syncing last started, completed, or caused the connector to upda…
5 properties
c1.api.app.v1.ConnectorServiceUpdateResponse
object
ConnectorServiceUpdateResponse is the response returned by the update method.
2 properties
c1.api.app.v1.ConnectorServiceCreateResponse
object
The ConnectorServiceCreateResponse is the response returned from creating a connector.
2 properties
c1.api.app.v1.ConnectorServiceDeleteResponse
object
Empty response body. Status code indicates success.
c1.api.app.v1.PauseSyncResponse
object
The PauseSyncResponse message.
c1.api.app.v1.ConfirmSyncValidResponse
object
The ConfirmSyncValidResponse message.
c1.api.app.v1.ConnectorServiceListResponse
object
The ConnectorServiceListResponse message contains a list of results and a nextPageToken if applicable
3 properties
c1.api.app.v1.ConnectorServiceCreateDelegatedRequestInput
object
The ConnectorServiceCreateDelegatedRequest message contains the fields required to create a connector.
6 properties
c1.api.app.v1.ConnectorServiceRevokeCredentialResponse
object
Empty response body. Status code indicates success.
c1.api.app.v1.ConnectorServiceCreateRequestInput
object
The ConnectorServiceCreateRequest message.
5 properties
c1.api.app.v1.ConnectorServiceUpdateDelegatedRequestInput
object
The ConnectorServiceUpdateDelegatedRequest message contains the fields required to update a connector.
3 properties
c1.api.app.v1.EditorValidateResponse
object
The EditorValidateResponse message.
1 property
c1.api.app.v1.ResumeSyncResponse
object
The ResumeSyncResponse message.
c1.api.app.v1.ConnectorExpandMask
object
The ConnectorExpandMask is used to expand related objects on a connector.
1 property
c1.api.app.v1.ConnectorView
object
The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.
4 properties
c1.api.app.v1.Connector
object
A Connector is used to sync objects into Apps
20 properties
c1.api.app.v1.ConnectorServiceRevokeCredentialRequestInput
object
ConnectorServiceRevokeCredentialRequest is a request for revoking connector credentials. It uses URL values for input.
c1.api.app.v1.ConfirmSyncValidRequestInput
object
The ConfirmSyncValidRequest message.
c1.api.app.v1.ForceSyncResponse
object
The ForceSyncResponse message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

c1-connector-api-openapi.yml Raw ↑

Other APIs C1 publishes across the network.

Baton Connector Framework
AE Profile APIs.io
C1 Access Conflict API
AE Profile APIs.io
C1 App API
AE Profile APIs.io
C1 App Entitlement API
AE Profile APIs.io
C1 App Entitlement Automation API
AE Profile APIs.io
C1 App Entitlement Automation Exclusion API
AE Profile APIs.io
C1 App Entitlement Monitor Binding API
AE Profile APIs.io
C1 App Entitlement Owner API
AE Profile APIs.io
C1 App Entitlement Proxy Binding API
AE Profile APIs.io
C1 App Entitlement User Binding API
AE Profile APIs.io
C1 App Entitlement User Binding Feed API
AE Profile APIs.io
C1 App Entitlement User Binding History API
AE Profile APIs.io
#Connector
← Back to C APIs
API Details
ID
c1:c1-connector-api
Base URL
https://example.conductor.one
Docs
https://www.c1.ai/docs/api-reference
Provider
C1
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network