API Docs

__METHOD= POST . __PATH= /almaws/v1/users .

Create user

This Web service creates a new user.

Resource URL

POST /almaws/v1/users

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
social_authenticationxs:stringOptional. Default: falseWhen customer parameter social_authentication='True': Send social authentication email to patron. Default value: False.
send_pin_number_letterxs:stringOptional. Default: falseThe email notification for PIN setting change will be sent
source_institution_codexs:stringOptional.The code of the source institution from which the user was linked. Optional
source_user_idxs:stringOptional.The ID of the user in the source institution. Optional.

Body Parameters

This method takes a User object. See doc

Output

This method returns a User object. See doc

Possible Error Codes

CodeMessage
401676No valid XML was given.
401851User with identifier of type Y already exists.
401664Mandatory field is missing: X
401852Given user group is not legal.
401853External Id must be empty for internal user.
401854External Id must be given for external user.
401855The account type 'Internal with external authentication' is currently not supported.
500038New password must be at least 8 characters long and must not include the user-name or any commonly used password.
401857The given user account type is illegal (must be INTERNAL/EXTERNAL).
401658General Error - Failed to create new user
401863Given X type (Y) is not supported for given user record type (Z).
401864Given X type (Y) is invalid.
401651Source institution not valid or not part of fulfillment network.
60224Organization institution not found.
60225Fulfillment network not found.
60226Fulfillment network copied user not found.
60227Linked account for user already exists.
60228Failed to create linked user account.
60231Failed to link user due to identifier issues.
60232Failed to link user due to user group empty.