ConductorOne App Entitlement API
The App Entitlement API from ConductorOne — 11 operation(s) for app entitlement.
The App Entitlement API from ConductorOne — 11 operation(s) for app entitlement.
openapi: 3.1.0
info:
description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
title: ConductorOne Access Conflict App Entitlement API
version: 0.1.0-alpha
servers:
- description: The ConductorOne API server for the current tenant.
url: https://{tenantDomain}.conductor.one
variables:
tenantDomain:
default: example
description: The domain of the tenant to use for this request.
security:
- bearerAuth: []
oauth: []
tags:
- name: App Entitlement
paths:
/api/v1/apps/{app_id}/entitlements:
get:
description: List app entitlements associated with an app.
operationId: c1.api.app.v1.AppEntitlements.List
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: query
name: page_size
schema:
description: The pageSize field.
format: int32
readOnly: false
type: integer
- in: query
name: page_token
schema:
description: The pageToken field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementsResponse'
description: The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
summary: List
tags:
- App Entitlement
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: List
post:
description: Invokes the c1.api.app.v1.AppEntitlements.Create method.
operationId: c1.api.app.v1.AppEntitlements.Create
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.CreateAppEntitlementRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.CreateAppEntitlementResponse'
description: Successful response
summary: Create
tags:
- App Entitlement
x-speakeasy-entity-operation:
terraform-resource: Custom App Entitlement#create
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: Create
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/add-manual-user:
post:
description: Invokes the c1.api.app.v1.AppEntitlements.AddManuallyManagedMembers method.
operationId: c1.api.app.v1.AppEntitlements.AddManuallyManagedMembers
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_entitlement_id
required: true
schema:
description: The appEntitlementId field.
readOnly: false
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.AddManuallyManagedUsersRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.ManuallyManagedUsersResponse'
description: Successful response
summary: Add Manually Managed Members
tags:
- App Entitlement
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: AddManuallyManagedMembers
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/grants:
get:
description: Search app entitlements, include app users, users, expires, discovered.
operationId: c1.api.app.v1.AppEntitlementSearchService.SearchAppEntitlementsWithExpired
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_entitlement_id
required: true
schema:
description: The appEntitlementId field.
readOnly: false
type: string
- in: query
name: page_size
schema:
description: The pageSize field.
format: int32
readOnly: false
type: integer
- in: query
name: page_token
schema:
description: The pageToken field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.SearchAppEntitlementsWithExpiredResponse'
description: The SearchAppEntitlementsWithExpiredResponse message contains a list of results and a nextPageToken if applicable.
summary: Search App Entitlements With Expired
tags:
- App Entitlement
x-speakeasy-group: AppEntitlementSearch
x-speakeasy-name-override: SearchAppEntitlementsWithExpired
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/remove-membership:
delete:
description: Invokes the c1.api.app.v1.AppEntitlements.RemoveEntitlementMembership method.
operationId: c1.api.app.v1.AppEntitlements.RemoveEntitlementMembership
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_entitlement_id
required: true
schema:
description: The appEntitlementId field.
readOnly: false
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.RemoveEntitlementMembershipRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.RemoveEntitlementMembershipResponse'
description: Successful response
summary: Remove Entitlement Membership
tags:
- App Entitlement
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: RemoveEntitlementMembership
/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users:
get:
deprecated: true
description: List the users, as AppEntitlementUsers objects, of an app entitlement.
operationId: c1.api.app.v1.AppEntitlements.ListUsers
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_entitlement_id
required: true
schema:
description: The appEntitlementId field.
readOnly: false
type: string
- in: query
name: page_size
schema:
description: The pageSize field.
format: int32
readOnly: false
type: integer
- in: query
name: page_token
schema:
description: The pageToken field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementUsersResponse'
description: The ListAppEntitlementUsersResponse message contains a list of results and a nextPageToken if applicable.
summary: List Users
tags:
- App Entitlement
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: ListUsers
/api/v1/apps/{app_id}/entitlements/{id}:
delete:
description: Invokes the c1.api.app.v1.AppEntitlements.Delete method.
operationId: c1.api.app.v1.AppEntitlements.Delete
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: id
required: true
schema:
description: The id field.
readOnly: false
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.DeleteAppEntitlementRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.DeleteAppEntitlementResponse'
description: Successful response
summary: Delete
tags:
- App Entitlement
x-speakeasy-entity-operation:
terraform-resource: Custom App Entitlement#delete
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: Delete
get:
description: Get an app entitlement by ID.
operationId: c1.api.app.v1.AppEntitlements.Get
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: id
required: true
schema:
description: The id field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.GetAppEntitlementResponse'
description: 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 the request.
summary: Get
tags:
- App Entitlement
x-speakeasy-entity-operation:
terraform-datasource: null
terraform-resource: Custom App Entitlement#read
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: Get
post:
description: Update an app entitlement by ID.
operationId: c1.api.app.v1.AppEntitlements.Update
parameters:
- in: path
name: app_id
required: true
schema:
description: The ID of the app that is associated with the app entitlement.
readOnly: false
type: string
- in: path
name: id
required: true
schema:
description: The unique ID for the App Entitlement.
readOnly: true
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.UpdateAppEntitlementRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.UpdateAppEntitlementResponse'
description: Successful response
summary: Update
tags:
- App Entitlement
x-speakeasy-entity-operation:
terraform-resource: Custom App Entitlement#update
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: Update
/api/v1/apps/{app_id}/entitlements/resource_types/{app_resource_type_id}/resources/{app_resource_id}:
get:
description: List app entitlements associated with an app resource.
operationId: c1.api.app.v1.AppEntitlements.ListForAppResource
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_resource_type_id
required: true
schema:
description: The appResourceTypeId field.
readOnly: false
type: string
- in: path
name: app_resource_id
required: true
schema:
description: The appResourceId field.
readOnly: false
type: string
- in: query
name: page_size
schema:
description: The pageSize field.
format: int32
readOnly: false
type: integer
- in: query
name: page_token
schema:
description: The pageToken field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementsResponse'
description: The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
summary: List For App Resource
tags:
- App Entitlement
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: ListForAppResource
/api/v1/apps/{app_id}/entitlements/users/{app_user_id}:
get:
description: List app entitlements associated with an app user.
operationId: c1.api.app.v1.AppEntitlements.ListForAppUser
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_user_id
required: true
schema:
description: The appUserId field.
readOnly: false
type: string
- in: query
name: page_size
schema:
description: The pageSize field.
format: int32
readOnly: false
type: integer
- in: query
name: page_token
schema:
description: The pageToken field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementsResponse'
description: The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
summary: List For App User
tags:
- App Entitlement
x-speakeasy-group: AppEntitlements
x-speakeasy-name-override: ListForAppUser
/api/v1/search/apps/{app_id}/entitlements/users/{app_user_id}:
get:
description: Invokes the c1.api.app.v1.AppEntitlementSearchService.SearchAppEntitlementsForAppUser method.
operationId: c1.api.app.v1.AppEntitlementSearchService.SearchAppEntitlementsForAppUser
parameters:
- in: path
name: app_id
required: true
schema:
description: The appId field.
readOnly: false
type: string
- in: path
name: app_user_id
required: true
schema:
description: The appUserId field.
readOnly: false
type: string
- in: query
name: page_size
schema:
description: The pageSize field.
format: int32
readOnly: false
type: integer
- in: query
name: page_token
schema:
description: The pageToken field.
readOnly: false
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementsResponse'
description: The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
summary: Search App Entitlements For App User
tags:
- App Entitlement
x-speakeasy-group: AppEntitlementSearch
x-speakeasy-name-override: SearchAppEntitlementsForAppUser
/api/v1/search/entitlements:
post:
description: Search app entitlements based on filters specified in the request body.
operationId: c1.api.app.v1.AppEntitlementSearchService.Search
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementSearchServiceSearchRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementSearchServiceSearchResponse'
description: Successful response
summary: Search
tags:
- App Entitlement
x-speakeasy-entity-operation:
terraform-datasource:
- App Entitlement#read
- App Entitlements#read
terraform-resource: null
x-speakeasy-group: AppEntitlementSearch
x-speakeasy-name-override: Search
x-speakeasy-pagination:
inputs:
- in: requestBody
name: pageToken
type: cursor
outputs:
nextCursor: $.nextPageToken
type: cursor
/api/v1/search/grants:
post:
description: Invokes the c1.api.app.v1.AppEntitlementSearchService.SearchGrants method.
operationId: c1.api.app.v1.AppEntitlementSearchService.SearchGrants
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementSearchServiceSearchGrantsRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementSearchServiceSearchGrantsResponse'
description: Successful response
summary: Search Grants
tags:
- App Entitlement
x-speakeasy-group: AppEntitlementSearch
x-speakeasy-name-override: SearchGrants
components:
schemas:
c1.api.app.v1.UpdateAppEntitlementResponse:
description: The UpdateAppEntitlementResponse message.
properties:
appEntitlementView:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementView'
expanded:
description: List of related objects
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
readOnly: false
type: object
nullable: true
readOnly: false
type: array
title: Update App Entitlement Response
type: object
x-speakeasy-name-override: UpdateAppEntitlementResponse
c1.api.app.v1.AddManuallyManagedUsersRequestInput:
description: The AddManuallyManagedUsersRequest message.
properties:
userIds:
description: The userIds field.
items:
type: string
nullable: true
readOnly: false
type: array
title: Add Manually Managed Users Request
type: object
x-speakeasy-name-override: AddManuallyManagedUsersRequest
c1.api.app.v1.AppEntitlementSearchServiceSearchGrantsRequest:
description: The AppEntitlementSearchServiceSearchGrantsRequest message.
properties:
appIds:
description: Search for grants contained in any of these apps.
items:
type: string
nullable: true
readOnly: false
type: array
appUserIds:
description: Search for grants that are granted to any of these app user ids.
items:
type: string
nullable: true
readOnly: false
type: array
entitlementRefs:
description: Search for grants of an entitlement
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementRef'
nullable: true
readOnly: false
type: array
expandMask:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementExpandMask'
pageSize:
description: The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
format: int32
readOnly: false
type: integer
pageToken:
description: The pageToken field.
readOnly: false
type: string
resourceIds:
description: Search for grants within a resource.
items:
type: string
nullable: true
readOnly: false
type: array
resourceTypeIds:
description: Search grants for given resource types.
items:
type: string
nullable: true
readOnly: false
type: array
userId:
description: Search for grants of a user
readOnly: false
type: string
title: App Entitlement Search Service Search Grants Request
type: object
x-speakeasy-name-override: AppEntitlementSearchServiceSearchGrantsRequest
c1.api.app.v1.ListAppEntitlementUsersResponse:
description: The ListAppEntitlementUsersResponse message contains a list of results and a nextPageToken if applicable.
properties:
expanded:
description: List of related objects
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
readOnly: false
type: object
nullable: true
readOnly: false
type: array
list:
description: The list of results containing up to X results, where X is the page size defined in the request.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementUserView'
nullable: true
readOnly: false
type: array
nextPageToken:
description: The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
readOnly: false
type: string
title: List App Entitlement Users Response
type: object
x-speakeasy-name-override: ListAppEntitlementUsersResponse
c1.api.app.v1.DeleteAppEntitlementRequestInput:
description: The DeleteAppEntitlementRequest message.
title: Delete App Entitlement Request
type: object
x-speakeasy-name-override: DeleteAppEntitlementRequest
c1.api.app.v1.AppEntitlementView:
description: The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
properties:
appEntitlement:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlement'
appPath:
description: JSONPATH expression indicating the location of the App object in the array.
readOnly: false
type: string
appResourcePath:
description: JSONPATH expression indicating the location of the App Resource Type object in the expanded array.
readOnly: false
type: string
appResourceTypePath:
description: JSONPATH expression indicating the location of the App Resource object in the array.
readOnly: false
type: string
title: App Entitlement View
type: object
x-speakeasy-name-override: AppEntitlementView
c1.api.search.v1.FacetValue:
description: A FacetValue message contains count and value of the facet entry.
properties:
count:
description: The count of the values in this facet.
format: int64
readOnly: false
type: string
displayName:
description: The name of this facet.
readOnly: false
type: string
iconUrl:
description: The icon for this facet.
readOnly: false
type: string
value:
description: The value of this facet.
readOnly: false
type: string
title: Facet Value
type: object
x-speakeasy-name-override: FacetValue
c1.api.policy.v1.ConnectorProvision.DefaultBehavior:
description: The DefaultBehavior message.
nullable: true
properties:
connectorId:
description: "this checks if the entitlement is enabled by provisioning in a specific connector\n this can happen automatically and doesn't need any extra info"
readOnly: false
type: string
title: Default Behavior
type: object
x-speakeasy-name-override: DefaultBehavior
c1.api.policy.v1.ConnectorProvision.SaveToVault:
description: The SaveToVault message.
nullable: true
properties:
vaultIds:
description: The vaultIds field.
items:
type: string
nullable: true
readOnly: false
type: array
title: Save To Vault
type: object
x-speakeasy-name-override: SaveToVault
c1.api.app.v1.SearchAppEntitlementsWithExpiredResponse:
description: The SearchAppEntitlementsWithExpiredResponse message contains a list of results and a nextPageToken if applicable.
properties:
list:
description: The list field.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementWithExpired'
nullable: true
readOnly: false
type: array
nextPageToken:
description: The nextPageToken field.
readOnly: false
type: string
title: Search App Entitlements With Expired Response
type: object
x-speakeasy-name-override: SearchAppEntitlementsWithExpiredResponse
c1.api.app.v1.GetAppEntitlementResponse:
description: 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 the request.
properties:
appEntitlementView:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementView'
expanded:
description: List of serialized related objects.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
readOnly: false
type: object
nullable: true
readOnly: false
type: array
title: Get App Entitlement Response
type: object
x-speakeasy-name-override: GetAppEntitlementResponse
c1.api.app.v1.ListAppEntitlementsResponse:
description: The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.
properties:
expanded:
description: List of related objects
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
readOnly: false
type: object
nullable: true
readOnly: false
type: array
list:
description: The list of results containing up to X results, where X is the page size defined in the request.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementView'
nullable: true
readOnly: false
type: array
nextPageToken:
description: The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
readOnly: false
type: string
title: List App Entitlements Response
type: object
x-speakeasy-name-override: ListAppEntitlementsResponse
c1.api.search.v1.FacetRangeItem:
description: The FacetRangeItem message.
nullable: true
properties:
ranges:
description: An array of facet ranges.
items:
$ref: '#/components/schemas/c1.api.search.v1.FacetRange'
nullable: true
readOnly: false
type: array
title: Facet Range Item
type: object
x-speakeasy-name-override: FacetRangeItem
c1.api.app.v1.AppEntitlementUserView:
description: The AppEntitlementUserView (aka grant view) describes the relationship between an app user and an entitlement. They have more recently been referred to as grants.
properties:
appEntitlementUserBindingCreatedAt:
format: date-time
readOnly: true
type: string
appEntitlementUserBindingDeprovisionAt:
format: date-time
readOnly: true
type: string
appUser:
$ref: '#/components/schemas/c1.api.app.v1.AppUserView'
grantSources:
description: List of sources for the grant, ie. groups, roles, etc.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementRef'
nullable: true
readOnly: false
type: array
title: App Entitlement User View
type: object
x-speakeasy-name-override: AppEntitlementUserView
c1.api.app.v1.AppEntitlementSearchServiceSearchRequest:
description: Search app entitlements by a variety of filters.
properties:
accessReviewId:
description: Search for app entitlements that are being reviewed as part of this access review campaign.
readOnly: false
type: string
alias:
description: Search for app entitlements that have this alias (exact match).
readOnly: false
type: string
appIds:
description: Search for app entitlements contained in any of these apps.
items:
type: string
nullable: true
readOnly: false
type: array
appUserIds:
description: Search for app entitlements that are granted to any of these app user ids.
items:
type: string
nullable: true
readOnly: false
type: array
complianceFrameworkIds:
description: Search for app entitlements that are part of these compliace frameworks.
items:
type: string
nullable: true
readOnly: false
type: array
displayName:
description: The displayName field.
readOnly: false
type: string
excludeAppIds:
description: Exclude app entitlements from the results that are in these app IDs.
items:
type: string
nullable: true
readOnly: false
type: array
excludeAppUserIds:
description: Exclude app entitlements from the results that these app users have granted.
items:
type: string
nullable: true
readOnly: false
type: array
excludeImmutable:
description: The excludeImmutable field.
readOnly: false
type: boolean
excludeResourceTypeIds:
description: The excludeResourceTypeIds field.
items:
type: string
nullable: true
readOnly: false
type: array
excludedEntitlementRefs:
description: The excludedEntitlementRefs field.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementRef'
nullable: true
readOnly: false
type: array
expandMask:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementExpandMask'
includeDeleted:
description: Include deleted app entitlements, this includes app entitlements that have a deleted parent object (app, app resou
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conductorone/refs/heads/main/openapi/conductorone-app-entitlement-api-openapi.yml