Class UserManagement

constructor

• new UserManagement(api: TAKAPI): UserManagement

  Parameters

  • api: TAKAPI

  Returns UserManagement

schema

changePassword

• changePassword(user: { password: string; username: string }): Promise<void>

  Change the password of a File User

  TAK Server Docs.

  Parameters

  • user: { password: string; username: string }

  Returns Promise<void>

cli

• cli(args: ParsedArgs): Promise<string | object>

  Parameters

  • args: ParsedArgs

  Returns Promise<string | object>

createUser

• createUser(
      user: {
          groupList?: string[];
          groupListIN?: string[];
          groupListOUT?: string[];
          password: string;
          username: string;
      },
  ): Promise<void>

  Create a new File User

  TAK Server Docs.

  Parameters

  • user: {
        groupList?: string[];
        groupListIN?: string[];
        groupListOUT?: string[];
        password: string;
        username: string;
    }

  Returns Promise<void>

createUsers

• createUsers(
      bulk: {
          endN: number;
          groupList?: string[];
          groupListIN?: string[];
          groupListOUT?: string[];
          startN: number;
          usernameExpression: string;
      },
  ): Promise<{ password: string; username: string }[]>

  Create File Users in bulk from a username expression containing [N] Passwords are generated by the server and only returned once

  TAK Server Docs.

  Parameters

  • bulk: {
        endN: number;
        groupList?: string[];
        groupListIN?: string[];
        groupListOUT?: string[];
        startN: number;
        usernameExpression: string;
    }

  Returns Promise<{ password: string; username: string }[]>

deleteUser

• deleteUser(username: string): Promise<void>

  Delete a File User

  TAK Server Docs.

  Parameters

  • username: string

  Returns Promise<void>

groupUsers

• groupUsers(
      group: string,
  ): Promise<
      {
          groupname: string;
          usersInGroupList: string[];
          usersInGroupListIN: string[];
          usersInGroupListOUT: string[];
      },
  >

  Get the File Users in a Group along with their IN/OUT/BOTH direction

  TAK Server Docs.

  Parameters

  • group: string

  Returns Promise<
      {
          groupname: string;
          usersInGroupList: string[];
          usersInGroupListIN: string[];
          usersInGroupListOUT: string[];
      },
  >

listGroups

• listGroups(): Promise<{ groupname: string }[]>

  List all Group Names used by File Users

  TAK Server Docs.

  Returns Promise<{ groupname: string }[]>

listUsers

• listUsers(): Promise<{ username: string }[]>

  List all File Users

  TAK Server Docs.

  Returns Promise<{ username: string }[]>

updateGroupUsers

• updateGroupUsers(
      group: {
          groupname: string;
          usersInGroupList?: string[];
          usersInGroupListIN?: string[];
          usersInGroupListOUT?: string[];
      },
  ): Promise<void>

  Replace the File Users associated with a Group

  TAK Server Docs.

  Parameters

  • group: {
        groupname: string;
        usersInGroupList?: string[];
        usersInGroupListIN?: string[];
        usersInGroupListOUT?: string[];
    }

  Returns Promise<void>

updateUserGroups

• updateUserGroups(
      user: {
          groupList?: string[];
          groupListIN?: string[];
          groupListOUT?: string[];
          username: string;
      },
  ): Promise<void>

  Replace the Groups associated with a File User

  TAK Server Docs.

  Parameters

  • user: {
        groupList?: string[];
        groupListIN?: string[];
        groupListOUT?: string[];
        username: string;
    }

  Returns Promise<void>

userGroups

• userGroups(
      username: string,
  ): Promise<
      {
          groupList: string[];
          groupListIN: string[];
          groupListOUT: string[];
          username: string;
      },
  >

  Get the Groups associated with a File User

  TAK Server Docs.

  Parameters

  • username: string

  Returns Promise<
      {
          groupList: string[];
          groupListIN: string[];
          groupListOUT: string[];
          username: string;
      },
  >