Microsoft Identity API

openapi: 3.2.0
info:
  title: Microsoft Azure Communication Services Identity API
  description: Multichannel communication APIs for adding voice, video, chat, SMS, and email capabilities to applications.
  version: '2024-03-15'
  contact:
    name: Azure Communication Services Support
    url: https://learn.microsoft.com/en-us/azure/communication-services/
  termsOfService: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://{resource}.communication.azure.com
  description: Azure Communication Services Endpoint
  variables:
    resource:
      default: your-resource
      description: Your Communication Services resource name
security:
- accessKey: []
tags:
- name: Identity
  description: Create and manage communication identities
paths:
  /identities:
    post:
      operationId: createIdentity
      summary: Microsoft Create an identity
      description: Create a new Communication Services identity.
      tags:
      - Identity
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                createTokenWithScopes:
                  type: array
                  items:
                    type: string
                    enum:
                    - chat
                    - voip
                  description: Also create an access token with these scopes
      responses:
        '201':
          description: Identity created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationIdentityAccessTokenResult'
        '401':
          description: Unauthorized
  /identities/{id}:
    delete:
      operationId: deleteIdentity
      summary: Microsoft Delete an identity
      description: Delete a Communication Services identity and revoke all tokens.
      tags:
      - Identity
      parameters:
      - name: id
        in: path
        required: true
        description: Identifier of the identity to delete
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '204':
          description: Identity deleted
        '401':
          description: Unauthorized
        '404':
          description: Identity not found
  /identities/{id}/:issueAccessToken:
    post:
      operationId: issueAccessToken
      summary: Microsoft Issue an access token
      description: Issue a new access token for an identity.
      tags:
      - Identity
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - scopes
              properties:
                scopes:
                  type: array
                  items:
                    type: string
                    enum:
                    - chat
                    - voip
                expiresInMinutes:
                  type: integer
                  minimum: 60
                  maximum: 1440
                  default: 1440
      responses:
        '200':
          description: Access token issued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationIdentityAccessToken'
        '401':
          description: Unauthorized
components:
  schemas:
    CommunicationIdentityAccessTokenResult:
      type: object
      properties:
        identity:
          type: object
          properties:
            id:
              type: string
        accessToken:
          $ref: '#/components/schemas/CommunicationIdentityAccessToken'
    CommunicationIdentityAccessToken:
      type: object
      properties:
        token:
          type: string
        expiresOn:
          type: string
          format: date-time
  parameters:
    apiVersion:
      name: api-version
      in: query
      required: true
      description: API version
      schema:
        type: string
        default: 2024-03-15-preview
  securitySchemes:
    accessKey:
      type: apiKey
      name: Authorization
      in: header
      description: HMAC-SHA256 signature authentication
externalDocs:
  description: Azure Communication Services REST API Reference
  url: https://learn.microsoft.com/en-us/rest/api/communication/