Optionalfilter: string
CREST query filter on the AM user attributes, e.g. username sw "a". Default: all users.
exact count when supported by the backing API. AM stops counting at the maximum results of the realm's data store (1000 by default), so a count of exactly that size means "at least".
Create an empty user group export template
an empty user group export template
Export a single user by id. The response can be saved to file as is.
User id
Promise resolving to a UserExportInterface object.
Export a single user group by id. The response can be saved to file as is.
Group id
Promise resolving to a UserGroupExportInterface object.
Export all user groups. The response can be saved to file as is.
Promise resolving to a UserGroupExportInterface object.
Export all users. The response can be saved to file as is.
Promise resolving to a UserExportInterface object.
Import user groups. Every user group is tried: a user group that cannot be imported does not stop the others.
user group import data
OptionalgroupId: string
Optional user group id. If supplied, only the group of that id is imported.
OptionalresultCallback: ResultCallback<UserGroupSkeleton>
Optional callback to process individual results. When given, the outcome of every user group is passed to it as it happens (a failed user group as an error that names it, with the cause nested) and a failed user group does not throw: the user groups that could be imported are returned. Without it, the failures are collected and thrown as one error after every user group was tried.
the imported user groups
Import users and their config. Every user is tried: a user that cannot be imported does not stop the others.
user import data
OptionaluserId: string
Optional user id. If supplied, only the user of that id is imported.
OptionalresultCallback: ResultCallback<UserExportSkeleton>
Optional callback to process individual results. When given, the outcome of every user is passed to it as it happens (a failed user as an error that names it, with the cause nested) and a failed user does not throw: the users that could be imported are returned. A user whose config could not be written is a failed user, although the user itself may have been written. Without a callback, the failures are collected and thrown as one error after every user was tried.
the imported users
Read user by id
User id
a promise that resolves to a user object
Read user group by id
Group id
a promise that resolves to a user group object
Read all user groups.
a promise that resolves to an array of user group objects
Read the users of the active realm, all of them or those matching a filter.
Optionalfilter: string
CREST query filter on the AM user attributes, e.g. username sw "a" or sn sw "a". Default: all users.
Optionalfields: string[]
attributes to return, e.g. ['username', 'givenName', 'sn', 'mail']. Default: the attributes AM returns by default.
a promise that resolves to an array of user objects. AM returns at most the maximum results of the realm's data store (1000 by default), so a list of exactly that size may be cut short: narrow it with a filter.
Count the users of the active realm, all of them or those matching a filter.