Function getSpaceShares

  • Retrieves the shares of the space matching the query.

    Parameters

    • spaceId: string

      The ID of the space containing the shares.

    • query: {
          groupId?: string;
          limit?: number;
          name?: string;
          next?: string;
          prev?: string;
          resourceId?: string;
          resourceType?: string;
          type?: ShareType;
          userId?: string;
      }

      an object with query parameters

      • OptionalgroupId?: string

        The ID of the group to which the resource is shared.

      • Optionallimit?: number

        Maximum number of shares to return.

      • Optionalname?: string

        The name of the shared resource.

      • Optionalnext?: string

        The next page cursor. Next links make use of this.

      • Optionalprev?: string

        The previous page cursor. Previous links make use of this.

      • OptionalresourceId?: string

        The ID of the shared resource.

      • OptionalresourceType?: string

        The type of the shared resource.

      • Optionaltype?: ShareType

        The type of share. user shares assign to a specific user, group shares assign to a specific group, and link shares provide anonymous access to a resource.

      • OptionaluserId?: string

        The ID of the user to which the resource is shared.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetSpaceSharesHttpResponse>

    GetSpaceSharesHttpError