Interface GroupAPI

Group API methods

interface GroupAPI {
    create(group: Group.CreateRequest): Promise<any>;
    delete(groupId: string): Promise<void>;
    details(groupId: string): Promise<Group.Details>;
    list(
        options?: Rev.SearchOptions<Group.SearchHit>,
    ): SearchRequest<Group.SearchHit>;
    listUserDetails(
        groupId: string,
        options?: Rev.SearchOptions<User & { error?: Error }>,
    ): SearchRequest<User & { error?: Error; userId: string }>;
    listUsers(
        groupId: string,
        options?: Rev.SearchOptions<string>,
    ): SearchRequest<string>;
    search(
        searchText?: string,
        options?: AccessEntitySearchOptions<Group.SearchHit>,
    ): SearchRequest<Group.SearchHit>;
}

Hierarchy

  • API
    • GroupAPI

Methods

  • Parameters

    • groupId: string

    Returns Promise<void>