C1

C1 Compliance Framework API

The Compliance Framework API from C1 — 2 operation(s) for compliance framework.

OpenAPI Specification

c1-compliance-framework-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
  title: ConductorOne Access Conflict Compliance Framework 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: Compliance Framework
paths:
  /api/v1/attributes/compliance_frameworks:
    get:
      description: Invokes the c1.api.attribute.v1.Attributes.ListComplianceFrameworks method.
      operationId: c1.api.attribute.v1.Attributes.ListComplianceFrameworks
      parameters:
      - 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.attribute.v1.ListComplianceFrameworksResponse'
          description: Successful response
      summary: List Compliance Frameworks
      tags:
      - Compliance Framework
      x-speakeasy-entity-operation:
        terraform-datasource: Compliance Frameworks#read
        terraform-resource: null
      x-speakeasy-group: Attributes
      x-speakeasy-name-override: ListComplianceFrameworks
    post:
      description: Create a compliance framework value.
      operationId: c1.api.attribute.v1.Attributes.CreateComplianceFrameworkAttributeValue
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.attribute.v1.CreateComplianceFrameworkAttributeValueRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.attribute.v1.CreateComplianceFrameworkAttributeValueResponse'
          description: Successful response
      summary: Create Compliance Framework Attribute Value
      tags:
      - Compliance Framework
      x-speakeasy-entity-operation:
        terraform-resource: Compliance Framework#create
      x-speakeasy-group: Attributes
      x-speakeasy-name-override: CreateComplianceFrameworkAttributeValue
  /api/v1/attributes/compliance_frameworks/{id}:
    delete:
      description: Delete an attribute value by id.
      operationId: c1.api.attribute.v1.Attributes.DeleteComplianceFrameworkAttributeValue
      parameters:
      - 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.attribute.v1.DeleteComplianceFrameworkAttributeValueRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.attribute.v1.DeleteComplianceFrameworkAttributeValueResponse'
          description: Successful response
      summary: Delete Compliance Framework Attribute Value
      tags:
      - Compliance Framework
      x-speakeasy-entity-operation:
        terraform-resource: Compliance Framework#delete
      x-speakeasy-group: Attributes
      x-speakeasy-name-override: DeleteComplianceFrameworkAttributeValue
    get:
      description: Get an attribute value by id.
      operationId: c1.api.attribute.v1.Attributes.GetComplianceFrameworkAttributeValue
      parameters:
      - 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.attribute.v1.GetComplianceFrameworkAttributeValueResponse'
          description: Successful response
      summary: Get Compliance Framework Attribute Value
      tags:
      - Compliance Framework
      x-speakeasy-entity-operation:
        terraform-datasource: Compliance Framework#read
        terraform-resource: Compliance Framework#read
      x-speakeasy-group: Attributes
      x-speakeasy-name-override: GetComplianceFrameworkAttributeValue
components:
  schemas:
    c1.api.attribute.v1.CreateComplianceFrameworkAttributeValueResponse:
      description: The CreateComplianceFrameworkAttributeValueResponse message.
      properties:
        value:
          $ref: '#/components/schemas/c1.api.attribute.v1.AttributeValue'
      title: Create Compliance Framework Attribute Value Response
      type: object
      x-speakeasy-name-override: CreateComplianceFrameworkAttributeValueResponse
    c1.api.attribute.v1.DeleteComplianceFrameworkAttributeValueResponse:
      description: The DeleteComplianceFrameworkAttributeValueResponse message.
      title: Delete Compliance Framework Attribute Value Response
      type: object
      x-speakeasy-name-override: DeleteComplianceFrameworkAttributeValueResponse
    c1.api.attribute.v1.CreateComplianceFrameworkAttributeValueRequest:
      description: The CreateComplianceFrameworkAttributeValueRequest message.
      properties:
        value:
          description: The value field.
          readOnly: false
          type: string
      title: Create Compliance Framework Attribute Value Request
      type: object
      x-speakeasy-name-override: CreateComplianceFrameworkAttributeValueRequest
    c1.api.attribute.v1.ListComplianceFrameworksResponse:
      description: The ListComplianceFrameworksResponse message.
      properties:
        list:
          description: The list field.
          items:
            $ref: '#/components/schemas/c1.api.attribute.v1.AttributeValue'
          nullable: true
          readOnly: false
          type: array
        nextPageToken:
          description: The nextPageToken field.
          readOnly: false
          type: string
      title: List Compliance Frameworks Response
      type: object
      x-speakeasy-name-override: ListComplianceFrameworksResponse
    c1.api.attribute.v1.AttributeValue:
      description: AttributeValue is the value of an attribute of a defined type.
      properties:
        attributeTypeId:
          description: The ID of the AttributeType that this AttributeValue belongs to.
          readOnly: false
          type: string
        createdAt:
          format: date-time
          readOnly: true
          type: string
        deletedAt:
          format: date-time
          readOnly: true
          type: string
        id:
          description: The ID of the AttributeValue.
          readOnly: false
          type: string
        updatedAt:
          format: date-time
          readOnly: true
          type: string
        value:
          description: The value of the AttributeValue. This is the string that will be displayed to the user.
          readOnly: false
          type: string
      title: Attribute Value
      type: object
      x-speakeasy-name-override: AttributeValue
    c1.api.attribute.v1.DeleteComplianceFrameworkAttributeValueRequestInput:
      description: The DeleteComplianceFrameworkAttributeValueRequest message.
      title: Delete Compliance Framework Attribute Value Request
      type: object
      x-speakeasy-name-override: DeleteComplianceFrameworkAttributeValueRequest
    c1.api.attribute.v1.GetComplianceFrameworkAttributeValueResponse:
      description: The GetComplianceFrameworkAttributeValueResponse message.
      properties:
        value:
          $ref: '#/components/schemas/c1.api.attribute.v1.AttributeValue'
      title: Get Compliance Framework Attribute Value Response
      type: object
      x-speakeasy-name-override: GetComplianceFrameworkAttributeValueResponse
  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