Type Alias User

Type declaration

• createUserExportTemplate:function

  • createUserExportTemplate(): UserExportInterface

    Create an empty user export template

    Returns UserExportInterface

    an empty user export template

• createUserGroupExportTemplate:function

  • createUserGroupExportTemplate(): UserGroupExportInterface

    Create an empty user group export template

    Returns UserGroupExportInterface

    an empty user group export template

• exportUser:function

  • exportUser(userId: string): Promise<UserExportInterface>

    Export a single user by id. The response can be saved to file as is.

    Parameters

    • userId: string

      User id

    Returns Promise<UserExportInterface>

    Promise resolving to a UserExportInterface object.

• exportUserGroup:function

  • exportUserGroup(groupId: string): Promise<UserGroupExportInterface>

    Export a single user group by id. The response can be saved to file as is.

    Parameters

    • groupId: string

      Group id

    Returns Promise<UserGroupExportInterface>

    Promise resolving to a UserGroupExportInterface object.

• exportUserGroups:function

  • exportUserGroups(): Promise<UserGroupExportInterface>

    Export all user groups. The response can be saved to file as is.

    Returns Promise<UserGroupExportInterface>

    Promise resolving to a UserGroupExportInterface object.

• exportUsers:function

  • exportUsers(): Promise<UserExportInterface>

    Export all users. The response can be saved to file as is.

    Returns Promise<UserExportInterface>

    Promise resolving to a UserExportInterface object.

• importUserGroups:function

  • importUserGroups(
        importData: UserGroupExportInterface,
        groupId?: string,
    ): Promise<UserGroupSkeleton[]>

    Import user groups

    Parameters

    • importData: UserGroupExportInterface

      user group import data
    • OptionalgroupId: string

      Optional user group id. If supplied, only the group of that id is imported.

    Returns Promise<UserGroupSkeleton[]>

    the imported user groups

• importUsers:function

  • importUsers(
        importData: UserExportInterface,
        userId?: string,
    ): Promise<UserExportSkeleton[]>

    Import users and their config

    Parameters

    • importData: UserExportInterface

      user import data
    • OptionaluserId: string

      Optional user id. If supplied, only the user of that id is imported.

    Returns Promise<UserExportSkeleton[]>

    the imported users

• readUser:function

  • readUser(userId: string): Promise<UserSkeleton>

    Read user by id

    Parameters

    • userId: string

      User id

    Returns Promise<UserSkeleton>

    a promise that resolves to a user object

• readUserGroup:function

  • readUserGroup(groupId: string): Promise<UserGroupSkeleton>

    Read user group by id

    Parameters

    • groupId: string

      Group id

    Returns Promise<UserGroupSkeleton>

    a promise that resolves to a user group object

• readUserGroups:function

  • readUserGroups(): Promise<UserGroupSkeleton[]>

    Read all user groups.

    Returns Promise<UserGroupSkeleton[]>

    a promise that resolves to an array of user group objects

• readUsers:function

  • readUsers(): Promise<UserSkeleton[]>

    Read all users.

    Returns Promise<UserSkeleton[]>

    a promise that resolves to an array of user objects