swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector EndpointKeys API
schemes:
- https
tags:
- name: EndpointKeys
paths:
  /endpointSettings:
    patch:
      tags:
      - EndpointKeys
      summary: Microsoft Azure Updates Endpoint Settings For An Endpoint
      operationId: microsoftAzureEndpointsettingsUpdatesettings
      parameters:
      - $ref: '#/parameters/EndpointSettingsPayload'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '204':
          description: HTTP 204 No Content.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulSetEpSettings.json
      description: Needs a more full description created.
  /endpointkeys/{keyType}:
    patch:
      tags:
      - EndpointKeys
      summary: Microsoft Azure Re Generates An Endpoint Key
      operationId: microsoftAzureEndpointkeysRefreshkeys
      parameters:
      - $ref: '#/parameters/KeyType'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: Details of the endpoint keys generated.
          schema:
            $ref: '#/definitions/EndpointKeysDTO'
          x-nullable: true
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulSetEpKeys.json
      description: Needs a more full description created.
  /endpointkeys:
    get:
      summary: Microsoft Azure Gets Endpoint Keys For An Endpoint
      operationId: microsoftAzureEndpointkeysGetkeys
      parameters: []
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: Response with endpoint info in it.
          schema:
            $ref: '#/definitions/EndpointKeysDTO'
          x-nullable: true
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulGetEpKeys.json
      description: Needs a more full description created.
      tags:
      - EndpointKeys
definitions:
  ErrorResponse:
    type: object
    description: Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    additionalProperties: false
    properties:
      error:
        description: The error object.
        allOf:
        - $ref: '#/definitions/Error'
  ErrorCode:
    type: string
    description: Human readable error code.
    x-ms-enum:
      name: ErrorCodeType
      modelAsString: true
    enum:
    - BadArgument
    - Forbidden
    - NotFound
    - KbNotFound
    - Unauthorized
    - Unspecified
    - EndpointKeysError
    - QuotaExceeded
    - QnaRuntimeError
    - SKULimitExceeded
    - OperationNotFound
    - ServiceError
    - ValidationFailure
    - ExtractionFailure
  InnerErrorModel:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    additionalProperties: false
    properties:
      code:
        type: string
        description: A more specific error code than was provided by the containing error.
      innerError:
        description: An object containing more specific information than the current object about the error.
        $ref: '#/definitions/InnerErrorModel'
  ActiveLearningSettingsDTO:
    type: object
    description: Active Learning settings of the endpoint.
    additionalProperties: false
    properties:
      enable:
        type: string
        description: True/False string providing Active Learning
  EndpointSettingsDTO:
    type: object
    description: Endpoint settings.
    additionalProperties: false
    properties:
      activeLearning:
        description: Active Learning settings of the endpoint.
        allOf:
        - $ref: '#/definitions/ActiveLearningSettingsDTO'
  Error:
    type: object
    description: The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    additionalProperties: false
    required:
    - code
    properties:
      code:
        description: One of a server-defined set of error codes.
        $ref: '#/definitions/ErrorCode'
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Error'
      innerError:
        description: An object containing more specific information than the current object about the error.
        $ref: '#/definitions/InnerErrorModel'
  EndpointKeysDTO:
    type: object
    description: Schema for EndpointKeys generate/refresh operations.
    additionalProperties: false
    properties:
      primaryEndpointKey:
        type: string
        description: Primary Access Key.
      secondaryEndpointKey:
        type: string
        description: Secondary Access Key.
      installedVersion:
        type: string
        description: Current version of runtime.
      lastStableVersion:
        type: string
        description: Latest version of runtime.
      language:
        type: string
        description: Language setting of runtime.
parameters:
  KeyType:
    type: string
    name: keyType
    in: path
    required: true
    x-nullable: false
    description: Type of Key
    x-ms-parameter-location: method
  EndpointSettingsPayload:
    name: endpointSettingsPayload
    in: body
    required: true
    schema:
      $ref: '#/definitions/EndpointSettingsDTO'
    x-nullable: true
    description: Post body of the request.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'