API Docs
Authenticate or refresh user
Contents
This Web service runs a user authentication process or refreshes a linked user in Alma.
Refresh operation requires a user at the local institution that is linked to a user at another institution.
Authentication operation requires a password which may be entered as a parameter or with the header: Exl-User-Pw
Successful authentication or refresh will result with an HTTP 204 (success - no content) response.
This API is meant for internal users where Alma is the identity provider.
Resource URL
POST /almaws/v1/users/{user_id}API Description
URL Parameters
| Parameter | Type | Description |
|---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. |
op | xs:string | Optional. Default: auth | The operation to be performed on the user. Mandatory. Currently op=auth or op=refresh are supported. The default is auth. |
password | xs:string | Required | Add the user's password. Or, enter the password in the header Exl-User-Pw. A password is mandatory for op=auth. |
Body Parameters
None
Output
Possible Error Codes
| Code | Message |
|---|---|
| 401866 | User authentication failed |
| 401890 | User was not found. |
| 401861 | Refresh user with given identifier not found. |
| 60229 | Failed to find linked account for user. |
| 60226 | Fulfillment network copied user not found. |
| 60230 | Failed to refresh linked user. |