openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Credential API
  description: >-
    Manage credential artifacts used for authenticating with external data
    sources in Synapse workspaces. Supports creating and managing credentials
    referenced by linked services and datasets.
  version: '2020-12-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  license:
    name: Microsoft
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
  - url: https://{workspaceName}.dev.azuresynapse.net
    description: Synapse Data Plane
    variables:
      workspaceName:
        default: myworkspace
security:
  - azure_auth:
      - user_impersonation
paths:
  /credentials:
    get:
      operationId: Credential_GetCredentialsByWorkspace
      summary: Azure Synapse Analytics List credentials
      description: Lists credentials in the workspace.
      tags:
        - Credential
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialListResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /credentials/{credentialName}:
    get:
      operationId: Credential_GetCredential
      summary: Azure Synapse Analytics Get a credential
      description: Gets a credential.
      tags:
        - Credential
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/CredentialNameParameter'
        - name: If-None-Match
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialResource'
        '304':
          description: Not modified.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Credential_CreateOrUpdateCredential
      summary: Azure Synapse Analytics Create or update a credential
      description: Creates or updates a credential.
      tags:
        - Credential
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/CredentialNameParameter'
        - name: If-Match
          in: header
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialResource'
      responses:
        '200':
          description: Successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialResource'
        '202':
          description: Creation accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: Credential_DeleteCredential
      summary: Azure Synapse Analytics Delete a credential
      description: Deletes a credential.
      tags:
        - Credential
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/CredentialNameParameter'
      responses:
        '200':
          description: Successfully deleted.
        '202':
          description: Deletion accepted.
        '204':
          description: Not found.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /credentials/{credentialName}/rename:
    post:
      operationId: Credential_RenameCredential
      summary: Azure Synapse Analytics Rename a credential
      description: Renames a credential.
      tags:
        - Credential
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/CredentialNameParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactRenameRequest'
      responses:
        '200':
          description: Successfully renamed.
        '202':
          description: Rename accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2020-12-01'
    CredentialNameParameter:
      name: credentialName
      in: path
      required: true
      description: The credential name.
      schema:
        type: string
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    CredentialListResponse:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/CredentialResource'
        nextLink:
          type: string
    CredentialResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        etag:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/Credential'
    Credential:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          description: Credential type.
          enum:
            - ManagedIdentity
            - ServicePrincipal
        description:
          type: string
        annotations:
          type: array
          items:
            type: string
        typeProperties:
          type: object
          description: Type-specific properties.
    ArtifactRenameRequest:
      type: object
      properties:
        newName:
          type: string
tags:
  - name: Credential