Class PermissionClient

Implements

IPermissionClient

Index

Constructors

Methods

addGroupMember deleteGroup listGroupMembers listGroups listUserGroups listUsers putGroup removeGroupMember

Constructors

constructor

new PermissionClient(
baseUrl: string | URL,
_httpClient: TwinfinityHttpClient,
): PermissionClient
Parameters
- baseUrl: string | URL
- _httpClient: TwinfinityHttpClient
Returns PermissionClient

Methods

addGroupMember

addGroupMember(
    groupId: string,
    userId: string,
    signal?: AbortSignal,
): Promise<GroupMember>
Parameters
- groupId: string
- userId: string
- Optionalsignal: AbortSignal
Returns Promise<GroupMember>
Implementation of IPermissionClient.addGroupMember

deleteGroup

deleteGroup(
    id: string,
    request: DeleteGroupRequest,
    signal?: AbortSignal,
): Promise<Group>
Parameters
- id: string
- request: DeleteGroupRequest
- Optionalsignal: AbortSignal
Returns Promise<Group>
Implementation of IPermissionClient.deleteGroup

listGroupMembers

listGroupMembers(
    groupId: string,
    page?: undefined | string,
    limit?: number,
    signal?: AbortSignal,
): Promise<PaginatedResponse<User>>
Parameters
- groupId: string
- page: undefined | string = undefined
- limit: number = 500
- Optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<User>>
Implementation of IPermissionClient.listGroupMembers

listGroups

listGroups(
    page?: undefined | string,
    limit?: number,
    q?: string,
    signal?: AbortSignal,
): Promise<PaginatedResponse<Group>>
Parameters
- page: undefined | string = undefined
- limit: number = 500
- Optionalq: string
- Optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<Group>>
Implementation of IPermissionClient.listGroups

listUserGroups

listUserGroups(
    userId: string,
    page?: undefined | string,
    limit?: number,
    signal?: AbortSignal,
): Promise<PaginatedResponse<Group>>
Parameters
- userId: string
- page: undefined | string = undefined
- limit: number = 500
- Optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<Group>>
Implementation of IPermissionClient.listUserGroups

listUsers

listUsers(
    page?: undefined | string,
    limit?: number,
    q?: string,
    signal?: AbortSignal,
): Promise<PaginatedResponse<User>>
Parameters
- page: undefined | string = undefined
- limit: number = 500
- Optionalq: string
- Optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<User>>
Implementation of IPermissionClient.listUsers

putGroup

putGroup(
    id: string,
    request: PutGroupRequest,
    signal?: AbortSignal,
): Promise<Group>
Parameters
- id: string
- request: PutGroupRequest
- Optionalsignal: AbortSignal
Returns Promise<Group>
Implementation of IPermissionClient.putGroup

removeGroupMember

removeGroupMember(
    groupId: string,
    userId: string,
    signal?: AbortSignal,
): Promise<GroupMember>
Parameters
- groupId: string
- userId: string
- Optionalsignal: AbortSignal
Returns Promise<GroupMember>
Implementation of IPermissionClient.removeGroupMember