assignPersonaToUser
createUser
Create a new user.
Arguments
Argument Name | Type | Description |
---|---|---|
userName | String | The user name. (Required) |
String | Email address of the user. | |
fullUserName | String | Full name of the user. |
groupNames | String array | List of groups that this user is in. |
password | String | The users password. |
personas | String array | List of personas that this user has. |
getUser
Retrieve a user by name.
Arguments
Argument Name | Type | Description |
---|---|---|
userName | String | The user name. (Required) |
providerName | String | The name of the provider from which to get the user. |
registerLDAPUser | Boolean | Set to 0 or false to show user without register LDAP user in the EF system. |
traverseHierarchy | Boolean | Set to 0 or true to include parent groups in the result if this is an LDAP user and recursive traversal of group hierarchy is enabled for the directory provider. |
getUsers
Retrieve all users.
Arguments
Argument Name | Type | Description |
---|---|---|
filter | String | Apply a glob-style filter (e.g. 'foo*') when looking for users or groups. |
includeAll | Boolean | Whether to include all users or groups, or only users or groups that are known to the system. |
maximum | Integer | The maximum number of users or groups to return. |
searchFields | String array | Filter search fields. Supported FulName or/and Email |
sortKey | String | How to sort the results. |
sortOrder | String | Which order to sort in |
modifyUser
Modify an existing user.
Arguments
Argument Name | Type | Description |
---|---|---|
userName | String | The user name. (Required) |
clearPersonas | Boolean | clear personas for user, if modifying. |
String | Email address of the user. | |
fullUserName | String | Full name of the user. |
groupNames | String array | List of groups that this user is in. |
migrateSettings | String | Migrate the user or group settings to this name. |
newName | String | New name for an existing object that is being renamed. |
password | String | The users password. |
personas | String array | List of personas that this user has. |
removeFromAllGroups | Boolean | True to remove this user from all groups. |
sessionPassword | String | Session user’s password. Used to re-verify identity before changing user passwords in the system. |