RamBase REST APIs
Updates a user in PER and login
HTTP method | PUT |
URI | https://api.rambase.net/system/users/{userId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {userId} |
User identifier
Integer, minimum 100 |
Successful HTTP status code | 200 |
API resource identifier | 3268, version 24 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
User
This field is optional.
>FirstName
First name of the user
This field is optional.
>{String}</FirstName>Name
Name of the user
This field is optional.
>{String}</Name>UserLevel
Type of user: Administrator, Partner, User, PortalUser
Applicable domain values can be found here
Minimum value: 100
Maximum value: 500
This field is optional.
>{Integer}</UserLevel>LicensedRamBaseSystem
This field is optional.
>RamBaseSystemId
The system identificator name of the system a user belogs to.
Minimum value: 1
This field is optional.
>{Integer}</RamBaseSystemId>Name
The descriptive name of the system a user belogs to.
This field is optional.
>{String}</Name>Authentication
This field is optional.
>OneTimePassword
This field is optional.
>MobilePhone
Users mobile number. Used to send one time passwords to user.
Input must match the following regular expression pattern: ^[0-9 \\+]{4,}$
This field is optional.
>{String}</MobilePhone>Users email address. Used to send change notifications and one time passwords
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</Email>SendBy
Domain value id for onetime password delivery type (email, sms)
Applicable domain values can be found here
This field is optional.
>{Integer}</SendBy>Allow
Sets a flag if the user should be allowed to login to RamBase from other locations than the main office by two factor authentication.
This field is optional.
>{Boolean}</Allow>SharedSecret
The key to be used to decode timed onetime passwords with Authenticator app.
This field is optional.
>{String}</SharedSecret>User
This field is optional.
": {FirstName
First name of the user
This field is optional.
": "{String}",Name
Name of the user
This field is optional.
": "{String}",UserLevel
Type of user: Administrator, Partner, User, PortalUser
Applicable domain values can be found here
Minimum value: 100
Maximum value: 500
This field is optional.
": "{Integer}",LicensedRamBaseSystem
This field is optional.
": {RamBaseSystemId
The system identificator name of the system a user belogs to.
Minimum value: 1
This field is optional.
": "{Integer}",Name
The descriptive name of the system a user belogs to.
This field is optional.
": "{String}"Authentication
This field is optional.
": {OneTimePassword
This field is optional.
": {MobilePhone
Users mobile number. Used to send one time passwords to user.
Input must match the following regular expression pattern: ^[0-9 \\+]{4,}$
This field is optional.
": "{String}",Users email address. Used to send change notifications and one time passwords
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
": "{String}",SendBy
Domain value id for onetime password delivery type (email, sms)
Applicable domain values can be found here
This field is optional.
": "{Integer}",Allow
Sets a flag if the user should be allowed to login to RamBase from other locations than the main office by two factor authentication.
This field is optional.
": "{Boolean}",SharedSecret
The key to be used to decode timed onetime passwords with Authenticator app.
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
$access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
$db String, optional | Set the database/company for the request |
$useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return: