> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Service Account

> Create a service account for machine identity use (CI/CD pipelines, IaC tooling, Terraform automation). The `client_id` in the response is used for OAuth 2.0 client credentials authentication. This endpoint is idempotent by `external_id`: a second POST with the same `external_id` returns the existing record.




## OpenAPI

````yaml en/API/Management-API.yaml POST /service-accounts
openapi: 3.1.0
info:
  title: CData Connect AI Management API
  version: v1
  description: >
    The Connect AI Management API provides programmatic control over enterprise
    platform administration. Base path: /api/v1/admin. Use it to manage users,
    service accounts, roles, and resource permissions without manual UI
    operations. The API follows OAS 3.0 standards with OAuth 2.0 scoped
    authentication.

    On versioning: the version prefix is incremented when breaking changes
    require it. A new /api/v2/admin path will be introduced with a 6-month
    deprecation notice before any v1 endpoint is retired.

    On human users vs. service accounts: human users are provisioned and
    lifecycle-managed by SCIM; the Management API handles direct overrides and
    atomic deprovisioning. Service accounts (CI/CD pipelines, IaC tooling,
    Terraform) are fully managed via the Management API and are not SCIM-owned.
servers:
  - url: https://cloud.cdata.com/api/v1/admin
    description: Production base URL
security:
  - oauth2: []
tags:
  - name: Users
    description: >
      Lifecycle management for human users: create, update, deprovision, and
      manage direct role assignments, workspace-scoped roles, and direct
      resource permissions. SCIM handles group-based provisioning and user
      creation at scale; this API handles direct overrides and atomic
      deprovisioning.
  - name: Service Accounts
    description: >
      Full lifecycle management for machine identities (CI/CD pipelines, IaC
      tooling, Terraform automation). Service accounts are not SCIM-owned and
      authenticate via OAuth 2.0 client credentials using the `client_id`
      returned on creation.
paths:
  /service-accounts:
    post:
      tags:
        - Service Accounts
      summary: Create Service Account
      description: >
        Create a service account for machine identity use (CI/CD pipelines, IaC
        tooling, Terraform automation). The `client_id` in the response is used
        for OAuth 2.0 client credentials authentication. This endpoint is
        idempotent by `external_id`: a second POST with the same `external_id`
        returns the existing record.
      operationId: createServiceAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceAccountRequest'
            example:
              name: pipeline-deploy-prod
              description: Terraform deployment pipeline for production
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceAccount'
              example:
                id: c3d4e5f6-a7b8-9012-cdef-123456789012
                name: pipeline-deploy-prod
                description: Terraform deployment pipeline for production
                status: active
                client_id: d4e5f6a7-b8c9-0123-defa-234567890123
                external_id: null
                created_at: '2026-06-01T08:00:00Z'
                created_by: 00000000-0000-0000-0000-000000000001
        '400':
          $ref: '#/components/responses/ValidationError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                already_exists:
                  summary: Name already in use
                  value:
                    error:
                      code: SERVICE_ACCOUNT_ALREADY_EXISTS
                      message: >-
                        A service account with this name already exists in the
                        organization.
      security:
        - oauth2:
            - management:service-accounts:write
components:
  schemas:
    CreateServiceAccountRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Unique display name within the organization.
        description:
          type: string
          description: Optional free-text description of the service account.
        external_id:
          type: string
          description: >-
            Idempotency key. A second POST with the same `external_id` returns
            the existing record.
    ServiceAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Service account identifier.
        name:
          type: string
          description: Unique display name within the organization.
        description:
          type: string
          nullable: true
          description: Optional free-text description of the service account.
        status:
          type: string
          enum:
            - active
            - deactivated
          description: Current lifecycle state of the service account.
        client_id:
          type: string
          format: uuid
          description: >-
            Auto-generated. Used for OAuth 2.0 client credentials
            authentication.
        external_id:
          type: string
          nullable: true
          description: Idempotency key supplied by the calling system.
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC.
        created_by:
          type: string
          format: uuid
          description: User ID of the creator.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          description: Error details.
          properties:
            code:
              type: string
              description: SCREAMING_SNAKE_CASE error code.
            message:
              type: string
              description: Human-readable error description.
  responses:
    ValidationError:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: VALIDATION_ERROR
              message: Missing required field or invalid value.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cloud-login.cdata.com/oauth/token
          scopes:
            management:users:read: Read access to user resources.
            management:users:write: Write access to user resources.
            management:service-accounts:read: Read access to service account resources.
            management:service-accounts:write: Write access to service account resources.

````