clarango.user
create
(create document)
The following data needs to be passed in the {document} parameter as a map:
- user: The name of the user as a string. This is mandatory
- passwd: The user password as a string. If no password is specified, the empty string will be used
- active: An optional flag that specifies whether the user is active. If not specified, this will default to true
- extra: An optional JSON object with arbitrary extra data about the user
- changePassword: An optional flag that specifies whethers the user must change the password or not. If not specified, this will default to false.delete-by-username
(delete-by-username username)
Removes an existing user, identified by the {username} parameter.
exists?
(exists? username)
Checks if a user with a given username is defined in the system
get-all
(get-all)
Fetches data about all users currently defined in the system
get-by-username
(get-by-username username)
Fetches data about the specified user.
replace-by-username
(replace-by-username document username)
Replaces the data of an existing user. The name of an existing user must be specified for the {username} parameter.
The following data can be passed in the {document} parameter as a map:
- passwd: The user password as a string. Specifying a password is mandatory, but the empty string is allowed for passwords
- active: An optional flag that specifies whether the user is active. If not specified, this will default to true
- extra: An optional JSON object with arbitrary extra data about the user
- changePassword: An optional flag that specifies whether the user must change the password or not. If not specified, this will default to falseupdate-by-username
(update-by-username document username)
Partially updates the data of an existing user. The name of an existing user must be specified for the {username} parameter.
The following data can be passed in the {document} parameter as a map:
- passwd: The user password as a string. Specifying a password is optional. If not specified, the previously existing value will not be modified.
- active: An optional flag that specifies whether the user is active. If not specified, the previously existing value will not be modified.
- extra: An optional JSON object with arbitrary extra data about the user. If not specified, the previously existing value will not be modified.
- changePassword: An optional flag that specifies whether the user must change the password or not.