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 Request Catalog API

The Request Catalog API from C1 — 13 operation(s) for request catalog.

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

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

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

20 operations 13 paths 57 schemas 4 DELETE6 GET10 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 Request Catalog 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 20

Across 13 paths, the API surfaces 20 operations — 4 DELETE, 6 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Request Catalog 20
GET
/api/v1/catalogs
List
c1.api.requestcatalog.v1.RequestCatalogManagementService.List 2 params → 200
POST
/api/v1/catalogs
Create
c1.api.requestcatalog.v1.RequestCatalogManagementService.Create body → 200
GET
/api/v1/catalogs/{catalog_id}/requestable_entitlementIDs
List All Entitlement Ids Per App
c1.api.requestcatalog.v1.RequestCatalogManagementService.ListAllEntitlementIdsPerApp 1 param → 200
GET
/api/v1/catalogs/{catalog_id}/requestable_entitlements
List Entitlements Per Catalog
c1.api.requestcatalog.v1.RequestCatalogManagementService.ListEntitlementsPerCatalog 3 params → 200
POST
/api/v1/catalogs/{catalog_id}/requestable_entitlements/update
Update App Entitlements
c1.api.requestcatalog.v1.RequestCatalogManagementService.UpdateAppEntitlements 1 param body → 200
DELETE
/api/v1/catalogs/{catalog_id}/requestable_entries
Remove App Entitlements
c1.api.requestcatalog.v1.RequestCatalogManagementService.RemoveAppEntitlements 1 param body → 200
POST
/api/v1/catalogs/{catalog_id}/requestable_entries
Add App Entitlements
c1.api.requestcatalog.v1.RequestCatalogManagementService.AddAppEntitlements 1 param body → 200
DELETE
/api/v1/catalogs/{catalog_id}/visibility_bindings
Remove Access Entitlements
c1.api.requestcatalog.v1.RequestCatalogManagementService.RemoveAccessEntitlements 1 param body → 200
POST
/api/v1/catalogs/{catalog_id}/visibility_bindings
Add Access Entitlements
c1.api.requestcatalog.v1.RequestCatalogManagementService.AddAccessEntitlements 1 param body → 200
GET
/api/v1/catalogs/{catalog_id}/visibility_entitlements
List Entitlements For Access
c1.api.requestcatalog.v1.RequestCatalogManagementService.ListEntitlementsForAccess 3 params → 200
DELETE
/api/v1/catalogs/{id}
Delete
c1.api.requestcatalog.v1.RequestCatalogManagementService.Delete 1 param body → 200
GET
/api/v1/catalogs/{id}
Get
c1.api.requestcatalog.v1.RequestCatalogManagementService.Get 1 param → 200
POST
/api/v1/catalogs/{id}
Update
c1.api.requestcatalog.v1.RequestCatalogManagementService.Update 1 param body → 200
DELETE
/api/v1/catalogs/{request_catalog_id}/bundle_automation
Delete Bundle Automation
c1.api.requestcatalog.v1.RequestCatalogManagementService.DeleteBundleAutomation 1 param body → 200
GET
/api/v1/catalogs/{request_catalog_id}/bundle_automation
Get Bundle Automation
c1.api.requestcatalog.v1.RequestCatalogManagementService.GetBundleAutomation 1 param → 200
POST
/api/v1/catalogs/{request_catalog_id}/bundle_automation
Set Bundle Automation
c1.api.requestcatalog.v1.RequestCatalogManagementService.SetBundleAutomation 1 param body → 200
POST
/api/v1/catalogs/{request_catalog_id}/bundle_automation/create
Create Bundle Automation
c1.api.requestcatalog.v1.RequestCatalogManagementService.CreateBundleAutomation 1 param body → 200
POST
/api/v1/catalogs/{request_catalog_id}/bundle_automation/resume
Resume Paused Bundle Automation
c1.api.requestcatalog.v1.RequestCatalogManagementService.ResumePausedBundleAutomation 1 param body → 200
POST
/api/v1/catalogs/{request_catalog_id}/bundle_automation/run
Force Run Bundle Automation
c1.api.requestcatalog.v1.RequestCatalogManagementService.ForceRunBundleAutomation 1 param body → 200
POST
/api/v1/search/request_catalog/entitlements
Search Entitlements
c1.api.requestcatalog.v1.RequestCatalogSearchService.SearchEntitlements body → 200

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are c1.api.app.v1.AppEntitlement (33 properties), c1.api.requestcatalog.v1.RequestCatalog (14 properties), c1.api.requestcatalog.v1.BundleAutomation (11 properties), c1.api.requestcatalog.v1.RequestCatalogManagementServiceCreateRequest (9 properties). Each schema is shown below with its type and property counts.

