C1

C1 Org Domain API

The Org Domain API from C1 — 1 operation(s) for org domain.

OpenAPI Specification

c1-org-domain-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 Org Domain 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: Org Domain
paths:
  /api/v1/settings/domains:
    get:
      description: Invokes the c1.api.settings.v1.OrgDomainService.List method.
      operationId: c1.api.settings.v1.OrgDomainService.List
      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.settings.v1.ListOrgDomainsResponse'
          description: Successful response
      summary: List
      tags:
      - Org Domain
      x-speakeasy-group: OrgDomain
      x-speakeasy-name-override: List
    put:
      description: Invokes the c1.api.settings.v1.OrgDomainService.Update method.
      operationId: c1.api.settings.v1.OrgDomainService.Update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.settings.v1.UpdateOrgDomainRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.settings.v1.UpdateOrgDomainResponse'
          description: Successful response
      summary: Update
      tags:
      - Org Domain
      x-speakeasy-group: OrgDomain
      x-speakeasy-name-override: Update
components:
  schemas:
    c1.api.settings.v1.UpdateOrgDomainResponse:
      description: The UpdateOrgDomainResponse message.
      properties:
        list:
          description: The list field.
          items:
            $ref: '#/components/schemas/c1.api.settings.v1.OrgDomain'
          nullable: true
          readOnly: false
          type: array
      title: Update Org Domain Response
      type: object
      x-speakeasy-name-override: UpdateOrgDomainResponse
    c1.api.settings.v1.ListOrgDomainsResponse:
      description: The ListOrgDomainsResponse message.
      properties:
        list:
          description: The list field.
          items:
            $ref: '#/components/schemas/c1.api.settings.v1.OrgDomain'
          nullable: true
          readOnly: false
          type: array
        nextPageToken:
          description: The nextPageToken field.
          readOnly: false
          type: string
      title: List Org Domains Response
      type: object
      x-speakeasy-name-override: ListOrgDomainsResponse
    c1.api.settings.v1.OrgDomain:
      description: The OrgDomain message.
      properties:
        createdAt:
          format: date-time
          readOnly: true
          type: string
        deletedAt:
          format: date-time
          readOnly: true
          type: string
        domain:
          description: The domain field.
          readOnly: false
          type: string
        id:
          description: The id field.
          readOnly: false
          type: string
        updatedAt:
          format: date-time
          readOnly: true
          type: string
      title: Org Domain
      type: object
      x-speakeasy-name-override: OrgDomain
    c1.api.settings.v1.UpdateOrgDomainRequest:
      description: The UpdateOrgDomainRequest message.
      properties:
        newDomains:
          description: The newDomains field.
          items:
            type: string
          nullable: true
          readOnly: false
          type: array
      title: Update Org Domain Request
      type: object
      x-speakeasy-name-override: UpdateOrgDomainRequest
  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