C1 App Resource Type API
The App Resource Type API from C1 — 2 operation(s) for app resource type.
OpenAPI Specification
openapi: 3.1.0
info:
description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
title: ConductorOne Access Conflict App Resource Type 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 Resource Type
paths:
/api/v1/apps/{app_id}/resource_types:
get:
description: List app resource types.
operationId: c1.api.app.v1.AppResourceTypeService.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.AppResourceTypeServiceListResponse'
description: The AppResourceTypeServiceListResponse message contains a list of results and a nextPageToken if applicable.
summary: List
tags:
- App Resource Type
x-speakeasy-group: AppResourceType
x-speakeasy-name-override: List
post:
description: Invokes the c1.api.app.v1.AppResourceTypeService.CreateManuallyManagedResourceType method.
operationId: c1.api.app.v1.AppResourceTypeService.CreateManuallyManagedResourceType
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.CreateManuallyManagedResourceTypeRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.CreateManuallyManagedResourceTypeResponse'
description: Successful response
summary: Create Manually Managed Resource Type
tags:
- App Resource Type
x-speakeasy-entity-operation:
terraform-resource: App Resource Type#create
x-speakeasy-group: AppResourceType
x-speakeasy-name-override: CreateManuallyManagedResourceType
/api/v1/apps/{app_id}/resource_types/{id}:
delete:
description: Invokes the c1.api.app.v1.AppResourceTypeService.DeleteManuallyManagedResourceType method.
operationId: c1.api.app.v1.AppResourceTypeService.DeleteManuallyManagedResourceType
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 resourceTypeId field.
readOnly: false
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.DeleteManuallyManagedResourceTypeRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.DeleteManuallyManagedResourceTypeResponse'
description: Successful response
summary: Delete Manually Managed Resource Type
tags:
- App Resource Type
x-speakeasy-entity-operation:
terraform-resource: App Resource Type#delete
x-speakeasy-group: AppResourceType
x-speakeasy-name-override: DeleteManuallyManagedResourceType
get:
description: Get an app resource type.
operationId: c1.api.app.v1.AppResourceTypeService.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.AppResourceTypeServiceGetResponse'
description: "The AppResourceTypeServiceGetResponse contains an expanded array containing the expanded values indicated by the expand mask\n in the request and an app resource type view containing the resource type and JSONPATHs indicating which objects are where in the expand mask."
summary: Get
tags:
- App Resource Type
x-speakeasy-entity-operation:
terraform-datasource: null
terraform-resource: App Resource Type#read
x-speakeasy-group: AppResourceType
x-speakeasy-name-override: Get
post:
description: Invokes the c1.api.app.v1.AppResourceTypeService.UpdateManuallyManagedResourceType method.
operationId: c1.api.app.v1.AppResourceTypeService.UpdateManuallyManagedResourceType
parameters:
- in: path
name: app_id
required: true
schema:
description: The ID of the app that is associated with the app resource type
readOnly: true
type: string
- in: path
name: id
required: true
schema:
description: The unique ID for the app resource type.
readOnly: true
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.UpdateManuallyManagedResourceTypeRequestInput'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.app.v1.UpdateManuallyManagedResourceTypeResponse'
description: Successful response
summary: Update Manually Managed Resource Type
tags:
- App Resource Type
x-speakeasy-entity-operation:
terraform-resource: App Resource Type#update
x-speakeasy-group: AppResourceType
x-speakeasy-name-override: UpdateManuallyManagedResourceType
components:
schemas:
c1.api.app.v1.AppResourceTypeServiceGetResponse:
description: "The AppResourceTypeServiceGetResponse contains an expanded array containing the expanded values indicated by the expand mask\n in the request and an app resource type view containing the resource type and JSONPATHs indicating which objects are where in the expand mask."
properties:
appResourceTypeView:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceTypeView'
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: App Resource Type Service Get Response
type: object
x-speakeasy-name-override: AppResourceTypeServiceGetResponse
c1.api.app.v1.UpdateManuallyManagedResourceTypeRequestInput:
description: The UpdateManuallyManagedResourceTypeRequest message.
properties:
appResourceType:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceType'
updateMask:
nullable: true
readOnly: false
type: string
title: Update Manually Managed Resource Type Request
type: object
x-speakeasy-name-override: UpdateManuallyManagedResourceTypeRequest
c1.api.app.v1.AppResourceTypeServiceListResponse:
description: The AppResourceTypeServiceListResponse message contains a list of results and a nextPageToken if applicable.
properties:
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
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.AppResourceTypeView'
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.\n The server returns one page of results and the nextPageToken until all results are retreived.\n 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: App Resource Type Service List Response
type: object
x-speakeasy-name-override: AppResourceTypeServiceListResponse
c1.api.app.v1.CreateManuallyManagedResourceTypeResponse:
description: The CreateManuallyManagedResourceTypeResponse message.
properties:
appResourceType:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceType'
expanded:
description: The expanded field.
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: Create Manually Managed Resource Type Response
type: object
x-speakeasy-name-override: CreateManuallyManagedResourceTypeResponse
c1.api.app.v1.CreateManuallyManagedResourceTypeRequestInput:
description: The CreateManuallyManagedResourceTypeRequest message.
properties:
displayName:
description: The displayName field.
readOnly: false
type: string
resourceType:
description: The resourceType field.
enum:
- ROLE
- GROUP
- LICENSE
- PROJECT
- CATALOG
- CUSTOM
- VAULT
- PROFILE_TYPE
readOnly: false
type: string
x-speakeasy-unknown-values: allow
required:
- resourceType
- displayName
title: Create Manually Managed Resource Type Request
type: object
x-speakeasy-name-override: CreateManuallyManagedResourceTypeRequest
c1.api.app.v1.UpdateManuallyManagedResourceTypeResponse:
description: The UpdateManuallyManagedResourceTypeResponse message.
properties:
appResourceType:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceType'
expanded:
description: The expanded field.
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 Manually Managed Resource Type Response
type: object
x-speakeasy-name-override: UpdateManuallyManagedResourceTypeResponse
c1.api.app.v1.AppResourceTypeView:
description: The AppResourceTypeView message.
properties:
appPath:
description: JSONPATH expression indicating the location of the App object in the array
readOnly: false
type: string
appResourceType:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceType'
title: App Resource Type View
type: object
x-speakeasy-name-override: AppResourceTypeView
c1.api.app.v1.DeleteManuallyManagedResourceTypeResponse:
description: The DeleteManuallyManagedResourceTypeResponse message.
title: Delete Manually Managed Resource Type Response
type: object
x-speakeasy-name-override: DeleteManuallyManagedResourceTypeResponse
c1.api.app.v1.AppResourceType:
description: The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.
properties:
appId:
description: The ID of the app that is associated with the app resource type
readOnly: true
type: string
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
displayName:
description: The display name of the app resource type.
readOnly: false
type: string
id:
description: The unique ID for the app resource type.
readOnly: true
type: string
traitIds:
description: Associated trait ids
items:
type: string
nullable: true
readOnly: false
type: array
updatedAt:
format: date-time
readOnly: true
type: string
title: App Resource Type
type: object
x-speakeasy-entity: App Resource Type
x-speakeasy-name-override: AppResourceType
c1.api.app.v1.DeleteManuallyManagedResourceTypeRequestInput:
description: The DeleteManuallyManagedResourceTypeRequest message.
title: Delete Manually Managed Resource Type Request
type: object
x-speakeasy-name-override: DeleteManuallyManagedResourceTypeRequest
securitySchemes:
bearerAuth:
scheme: bearer
type: http
oauth:
description: '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, refer to the [c1TokenSource.Token()](https://github.com/ConductorOne/conductorone-sdk-go/blob/3375fe7c0126d17e7ec4e711693dee7b791023aa/token_source.go#L101-L187) function.'
flows:
clientCredentials:
scopes: {}
tokenUrl: /auth/v1/token
type: oauth2