Microsoft Azure Secrets API

openapi: 3.2.0
info:
  title: Microsoft Azure Secrets API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Secrets across 2 of this provider''s published API definitions: azure-key-vault-openapi.yml, devtestlabsclient-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{vaultName}.vault.azure.net
  description: Azure Key Vault endpoint
  variables:
    vaultName:
      default: mykeyvault
      description: The name of the Azure Key Vault.
- url: https://management.azure.com
tags:
- name: Secrets
  description: Operations for managing secrets
paths:
  /secrets:
    get:
      operationId: Secrets_List
      summary: Microsoft Azure List Secrets
      description: List secrets in the specified vault. The Get Secrets operation applies to the entire vault. However, only the base secret identifier and its attributes are provided in the response.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: maxresults
        in: query
        description: Maximum number of results to return in a page (1-25).
        schema:
          type: integer
          minimum: 1
          maximum: 25
        example: 10
      responses:
        '200':
          description: Successfully returned the list of secrets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretListResult'
              examples:
                SecretsList200Example:
                  summary: Default Secrets_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      tags: example_value
                      contentType: example_value
                      managed: true
                    nextLink: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                SecretsListdefaultExample:
                  summary: Default Secrets_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      innererror:
                        code: example_value
                        innererror: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2:
        - https://vault.azure.net/.default
    servers:
    - url: https://{vaultName}.vault.azure.net
      description: Azure Key Vault endpoint
      variables:
        vaultName:
          default: mykeyvault
          description: The name of the Azure Key Vault.
  /secrets/{secret-name}:
    put:
      operationId: Secrets_Set
      summary: Microsoft Azure Set a Secret
      description: Sets a secret in the specified vault. The set operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret.
      tags:
      - Secrets
      parameters:
      - name: secret-name
        in: path
        required: true
        description: The name of the secret.
        schema:
          type: string
          pattern: ^[0-9a-zA-Z-]+$
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretSetParameters'
            examples:
              SecretsSetRequestExample:
                summary: Default Secrets_Set request
                x-microcks-default: true
                value:
                  value: example_value
                  tags: example_value
                  contentType: example_value
                  secretAttributes:
                    enabled: true
                    nbf: 10
                    exp: 10
                    created: 10
                    updated: 10
                    recoveryLevel: example_value
                    recoverableDays: 10
      responses:
        '200':
          description: Successfully set the secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretBundle'
              examples:
                SecretsSet200Example:
                  summary: Default Secrets_Set 200 response
                  x-microcks-default: true
                  value:
                    value: example_value
                    id: abc123
                    contentType: example_value
                    attributes:
                      enabled: true
                      nbf: 10
                      exp: 10
                      created: 10
                      updated: 10
                      recoveryLevel: example_value
                      recoverableDays: 10
                    tags: example_value
                    kid: '500123'
                    managed: true
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                SecretsSetdefaultExample:
                  summary: Default Secrets_Set default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      innererror:
                        code: example_value
                        innererror: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2:
        - https://vault.azure.net/.default
    delete:
      operationId: Secrets_Delete
      summary: Microsoft Azure Delete a Secret
      description: Deletes a secret from a specified key vault.
      tags:
      - Secrets
      parameters:
      - name: secret-name
        in: path
        required: true
        description: The name of the secret to delete.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedSecretBundle'
              examples:
                SecretsDelete200Example:
                  summary: Default Secrets_Delete 200 response
                  x-microcks-default: true
                  value:
                    recoveryId: '500123'
                    scheduledPurgeDate: 10
                    deletedDate: 10
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                SecretsDeletedefaultExample:
                  summary: Default Secrets_Delete default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      innererror:
                        code: example_value
                        innererror: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2:
        - https://vault.azure.net/.default
    servers:
    - url: https://{vaultName}.vault.azure.net
      description: Azure Key Vault endpoint
      variables:
        vaultName:
          default: mykeyvault
          description: The name of the Azure Key Vault.
  /secrets/{secret-name}/{secret-version}:
    get:
      operationId: Secrets_Get
      summary: Microsoft Azure Get a Secret
      description: Get a specified secret from a given key vault. The GET operation is applicable to any secret stored in Azure Key Vault.
      tags:
      - Secrets
      parameters:
      - name: secret-name
        in: path
        required: true
        description: The name of the secret.
        schema:
          type: string
        example: example_value
      - name: secret-version
        in: path
        required: true
        description: The version of the secret. Use empty string for the latest version.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretBundle'
              examples:
                SecretsGet200Example:
                  summary: Default Secrets_Get 200 response
                  x-microcks-default: true
                  value:
                    value: example_value
                    id: abc123
                    contentType: example_value
                    attributes:
                      enabled: true
                      nbf: 10
                      exp: 10
                      created: 10
                      updated: 10
                      recoveryLevel: example_value
                      recoverableDays: 10
                    tags: example_value
                    kid: '500123'
                    managed: true
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                SecretsGetdefaultExample:
                  summary: Default Secrets_Get default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      innererror:
                        code: example_value
                        innererror: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2:
        - https://vault.azure.net/.default
    servers:
    - url: https://{vaultName}.vault.azure.net
      description: Azure Key Vault endpoint
      variables:
        vaultName:
          default: mykeyvault
          description: The name of the Azure Key Vault.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets
  : get:
      tags:
      - Secrets
      description: List secrets in a given user profile.
      operationId: microsoftAzureSecretsList
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=value)'''
        schema:
          type: string
      - name: $filter
        in: query
        description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        schema:
          type: string
      - name: $top
        in: query
        description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        schema:
          type: integer
          format: int32
      - name: $orderby
        in: query
        description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretList'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/Secret'
      x-ms-examples:
        Secrets_List:
          $ref: ./examples/Secrets_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
  : get:
      tags:
      - Secrets
      description: Get secret.
      operationId: microsoftAzureSecretsGet
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=value)'''
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Secrets_Get:
          $ref: ./examples/Secrets_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    put:
      tags:
      - Secrets
      description: Create or replace an existing secret. This operation can take a while to complete.
      operationId: microsoftAzureSecretsCreateorupdate
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Secrets_CreateOrUpdate:
          $ref: ./examples/Secrets_CreateOrUpdate.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Secret'
        description: A secret.
        required: true
      security:
      - azure_auth:
        - user_impersonation
    delete:
      tags:
      - Secrets
      description: Delete secret.
      operationId: microsoftAzureSecretsDelete
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Secrets_Delete:
          $ref: ./examples/Secrets_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    patch:
      tags:
      - Secrets
      description: Allows modifying tags of secrets. All other properties will be ignored.
      operationId: microsoftAzureSecretsUpdate
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Secrets_Update:
          $ref: ./examples/Secrets_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretFragment'
        description: A secret.
        required: true
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
components:
  schemas:
    SecretAttributes:
      type: object
      description: The secret management attributes.
      properties:
        enabled:
          type: boolean
          description: Whether the secret is enabled.
          example: true
        nbf:
          type: integer
          description: Not before date in UTC (Unix time).
          example: 10
        exp:
          type: integer
          description: Expiry date in UTC (Unix time).
          example: 10
        created:
          type: integer
          readOnly: true
          description: Creation time in UTC (Unix time).
          example: 10
        updated:
          type: integer
          readOnly: true
          description: Last updated time in UTC (Unix time).
          example: 10
        recoveryLevel:
          type: string
          readOnly: true
          description: The recovery level currently in effect.
          example: example_value
        recoverableDays:
          type: integer
          readOnly: true
          description: The soft-delete data retention days.
          example: 10
    SecretItem:
      type: object
      description: The secret item containing secret metadata.
      properties:
        id:
          type: string
          description: Secret identifier.
          example: abc123
        attributes:
          $ref: '#/components/schemas/SecretAttributes'
        tags:
          type: object
          additionalProperties:
            type: string
          example: example_value
        contentType:
          type: string
          example: example_value
        managed:
          type: boolean
          readOnly: true
          example: true
    SecretSetParameters:
      type: object
      description: The secret set parameters.
      properties:
        value:
          type: string
          description: The value of the secret.
          example: example_value
        tags:
          type: object
          additionalProperties:
            type: string
          description: Application-specific metadata.
          example: example_value
        contentType:
          type: string
          description: Type of the secret value such as a password.
          example: example_value
        secretAttributes:
          $ref: '#/components/schemas/SecretAttributes'
      required:
      - value
    DeletedSecretBundle:
      type: object
      description: A deleted secret bundle.
      allOf:
      - $ref: '#/components/schemas/SecretBundle'
      properties:
        recoveryId:
          type: string
          description: The URL of the recovery object.
          example: '500123'
        scheduledPurgeDate:
          type: integer
          description: The time when the secret is scheduled to be purged.
          example: 10
        deletedDate:
          type: integer
          description: The time when the secret was deleted.
          example: 10
    KeyVaultError:
      type: object
      description: The key vault error exception.
      properties:
        error:
          type: object
          readOnly: true
          description: The key vault server error.
          properties:
            code:
              type: string
              readOnly: true
              description: The error code.
            message:
              type: string
              readOnly: true
              description: The error message.
            innererror:
              type: object
              readOnly: true
              description: Inner error details.
              properties:
                code:
                  type: string
                  readOnly: true
                innererror:
                  type: object
                  readOnly: true
          example: example_value
    SecretListResult:
      type: object
      description: The secret list result.
      properties:
        value:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/SecretItem'
          description: A list of secrets.
          example: []
        nextLink:
          type: string
          readOnly: true
          description: The URL to get the next set of secrets.
          example: example_value
    SecretBundle:
      type: object
      description: A secret consisting of a value, id, and attributes.
      properties:
        value:
          type: string
          description: The secret value.
          example: example_value
        id:
          type: string
          description: The secret identifier.
          example: abc123
        contentType:
          type: string
          description: The content type of the secret.
          example: example_value
        attributes:
          $ref: '#/components/schemas/SecretAttributes'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Application-specific metadata.
          example: example_value
        kid:
          type: string
          readOnly: true
          description: If the secret is backing a KV certificate, then this field specifies the corresponding key backing the certificate.
          example: '500123'
        managed:
          type: boolean
          readOnly: true
          description: Whether the secret's lifetime is managed by Key Vault.
          example: true
    UpdateResource:
      description: Represents an update resource
      type: object
      properties:
        tags:
          description: The tags of the resource.
          type: object
          additionalProperties:
            type: string
    CloudError:
      description: Error from a REST request.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: The cloud error that occurred
      x-ms-external: true
    SecretFragment:
      description: A secret.
      type: object
      allOf:
      - $ref: '#/components/schemas/UpdateResource'
      properties: {}
    Secret:
      description: A secret.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/SecretProperties'
          description: The properties of the resource.
          x-ms-client-flatten: true
    CloudErrorBody:
      description: Body of an error from a REST request.
      type: object
      properties:
        code:
          description: The error code.
          type: string
        message:
          description: The error message.
          type: string
        target:
          description: The error target.
          type: string
        details:
          description: Inner errors.
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
      x-ms-external: true
    SecretProperties:
      description: Properties of a secret.
      type: object
      properties:
        value:
          description: The value of the secret for secret creation.
          type: string
        provisioningState:
          description: The provisioning status of the resource.
          type: string
          readOnly: true
        uniqueIdentifier:
          description: The unique immutable identifier of a resource (Guid).
          type: string
          readOnly: true
    SecretList:
      description: The response of a list operation.
      type: object
      properties:
        value:
          description: Results of the list operation.
          type: array
          items:
            $ref: '#/components/schemas/Secret'
        nextLink:
          description: Link for next set of results.
          type: string
    Resource:
      description: An Azure resource.
      type: object
      properties:
        id:
          description: The identifier of the resource.
          type: string
          readOnly: true
        name:
          description: The name of the resource.
          type: string
          readOnly: true
        type:
          description: The type of the resource.
          type: string
          readOnly: true
        location:
          description: The location of the resource.
          type: string
        tags:
          description: The tags of the resource.
          type: object
          additionalProperties:
            type: string
      x-ms-azure-resource: true
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version.
      schema:
        type: string
        default: '7.5'
    api-version:
      name: api-version
      in: query
      description: Client API version.
      required: true
      schema:
        type: string
        default: '2018-09-15'
    subscriptionId:
      name: subscriptionId
      in: path
      description: The subscription ID.
      required: true
      schema:
        type: string
    resourceGroupName:
      name: resourceGroupName
      in: path
      description: The name of the resource group.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            https://vault.azure.net/.default: Access Azure Key Vault
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: Access Microsoft Azure
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: OAuth2 Implicit Grant
x-refined-from:
- azure-key-vault-openapi.yml
- devtestlabsclient-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'