swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GroupUser API
schemes:
- https
tags:
- name: GroupUser
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users
  : get:
      tags:
      - GroupUser
      operationId: microsoftAzureWorkspacegroupuserList
      description: Lists a collection of user entities associated with the group.
      x-ms-examples:
        ApiManagementListWorkspaceGroupUsers:
          $ref: ./examples/ApiManagementListWorkspaceGroupUsers.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/GroupIdParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt |     |</br>| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
      - $ref: ./apimanagement.json#/parameters/TopQueryParameter
      - $ref: ./apimanagement.json#/parameters/SkipQueryParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Lists a collection of user entities associated with the group.
          schema:
            $ref: ./definitions.json#/definitions/UserCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/UserContract
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Groups Groupid Users
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}
  : head:
      tags:
      - GroupUser
      operationId: microsoftAzureWorkspacegroupuserCheckentityexists
      description: Checks that user entity specified by identifier is associated with the group entity.
      x-ms-examples:
        ApiManagementHeadWorkspaceGroupUser:
          $ref: ./examples/ApiManagementHeadWorkspaceGroupUser.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/GroupIdParameter
      - $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: Entity exists
        '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 Groups Groupid Users Userid
    put:
      tags:
      - GroupUser
      operationId: microsoftAzureWorkspacegroupuserCreate
      description: Add existing user to existing group
      x-ms-examples:
        ApiManagementCreateWorkspaceGroupUser:
          $ref: ./examples/ApiManagementCreateWorkspaceGroupUser.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/GroupIdParameter
      - $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: The specified user is already a member of the specified group.
          schema:
            $ref: ./definitions.json#/definitions/UserContract
        '201':
          description: The user was successfully added to the group.
          schema:
            $ref: ./definitions.json#/definitions/UserContract
        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 Groups Groupid Users Userid
    delete:
      tags:
      - GroupUser
      operationId: microsoftAzureWorkspacegroupuserDelete
      description: Remove existing user from existing group.
      x-ms-examples:
        ApiManagementDeleteWorkspaceGroupUser:
          $ref: ./examples/ApiManagementDeleteWorkspaceGroupUser.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/GroupIdParameter
      - $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: The user was successfully removed from the group.
        '204':
          description: The user was successfully removed from the group.
        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 Groups Groupid Users Userid
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'