Class AdminResource

constructor

• new AdminResource(client: FolderHarbor): AdminResource

  Parameters

  • client: FolderHarbor

  Returns AdminResource

acls

config

roles

users

logs

• logs(page?: number): Promise<FHLogs>

  Read the server's audit log.

  Parameters

  • Optionalpage: number

    Page number to look at, defaults to page 1 (the latest logs)

  Returns Promise<FHLogs>

  The log entries on that page (capping out at 20), as well as the total number of pages

  Permission

  logs:read

  Throws

  If your session is invalid, expired, or for a locked account

  Throws

  If you don't have permission to take this admin action

  Throws

  If anything else went wrong, either in the process of requesting, or in the response from the server

  Example

  const latestLogs = await client.admin.logs();
  const oldestLogs = await client.admin.logs(latestLogs.pageCount);
  Copy

permissions

• permissions(): Promise<FHPermissions>

  Gets a list of permissions that can be applied to users or roles.

  Returns Promise<FHPermissions>

  A list of key-value pairs with permission nodes and their descriptions

  Throws

  If your session is invalid, expired, or for a locked account

  Throws

  If anything else went wrong, either in the process of requesting, or in the response from the server

  Example

  const permList = await client.admin.permissions();
  Copy

revokeSession

• revokeSession(sessionID: number): Promise<void>

  Revokes a session token for any user.

  Parameters

  • sessionID: number

    The session ID for the session you want to revoke

  Returns Promise<void>

  Permission

  users:edit

  Throws

  If your session is invalid, expired, or for a locked account

  Throws

  If you don't have permission to take this admin action

  Throws

  If anything else went wrong, either in the process of requesting, or in the response from the server

  Example

  await client.admin.revokeSession(6);
  Copy