ConductorOne AWS External ID Settings API

The AWS External ID Settings API from ConductorOne — 1 operation(s) for aws external id settings.

OpenAPI Specification

conductorone-aws-external-id-settings-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 AWS External ID Settings 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: AWS External ID Settings
paths:
  /api/v1/settings/aws-external-id:
    get:
      description: Invokes the c1.api.settings.v1.AWSExternalIDSettings.Get method.
      operationId: c1.api.settings.v1.AWSExternalIDSettings.Get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.settings.v1.GetAWSExternalIDResponse'
          description: Successful response
      summary: Get
      tags:
      - AWS External ID Settings
      x-speakeasy-entity-operation:
        terraform-datasource: AWS_EXTERNAL_ID#read
        terraform-resource: AWS_EXTERNAL_ID#read
      x-speakeasy-group: AWSExternalIDSettings
      x-speakeasy-name-override: Get
components:
  schemas:
    c1.api.settings.v1.GetAWSExternalIDResponse:
      description: The GetAWSExternalIDResponse message.
      properties:
        awsExternalId:
          $ref: '#/components/schemas/c1.api.settings.v1.AWSExternalID'
      title: Get Aws External Id Response
      type: object
      x-speakeasy-name-override: GetAWSExternalIDResponse
    c1.api.settings.v1.AWSExternalID:
      description: The AWSExternalID message.
      properties:
        externalId:
          description: The externalId field.
          readOnly: false
          type: string
      title: Aws External Id
      type: object
      x-speakeasy-entity: AWS_EXTERNAL_ID
      x-speakeasy-name-override: AWSExternalID
  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