C1 App Entitlement API
The App Entitlement API from C1 — 11 operation(s) for app entitlement.
C1 App Entitlement API is one of 47 APIs that C1 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include App Entitlement. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 14 operations across 11 paths, and defines 52 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.
14 operations
11 paths
52 schemas
2 DELETE7 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
C1 App Entitlement 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 14
Across 11 paths, the API surfaces 14 operations — 2 DELETE, 7 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
App Entitlement 14
GET
/api/v1/apps/{app_id}/entitlements
List
POST
/api/v1/apps/{app_id}/entitlements
Create
POST
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/add-manual-user
Add Manually Managed Members
GET
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/grants
Search App Entitlements With Expired
DELETE
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/remove-membership
Remove Entitlement Membership
GET
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/usersdeprecated
List Users
DELETE
/api/v1/apps/{app_id}/entitlements/{id}
Delete
GET
/api/v1/apps/{app_id}/entitlements/{id}
Get
POST
/api/v1/apps/{app_id}/entitlements/{id}
Update
GET
/api/v1/apps/{app_id}/entitlements/resource_types/{app_resource_type_id}/resources/{app_resource_id}
List For App Resource
GET
/api/v1/apps/{app_id}/entitlements/users/{app_user_id}
List For App User
GET
/api/v1/search/apps/{app_id}/entitlements/users/{app_user_id}
Search App Entitlements For App User
POST
/api/v1/search/entitlements
Search
POST
/api/v1/search/grants
Search Grants
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are c1.api.app.v1.AppEntitlement (33 properties), c1.api.user.v1.User (31 properties), c1.api.app.v1.AppEntitlementSearchServiceSearchRequest (26 properties), c1.api.app.v1.CreateAppEntitlementRequestInput (21 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.app.v1.GetAppEntitlementResponse
object
The get app entitlement response returns an entitlement view containing paths in the expanded array for the objects expanded as indicated by the expand mask in…
2 properties
c1.api.app.v1.AppUserStatus
object
The satus of the applicaiton user.
2 properties
c1.api.app.v1.DeleteAppEntitlementRequestInput
object
The DeleteAppEntitlementRequest message.
c1.api.search.v1.FacetCategory
object
The FacetCategory indicates a grouping of facets by type. For example, facets "OnePassword" and "Okta" would group under an "Apps" category. This message conta…
5 properties
c1.api.user.v1.UserAttributeMappingSource
object
The UserAttributeMappingSource message.
5 properties
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.policy.v1.ConnectorProvision.DoNotSave
object
The DoNotSave message.
c1.api.search.v1.FacetRangeItem
object
The FacetRangeItem message.
1 property
c1.api.app.v1.UpdateAppEntitlementResponse
object
The UpdateAppEntitlementResponse message.
2 properties
c1.api.app.v1.AppEntitlementWithExpired
object
The AppEntitlementWithExpired message.
9 properties
c1.api.app.v1.AppEntitlementSearchServiceSearchResponse
object
The AppEntitlementSearchServiceSearchResponse message.
4 properties
c1.api.user.v1.User
object
The User object provides all of the details for an user, as well as some configuration.
31 properties
c1.api.app.v1.DeleteAppEntitlementResponse
object
The DeleteAppEntitlementResponse message.
c1.api.app.v1.SearchAppEntitlementsWithExpiredResponse
object
The SearchAppEntitlementsWithExpiredResponse message contains a list of results and a nextPageToken if applicable.
2 properties
c1.api.app.v1.UpdateAppEntitlementRequestInput
object
The UpdateAppEntitlementRequest message contains the app entitlement and the fields to be updated.
4 properties
c1.api.app.v1.AppEntitlementSearchServiceSearchGrantsResponse
object
The AppEntitlementSearchServiceSearchGrantsResponse message.
3 properties
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.app.v1.ListAppEntitlementUsersResponse
object
The ListAppEntitlementUsersResponse message contains a list of results and a nextPageToken if applicable.
3 properties
c1.api.app.v1.ListAppEntitlementsResponse
object
The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
3 properties
c1.api.policy.v1.MultiStep
object
MultiStep indicates that this provision step has multiple steps to process.
1 property
c1.api.app.v1.RemoveEntitlementMembershipRequestInput
object
The RemoveEntitlementMembershipRequest message.
1 property
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.app.v1.AppUserView
object
The AppUserView contains an app user as well as paths for apps, identity users, and last usage in expanded arrays.
4 properties
c1.api.app.v1.AppEntitlementSearchServiceSearchGrantsRequest
object
The AppEntitlementSearchServiceSearchGrantsRequest message.
9 properties
c1.api.app.v1.AppUser
object
Application User that represents an account in the application.
16 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.app.v1.AppEntitlementWithUserBinding
object
The AppEntitlementWithUserBinding message.
2 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.app.v1.RemoveEntitlementMembershipResponse
object
The RemoveEntitlementMembershipResponse message.
1 property
c1.api.search.v1.FacetValueItem
object
The FacetValueItem message.
1 property
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.app.v1.CreateAppEntitlementResponse
object
The CreateAppEntitlementResponse message.
2 properties
c1.api.app.v1.CreateAppEntitlementRequestInput
object
The CreateAppEntitlementRequest message. This message contains a oneof named maxgrantduration. Only a single field of the following list may be set at a time:…
21 properties
1 required
c1.api.policy.v1.ConnectorProvision.DeleteAccount
object
The DeleteAccount message.
1 property
c1.api.search.v1.FacetValue
object
A FacetValue message contains count and value of the facet entry.
4 properties
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.app.v1.AppEntitlementSearchServiceSearchRequest
object
Search app entitlements by a variety of filters.
26 properties
c1.api.app.v1.ManuallyManagedUsersResponse
object
The ManuallyManagedUsersResponse message.
1 property
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.search.v1.FacetRange
object
The FacetRange message.
5 properties
c1.api.app.v1.GrantReason
object
The GrantReason message.
10 properties
c1.api.policy.v1.ConnectorProvision.SaveToVault
object
The SaveToVault message.
1 property
c1.api.search.v1.Facets
object
Indicates one value of a facet.
2 properties
c1.api.app.v1.AppEntitlementRef
object
The AppEntitlementRef message.
2 properties
c1.api.app.v1.AppEntitlementUserView
object
The AppEntitlementUserView (aka grant view) describes the relationship between an app user and an entitlement. They have more recently been referred to as gran…
4 properties
c1.api.app.v1.AddManuallyManagedUsersRequestInput
object
The AddManuallyManagedUsersRequest message.
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.policy.v1.PolicyRef
object
The PolicyRef message.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from C1 12
Other APIs C1 publishes across the network.
Baton Connector Framework
C1 Access Conflict API
C1 App 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
C1 App Owner API
#App Entitlement