Microsoft Azure Consent API

openapi: 3.2.0
info:
  title: Microsoft Azure Consent API
  version: '1.0'
  description: 'Operations tagged Consent across 2 of this provider''s published API definitions: custom-voice-api-openapi-original.yml, operator-connect-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Consent
paths:
  /consents:
    get:
      tags:
      - Consent
      description: Gets a list of consents for the authenticated Speech service resource.
      operationId: microsoftAzureConsentsList
      parameters:
      - $ref: '#/components/parameters/QuerySkip'
      - $ref: '#/components/parameters/QueryMaxPageSize'
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedConsents'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      x-ms-examples:
        Get all consents:
          $ref: ./examples/get_consents.json
      summary: Microsoft Azure Get Consents
      security:
      - subscription_key: []
        AADToken: []
  /consents/{id}:
    get:
      tags:
      - Consent
      description: Gets the consent identified by the given ID.
      operationId: microsoftAzureConsentsGet
      parameters:
      - $ref: '#/components/parameters/PathId'
      - $ref: '#/components/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Get a consent:
          $ref: ./examples/get_consent.json
      summary: Microsoft Azure Get Consents Id
      security:
      - subscription_key: []
        AADToken: []
    delete:
      tags:
      - Consent
      description: Deletes the consent identified by the given ID.
      operationId: microsoftAzureConsentsDelete
      parameters:
      - $ref: '#/components/parameters/PathId'
      - $ref: '#/components/parameters/QueryApiVersion'
      responses:
        '204':
          description: No Content
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Delete a consent:
          $ref: ./examples/delete_consent.json
      summary: Microsoft Azure Delete Consents Id
      security:
      - subscription_key: []
        AADToken: []
    put:
      tags:
      - Consent
      description: Creates a new voice talent consent with the provided audio URL.
      operationId: microsoftAzureConsentsCreate
      parameters:
      - $ref: '#/components/parameters/HeaderOperationId'
      - $ref: '#/components/parameters/PathId'
      - $ref: '#/components/parameters/QueryApiVersion'
      responses:
        '201':
          description: Created
          headers:
            Operation-Id:
              description: ID of the operation.
              schema:
                type: string
            Operation-Location:
              description: The location of the operation job. Use this URL to monitor operation status.
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create a consent:
          $ref: ./examples/create_consent.json
      summary: Microsoft Azure Put Consents Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Consent'
        description: consent definition
        required: true
      security:
      - subscription_key: []
        AADToken: []
    post:
      tags:
      - Consent
      description: Creates a new voice talent consent with the provided audio file.
      operationId: microsoftAzureConsentsPost
      parameters:
      - $ref: '#/components/parameters/HeaderOperationId'
      - $ref: '#/components/parameters/PathId'
      - $ref: '#/components/parameters/QueryApiVersion'
      responses:
        '201':
          description: Created
          headers:
            Operation-Id:
              description: ID of the operation.
              schema:
                type: string
            Operation-Location:
              description: The location of the operation job. Use this URL to monitor operation status.
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: operation-location
      x-ms-examples:
        Create a consent:
          $ref: ./examples/create_consent_with_multipart_form.json
      summary: Microsoft Azure Post Consents Id
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  maxLength: 64
                  minLength: 3
                  pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
                  description: The project ID.
                displayName:
                  type: string
                  description: The display name of this consent.
                description:
                  type: string
                  description: Optional description of this consent.
                voiceTalentName:
                  type: string
                  description: The name of voice talent.
                companyName:
                  type: string
                  description: The name of company.
                audiodata:
                  type: string
                  description: An audio file containing the audio data.
                  format: binary
                locale:
                  type: string
                  description: The locale of this consent. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
                properties:
                  type: string
                  description: properties.
              required:
              - projectId
              - voiceTalentName
              - companyName
              - audiodata
              - locale
      security:
      - subscription_key: []
        AADToken: []
  /operatorconnect/consents:
    get:
      tags:
      - Consent
      x-ms-examples:
        GetConsents:
          $ref: ./examples/GetConsents.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: This endpoint gets a list of all Consents with Operators for the current user
      summary: Microsoft Azure Get A List Of All Consents With Operators For Current User
      operationId: microsoftAzureGetconsents
      parameters:
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: top
        description: An optional parameter for how many entries to return, for pagination purposes. The default will return the entire list.
        schema:
          type: integer
          format: int32
      - in: query
        name: api-version
        description: Version of API
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            x-ms-request-id:
              description: Microsoft request id used for tracing requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOfConsents'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      security:
      - Authorization: []
  /operatorconnect/consents/{operatorId}:
    get:
      tags:
      - Consent
      x-ms-examples:
        GetConsents:
          $ref: ./examples/GetConsent.json
      description: This endpoint gets single Consent with Operator for current user
      summary: Microsoft Azure Get Single Consent With Operator For Current User
      operationId: microsoftAzureGetconsent
      parameters:
      - in: path
        name: operatorId
        description: The id of Operator with who user has signed consent
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: Version of API
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            x-ms-request-id:
              description: Microsoft request id used for tracing requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent_2'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      security:
      - Authorization: []
    patch:
      tags:
      - Consent
      x-ms-examples:
        CreateConsent:
          $ref: ./examples/CreateConsent.json
        UpdateConsent:
          $ref: ./examples/UpdateConsent.json
      operationId: microsoftAzureCreateorupdateconsent
      description: This endpoint creates new or updates the existing Consent with Operator
      summary: Microsoft Azure Create New Or Update Existing Consent With Operator For Current…
      parameters:
      - in: query
        name: api-version
        description: Version of API
        required: true
        schema:
          type: string
      - in: path
        name: operatorId
        description: The id of the Operator with who user wants to create new or update existing consent
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Consent Updated
          headers:
            x-ms-request-id:
              description: Microsoft request id used for tracing requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent_2'
        '201':
          description: Consent Created
          headers:
            x-ms-request-id:
              description: Microsoft request id used for tracing requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent_2'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateConsentRequest'
        description: The request to send to create new or update existing consent with an operator
        required: true
      security:
      - Authorization: []
