Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GroupUser

Package version

Interface representing a GroupUser.

Hierarchy

  • GroupUser

Implemented by

Index

Methods

Methods

checkEntityExists

  • Checks that user entity specified by identifier is associated with the group entity.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • groupId: string

      Group identifier. Must be unique in the current API Management service instance.

    • userId: string

      User identifier. Must be unique in the current API Management service instance.

    • Optional options: GroupUserCheckEntityExistsOptionalParams

      The options parameters.

    Returns Promise<GroupUserCheckEntityExistsResponse>

create

  • Add existing user to existing group

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • groupId: string

      Group identifier. Must be unique in the current API Management service instance.

    • userId: string

      User identifier. Must be unique in the current API Management service instance.

    • Optional options: GroupUserCreateOptionalParams

      The options parameters.

    Returns Promise<GroupUserCreateResponse>

delete

  • delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>

  • Remove existing user from existing group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • groupId: string

      Group identifier. Must be unique in the current API Management service instance.

    • userId: string

      User identifier. Must be unique in the current API Management service instance.

    • Optional options: GroupUserDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

list

  • Lists a collection of user entities associated with the group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • groupId: string

      Group identifier. Must be unique in the current API Management service instance.

    • Optional options: GroupUserListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<UserContract>

Generated using TypeDoc