Type Alias User

type User = {
    createUserExportTemplate(): UserExportInterface;
    createUserGroupExportTemplate(): UserGroupExportInterface;
    exportUser(userId: string): Promise<UserExportInterface>;
    exportUserGroup(groupId: string): Promise<UserGroupExportInterface>;
    exportUserGroups(): Promise<UserGroupExportInterface>;
    exportUsers(): Promise<UserExportInterface>;
    importUserGroups(
        importData: UserGroupExportInterface,
        groupId?: string,
    ): Promise<UserGroupSkeleton[]>;
    importUsers(
        importData: UserExportInterface,
        userId?: string,
    ): Promise<UserExportSkeleton[]>;
    readUser(userId: string): Promise<UserSkeleton>;
    readUserGroup(groupId: string): Promise<UserGroupSkeleton>;
    readUserGroups(): Promise<UserGroupSkeleton[]>;
    readUsers(): Promise<UserSkeleton[]>;
}

Index

Methods

createUserExportTemplate createUserGroupExportTemplate exportUser exportUserGroup exportUserGroups exportUsers importUserGroups importUsers readUser readUserGroup readUserGroups readUsers

Methods

createUserExportTemplate

createUserExportTemplate(): UserExportInterface
Create an empty user export template

Returns UserExportInterface
an empty user export template
- Defined in ops/UserOps.ts:30

createUserGroupExportTemplate

createUserGroupExportTemplate(): UserGroupExportInterface
Create an empty user group export template

Returns UserGroupExportInterface
an empty user group export template
- Defined in ops/UserOps.ts:57

exportUser

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.
- Defined in ops/UserOps.ts:47

exportUserGroup

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.
- Defined in ops/UserOps.ts:74

exportUserGroups

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.
- Defined in ops/UserOps.ts:79

exportUsers

exportUsers(): Promise<UserExportInterface>
Export all users. The response can be saved to file as is.

Returns Promise<UserExportInterface>
Promise resolving to a UserExportInterface object.
- Defined in ops/UserOps.ts:52

importUserGroups

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
- Defined in ops/UserOps.ts:96

importUsers

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
- Defined in ops/UserOps.ts:86

readUser

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
- Defined in ops/UserOps.ts:36

readUserGroup

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
- Defined in ops/UserOps.ts:63

readUserGroups

readUserGroups(): Promise<UserGroupSkeleton[]>
Read all user groups.

Returns Promise<UserGroupSkeleton[]>
a promise that resolves to an array of user group objects
- Defined in ops/UserOps.ts:68

readUsers

readUsers(): Promise<UserSkeleton[]>
Read all users.

Returns Promise<UserSkeleton[]>
a promise that resolves to an array of user objects
- Defined in ops/UserOps.ts:41