swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NotificationRecipientUser API
schemes:
- https
tags:
- name: NotificationRecipientUser
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers
  : get:
      tags:
      - NotificationRecipientUser
      operationId: microsoftAzureWorkspacenotificationrecipientuserListbynotification
      description: Gets the list of the Notification Recipient User subscribed to the notification.
      x-ms-examples:
        ApiManagementListWorkspaceNotificationRecipientUsers:
          $ref: ./examples/ApiManagementListWorkspaceNotificationRecipientUsers.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NotificationNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The response body contains the Recipient User collection for the notification.
          schema:
            $ref: ./definitions.json#/definitions/RecipientUserCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Notifications Notificationname Recipientusers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}
  : head:
      tags:
      - NotificationRecipientUser
      operationId: microsoftAzureWorkspacenotificationrecipientuserCheckentityexists
      description: Determine if the Notification Recipient User is subscribed to the notification.
      x-ms-examples:
        ApiManagementHeadWorkspaceNotificationRecipientUser:
          $ref: ./examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NotificationNameParameter
      - $ref: ./apimanagement.json#/parameters/UserIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '204':
          description: The User is subscribed to receive the notification.
        '404':
          description: Entity does not exists.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Notifications Notificationname Recipientusers Userid
    put:
      tags:
      - NotificationRecipientUser
      operationId: microsoftAzureWorkspacenotificationrecipientuserCreateorupdate
      description: Adds the API Management User to the list of Recipients for the Notification.
      x-ms-examples:
        ApiManagementCreateWorkspaceNotificationRecipientUser:
          $ref: ./examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NotificationNameParameter
      - $ref: ./apimanagement.json#/parameters/UserIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Recipient User is already part of the notification list.
          schema:
            $ref: ./definitions.json#/definitions/RecipientUserContract
        '201':
          description: Recipient User was successfully added to the notification list.
          schema:
            $ref: ./definitions.json#/definitions/RecipientUserContract
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Notifications Notificationname Recipientusers Userid
    delete:
      tags:
      - NotificationRecipientUser
      operationId: microsoftAzureWorkspacenotificationrecipientuserDelete
      description: Removes the API Management user from the list of Notification.
      x-ms-examples:
        ApiManagementDeleteWorkspaceNotificationRecipientUser:
          $ref: ./examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NotificationNameParameter
      - $ref: ./apimanagement.json#/parameters/UserIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Recipient User was successfully removed from the notification list.
        '204':
          description: Recipient User was successfully removed from the notification list.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Notifications Notificationname Recipientusers Userid
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'