swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Identity API
schemes:
- https
tags:
- name: Identity
paths:
  /identities:
    post:
      tags:
      - Identity
      summary: Microsoft Azure Create A New Identity
      operationId: microsoftAzureCommunicationidentityCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: body
        schema:
          $ref: '#/definitions/CommunicationIdentityCreateRequest'
      responses:
        '201':
          description: Created - Returns the created identity.
          schema:
            $ref: '#/definitions/CommunicationIdentityAccessTokenResult'
        default:
          description: Error
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Create an Identity:
          $ref: ./examples/CreateIdentity.json
      description: Needs a more full description created.
  /identities/{id}:
    delete:
      tags:
      - Identity
      summary: Microsoft Azure Delete The Identity, Revoke All Tokens For The Identity And Delete All Associated Data
      operationId: microsoftAzureCommunicationidentityDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: Identifier of the identity to be deleted.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Success
        default:
          description: Error
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Delete an identity:
          $ref: ./examples/DeleteIdentity.json
      description: Needs a more full description created.
  /identities/{id}/:revokeAccessTokens:
    post:
      tags:
      - Identity
      summary: Microsoft Azure Revoke All Access Tokens For The Specific Identity
      operationId: microsoftAzureCommunicationidentityRevokeaccesstokens
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: Identifier of the identity.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Success
        default:
          description: Error
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Revoke access tokens:
          $ref: ./examples/RevokeAccessTokens.json
      description: Needs a more full description created.
definitions:
  CommunicationIdentityAccessToken:
    description: An access token.
    required:
    - expiresOn
    - token
    type: object
    properties:
      token:
        description: The access token issued for the identity.
        type: string
      expiresOn:
        format: date-time
        description: The expiry time of the token.
        type: string
  CommunicationIdentityAccessTokenResult:
    description: A communication identity with access token.
    required:
    - identity
    type: object
    properties:
      identity:
        $ref: '#/definitions/CommunicationIdentity'
      accessToken:
        $ref: '#/definitions/CommunicationIdentityAccessToken'
  CommunicationIdentityCreateRequest:
    type: object
    properties:
      createTokenWithScopes:
        description: Also create access token for the created identity.
        type: array
        items:
          $ref: '#/definitions/CommunicationIdentityTokenScope'
  CommunicationIdentity:
    description: A communication identity.
    required:
    - id
    type: object
    properties:
      id:
        description: Identifier of the identity.
        type: string
  CommunicationIdentityTokenScope:
    description: List of scopes for an access token.
    enum:
    - chat
    - voip
    type: string
    x-ms-enum:
      name: CommunicationIdentityTokenScope
      modelAsString: true
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'