components:
  parameters:
    QuerySkip:
      name: skip
      in: query
      description: The number of result items to skip.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 0
    QueryApiVersion:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
    HeaderOperationId:
      name: Operation-Id
      in: header
      description: ID of the status monitor for the operation. If the Operation-Id header matches an existing operation and the request is not identical to the prior request, it will fail with a 400 Bad Request.
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 64
        minLength: 3
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
    QueryFilter:
      name: filter
      in: query
      description: "Filter condition.\n  - **Supported properties:** projectId, createdDateTime, locale, kind\n  - **Operators:**\n    - eq, ne are supported for all properties.\n    - gt, ge, lt, le are supported for createdDateTime.\n  - **Example:**\n    - ```filter=projectId eq 'Jessica'``` (filter by project ID)\n    - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\n    - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\n    - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)"
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    QueryMaxPageSize:
      name: maxpagesize
      in: query
      description: The maximum number of items to include in a single response.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 100
    PathId:
      name: id
      in: path
      description: The ID of the resource.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 64
        minLength: 3
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
  schemas:
    Error:
      description: Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
      required:
      - code
      - message
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        target:
          description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
          type: string
        message:
          description: Top-level error message.
          type: string
        details:
          description: Additional supportive details regarding the error and/or expected policies.
          type: array
          items:
            $ref: '#/components/schemas/Error'
        innererror:
          $ref: '#/components/schemas/InnerError'
    ResourceId:
      description: Resource id
      type: string
      pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
      minLength: 3
      maxLength: 64
    ErrorCode:
      description: Top-level error code
      enum:
      - BadRequest
      - BadArgument
      - Unauthorized
      - Forbidden
      - NotFound
      - UnsupportedMediaType
      - TooManyRequests
      - InternalServerError
      - ServiceUnavailable
      type: string
      x-ms-enum:
        name: ErrorCode
        modelAsString: true
    PaginatedConsents:
      description: Paginated consent list
      required:
      - value
      type: object
      properties:
        value:
          description: Consent list
          type: array
          items:
            $ref: '#/components/schemas/Consent'
        nextLink:
          description: Link to next page.
          format: uri
          type: string
    Consent:
      description: Consent object
      required:
      - voiceTalentName
      - companyName
      - locale
      - projectId
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceId'
        displayName:
          description: Name of consent.
          minLength: 1
          type: string
        description:
          description: Description of consent.
          type: string
        voiceTalentName:
          description: Voice talent name. Must match the voice talent name in the consent audio file.
          minLength: 1
          type: string
        companyName:
          description: Company name. Must match the company name in the consent audio file.
          minLength: 1
          type: string
        audioUrl:
          description: The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with [SAS](https://learn.microsoft.com/azure/storage/common/storage-sas-overview). This property is only available in request.
          type: string
          format: uri
        locale:
          description: The locale of this consent. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
          type: string
          example: en-US
        projectId:
          $ref: '#/components/schemas/ResourceId'
        status:
          $ref: '#/components/schemas/Status'
        createdDateTime:
          description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
          format: date-time
          type: string
          readOnly: true
        lastActionDateTime:
          description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
          format: date-time
          type: string
          readOnly: true
    Status:
      description: Status of a resource.
      enum:
      - NotStarted
      - Running
      - Succeeded
      - Failed
      - Disabling
      - Disabled
      type: string
      x-ms-enum:
        name: Status
        modelAsString: true
    ErrorResponse:
      description: Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
    InnerError:
      description: Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
      type: object
      properties:
        code:
          description: Detailed error code to help diagnostic.
          type: string
        target:
          description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
          type: string
        message:
          description: Detailed error message.
          type: string
        innererror:
          $ref: '#/components/schemas/InnerError'
    ConsentStatus:
      type: string
      description: Status of the consent
      enum:
      - Active
      - Suspended
      - Removed
    Contact:
      type: object
      properties:
        fullName:
          type: string
          description: Full name of the contact
        email:
          type: string
          description: Email address of the contact
        phoneNumber:
          type: string
          description: Phone number of the contact with a leading + and country code
      additionalProperties: false
    ListOfConsents:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Consent_2'
        nextLink:
          type: string
          description: Represents the URL link to the next page of consents.
      required:
      - value
    CreateOrUpdateConsentRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ConsentStatus'
        consentedBy:
          $ref: '#/components/schemas/Contact'
        lastModifiedBy:
          $ref: '#/components/schemas/Contact'
        consentedCountries:
          type: array
          description: List of 2 character codes of available countries in ISO 3166-1 format
          items:
            type: string
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
        companyName:
          type: string
      additionalProperties: false
    Consent_2:
      type: object
      properties:
        operatorId:
          type: string
          description: Unique GUID that represents the operator record
        status:
          $ref: '#/components/schemas/ConsentStatus'
        consentedBy:
          $ref: '#/components/schemas/Contact'
          description: Contact information of user that granted the consent to operator
        consentedOn:
          type: string
          description: Date/Time when the consent was provided
          format: date-time
        lastModifiedBy:
          $ref: '#/components/schemas/Contact'
          description: Contact information of user that last modified the consent
        lastModifiedOn:
          type: string
          description: Date/Time when the consent was last updated
          format: date-time
        consentedCountries:
          type: array
          description: List of 2 character codes of available countries in ISO 3166-1 format
          items:
            type: string
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
          description: List of contact information
        companyName:
          type: string
          description: User company name
      additionalProperties: false
  securitySchemes:
    subscription_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: Provide your Speech resource key here.
    AADToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://cognitiveservices.azure.com/.default: https://cognitiveservices.azure.com/.default
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: These are the [Microsoft identity platform](entra/identity-platform/v2-overview) flows.
    Authorization:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-refined-from:
- custom-voice-api-openapi-original.yml
- operator-connect-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'