Nacelle Credentials API

openapi: 3.2.0
info:
  description: The Auth API is used to manage credentials and tokens for nacelle authentication and authorization.
  title: Auth Credentials API
  version: 0.1.0
servers:
- url: http://authimilate.api.nacelle.com/v1
- url: https://authimilate.api.nacelle.com/v1
security:
- oauth2: []
tags:
- name: Credentials
paths:
  /credential:
    post:
      description: This will create a new nacelle credential based on the input parameters.
      operationId: createCredential
      parameters:
      - in: header
        name: X-Nacelle-Space-ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsRequest'
        required: true
      responses:
        '200':
          description: Credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credentials'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      summary: Create a new nacelle credential
      tags:
      - Credentials
  /credential/list/available:
    get:
      description: This will list all available nacelle credentials based on the input parameters.
      operationId: listCredentials
      parameters:
      - in: header
        name: X-Nacelle-Space-ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: arrayCredential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/arrayCredential'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      summary: List all available nacelle credentials
      tags:
      - Credentials
  /credential/{client-id}:
    delete:
      description: This will delete a nacelle credential based on the input parameters.
      operationId: deleteCredential
      parameters:
      - in: header
        name: X-Nacelle-Space-ID
        required: true
        schema:
          type: string
      - in: path
        name: client-id
        required: true
        schema:
          type: string
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      summary: Delete a nacelle credential
      tags:
      - Credentials
    get:
      description: This will read all nacelle credentials based on the input parameters.
      operationId: readCredential
      parameters:
      - in: header
        name: X-Nacelle-Space-ID
        required: true
        schema:
          type: string
      - in: path
        name: client-id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credentials'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      summary: Read a nacelle credential
      tags:
      - Credentials
  /credential/{client-id}/refresh:
    post:
      description: This will rotate a nacelle credential secret based on the input parameters.
      operationId: rotateCredentialSecret
      parameters:
      - in: header
        name: X-Nacelle-Space-ID
        required: true
        schema:
          type: string
      - in: path
        name: client-id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credentials'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      summary: Rotate a nacelle credential secret
      tags:
      - Credentials
components:
  responses:
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '429':
      description: Rate Limit Exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '404':
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '204':
      description: No Content
      content:
        application/json:
          schema: {}
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
  schemas:
    arrayCredential:
      items:
        $ref: '#/components/schemas/Credentials'
      type: array
      x-go-package: github.com/getnacelle/authimilate/services/auth0-mgmt/pkg/model
    error:
      properties:
        code:
          description: A numeric error code.
          type: integer
        message:
          description: A description of the reason for the error.
          type: string
      type: object
    Credentials:
      properties:
        client_id:
          description: The unique client ID.
          example: abc123
          type: string
          x-go-name: ClientID
        client_secret:
          description: The client's secret key.
          example: secretKey123
          type: string
          x-go-name: ClientSecret
        description:
          description: A brief description for the client.
          example: A sample client application for demonstration.
          type: string
          x-go-name: Description
        last_updated:
          description: The last time the credentials were updated.
          example: '2023-01-10T14:48:00Z'
          format: date-time
          type: string
          x-go-name: LastUpdated
        name:
          description: The name of the client.
          example: MyClientApp
          type: string
          x-go-name: Name
        ttl:
          description: The time-to-live (in seconds) for the credentials.
          example: 3600
          format: int64
          type: integer
          x-go-name: TTL
      required:
      - client_id
      - client_secret
      - last_updated
      title: Credentials holds information about client credentials.
      type: object
      x-go-package: github.com/getnacelle/authimilate/services/auth0-mgmt/pkg/model
    CredentialsRequest:
      properties:
        description:
          description: The description of the credentials.
          example: This is a sample description for the credentials.
          type: string
          x-go-name: Description
        name:
          description: The name of the credentials.
          example: Sample Name
          type: string
          x-go-name: Name
      title: CredentialsRequest represents the request to create a new credentials.
      type: object
      x-go-package: github.com/getnacelle/authimilate/services/auth0-mgmt/pkg/model
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://authimilate.api.nacelle.com/v1/token
          scopes:
            read: Grants read access
            write: Grants write access
x-provenance:
  method: searched
  source: https://docs.nacelle.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.nacelle.com/reference/createcredential.md
  - https://docs.nacelle.com/reference/createprivatetoken.md
  - https://docs.nacelle.com/reference/deletecredential.md
  - https://docs.nacelle.com/reference/issuepublictoken.md
  - https://docs.nacelle.com/reference/listcredentials.md
  - https://docs.nacelle.com/reference/readcredential.md
  - https://docs.nacelle.com/reference/rotatecredentialsecret.md
  merge:
    pages: 7
    deduped: 51
    conflicts_kept_first: 0