c1.api.policy.v1.DelegatedProvision
object
This provision step indicates that we should delegate provisioning to the configuration of another app entitlement. This app entitlement does not have to be on…
3 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceRemoveAccessEntitlementsRequestInput
object
The RequestCatalogManagementServiceRemoveAccessEntitlementsRequest message is used to remove access entitlements from a request catalog. The access entitlement…
1 property
c1.api.requestcatalog.v1.ForceRunBundleAutomationRequestInput
object
The ForceRunBundleAutomationRequest message.
1 property
c1.api.requestcatalog.v1.RequestCatalogManagementServiceAddAppEntitlementsResponse
object
Empty response with a status code indicating success.
c1.api.requestcatalog.v1.RequestCatalogExpandMask
object
The RequestCatalogExpandMask includes the paths in the catalog view to expand in the return value of this call.
1 property
c1.api.app.v1.AppEntitlementView
object
The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
4 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceRemoveAppEntitlementsRequestInput
object
The RequestCatalogManagementServiceRemoveAppEntitlementsRequest message is used to remove app entitlements from a request catalog.
1 property
c1.api.requestcatalog.v1.BundleAutomation
object
The BundleAutomation message. This message contains a oneof named conditions. Only a single field of the following list may be set at a time: - entitlements
11 properties
c1.api.requestcatalog.v1.BundleAutomationRuleEntitlement
object
The BundleAutomationRuleEntitlement message.
1 property
c1.api.requestcatalog.v1.RequestCatalogManagementServiceAddAccessEntitlementsResponse
object
Empty response with a status code indicating success.
c1.api.requestcatalog.v1.RequestCatalogManagementServiceListEntitlementsForAccessResponse
object
The RequestCatalogManagementServiceListEntitlementsForAccessResponse message contains a list of results and a nextPageToken if applicable.
3 properties
c1.api.requestcatalog.v1.ResumePausedBundleAutomationResponse
object
The ResumePausedBundleAutomationResponse message.
c1.api.requestcatalog.v1.DeleteBundleAutomationResponse
object
The DeleteBundleAutomationResponse message.
c1.api.policy.v1.ConnectorProvision.DoNotSave
object
The DoNotSave message.
c1.api.app.v1.AppEntitlement
object
The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write. This message contains a…
33 properties
c1.api.requestcatalog.v1.CreateBundleAutomationRequestInput
object
The CreateBundleAutomationRequest message. This message contains a oneof named conditions. Only a single field of the following list may be set at a time: - en…
4 properties
c1.api.user.v1.UserRef
object
A reference to a user.
1 property
c1.api.requestcatalog.v1.RequestCatalogManagementServiceListEntitlementsPerCatalogResponse
object
The RequestCatalogManagementServiceListEntitlementsPerCatalogResponse message contains a list of results and a nextPageToken if applicable.
3 properties
c1.api.requestcatalog.v1.RequestCatalogSearchServiceSearchEntitlementsResponse
object
The RequestCatalogSearchServiceSearchEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
3 properties
c1.api.requestcatalog.v1.RequestCatalog
object
The RequestCatalog is used for managing which entitlements are requestable, and who can request them.
14 properties
c1.api.requestcatalog.v1.SetBundleAutomationRequestInput
object
The SetBundleAutomationRequest message. This message contains a oneof named conditions. Only a single field of the following list may be set at a time: - entit…
4 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceDeleteResponse
object
Empty response with a status code indicating success.
c1.api.requestcatalog.v1.BundleAutomationCircuitBreaker
object
The BundleAutomationCircuitBreaker message.
4 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceCreateRequest
object
Create a request catalog.
9 properties 1 required
c1.api.requestcatalog.v1.RequestCatalogManagementServiceRemoveAppEntitlementsResponse
object
Empty response with a status code indicating success
c1.api.policy.v1.ActionProvision
object
This provision step indicates that account lifecycle action should be called to provision this entitlement.
4 properties
c1.api.app.v1.AppEntitlementExpandMask
object
The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
1 property
c1.api.requestcatalog.v1.RequestCatalogManagementServiceUpdateAppEntitlementsResponse
object
The RequestCatalogManagementServiceUpdateAppEntitlementsResponse object is is the response from UpdateAppEntitlements endpoint.
c1.api.requestcatalog.v1.BundleAutomationLastRunState
object
The BundleAutomationLastRunState message.
3 properties
c1.api.policy.v1.MultiStep
object
MultiStep indicates that this provision step has multiple steps to process.
1 property
c1.api.requestcatalog.v1.RequestCatalogManagementServiceListResponse
object
The RequestCatalogManagementServiceListResponse message.
3 properties
c1.api.requestcatalog.v1.AppEntitlementWithUserBindings
object
The AppEntitlementWithUserBindings message represents an app entitlement and its associated user bindings.
2 properties
c1.api.policy.v1.WebhookProvision
object
This provision step indicates that a webhook should be called to provision this entitlement.
1 property
c1.api.policy.v1.UnconfiguredProvision
object
The UnconfiguredProvision message.
c1.api.requestcatalog.v1.RequestCatalogView
object
The request catalog view contains the serialized request catalog and paths to objects referenced by the request catalog.
4 properties
c1.api.policy.v1.ExternalTicketProvision
object
This provision step indicates that we should check an external ticket to provision this entitlement
4 properties
c1.api.policy.v1.ConnectorProvision.AccountProvision
object
The AccountProvision message. This message contains a oneof named storagetype. Only a single field of the following list may be set at a time: - saveToVault -…
5 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceListAllEntitlementIdsPerCatalogResponse
object
The RequestCatalogManagementServiceListAllEntitlementIdsPerCatalogResponse message.
1 property
c1.api.requestcatalog.v1.RequestCatalogManagementServiceRemoveAccessEntitlementsResponse
object
Empty response with a status code indicating success.
c1.api.policy.v1.ConnectorProvision
object
Indicates that a connector should perform the provisioning. This object has no fields. This message contains a oneof named provisiontype. Only a single field o…
3 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceDeleteRequestInput
object
Delete a request catalog by Id. It uses URL value for input.
c1.api.policy.v1.ConnectorProvision.DeleteAccount
object
The DeleteAccount message.
1 property
c1.api.policy.v1.ProvisionPolicy
object
ProvisionPolicy is a oneOf that indicates how a provision step should be processed. This message contains a oneof named typ. Only a single field of the followi…
8 properties
c1.api.policy.v1.ConnectorProvision.DefaultBehavior
object
The DefaultBehavior message.
1 property
c1.api.policy.v1.ManualProvision
object
Manual provisioning indicates that a human must intervene for the provisioning of this step.
2 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceAddAppEntitlementsRequestInput
object
The RequestCatalogManagementServiceAddAppEntitlementsRequest object is used to add app requestable app entitlements to a request catalog.
2 properties 1 required
c1.api.requestcatalog.v1.RequestCatalogManagementServiceGetResponse
object
The request catalog management service get response returns a request catalog view with the expanded items in the expanded array indicated by the expand mask i…
2 properties
c1.api.requestcatalog.v1.ResumePausedBundleAutomationRequestInput
object
The ResumePausedBundleAutomationRequest message.
c1.api.requestcatalog.v1.RequestCatalogSearchServiceSearchEntitlementsRequest
object
The RequestCatalogSearchServiceSearchEntitlementsRequest searches entitlements, but only ones that are available to you through the open catalogs.
8 properties
c1.api.app.v1.AppEntitlementUserBinding
object
The AppEntitlementUserBinding represents the relationship that gives an app user access to an app entitlement
7 properties
c1.api.requestcatalog.v1.ForceRunBundleAutomationResponse
object
The ForceRunBundleAutomationResponse message.
c1.api.policy.v1.ConnectorProvision.SaveToVault
object
The SaveToVault message.
1 property
c1.api.app.v1.AppEntitlementRef
object
The AppEntitlementRef message.
2 properties
c1.api.requestcatalog.v1.RequestCatalogManagementServiceAddAccessEntitlementsRequestInput
object
The RequestCatalogManagementServiceAddAccessEntitlementsRequest message is used to add access entitlements to a request catalog to determine which users can vi…
1 property 1 required
c1.api.requestcatalog.v1.RequestCatalogManagementServiceUpdateAppEntitlementsRequestInput
object
The RequestCatalogManagementServiceUpdateAppEntitlementsRequest object is used to update app entitlements to a request catalog id.
1 property 1 required
c1.api.requestcatalog.v1.DeleteBundleAutomationRequestInput
object
The DeleteBundleAutomationRequest message.
c1.api.requestcatalog.v1.RequestCatalogManagementServiceUpdateRequestInput
object
Update a request catalog object by ID.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

c1-request-catalog-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