API

System APIs

POST system/users

Creates a new user

HTTP method POST
URI https://api.rambase.net/system/users
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3267, version 32

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.

Format:
1
<User>
2
     <FirstName
FirstName

First name of the user

This field is optional.

>{String}</FirstName>
3
     <Name
Name

Required/mandatory field

Name of the user

>{String}</Name>
4
     <Authentication>
5
          <Username
Username

The users login name

This field is optional.

>{String}</Username>
6
          <OneTimePassword>
7
               <MobilePhone
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>
8
               <Email
Email

Required/mandatory field

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+)*$

>{String}</Email>
9
               <SendBy
SendBy

Domain value id for onetime password delivery type (email, sms)

Applicable domain values can be found here

Default value: 2

This field is optional.

>{Integer}</SendBy>
10
               <Allow
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.

Default value: False

This field is optional.

>{Boolean}</Allow>
11
          </OneTimePassword>
12
     </Authentication>
13
</User>
1
{
2
     "user": {
3
          "firstName
FirstName

First name of the user

This field is optional.

": "{String}",
4
          "name
Name

Required/mandatory field

Name of the user

": "{String}",
5
          "authentication": {
6
               "username
Username

The users login name

This field is optional.

": "{String}",
7
               "oneTimePassword": {
8
                    "mobilePhone
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}",
9
                    "email
Email

Required/mandatory field

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+)*$

": "{String}",
10
                    "sendBy
SendBy

Domain value id for onetime password delivery type (email, sms)

Applicable domain values can be found here

Default value: 2

This field is optional.

": "{Integer}",
11
                    "allow
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.

Default value: False

This field is optional.

": "{Boolean}"
12
               }
13
          }
14
     }
15
}

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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<User>
2
     <UserId
UserId

User identifier

>{Integer}</UserId>
3
     <FirstName
FirstName

First name of the user

>{String}</FirstName>
4
     <Name
Name

Name of the user

>{String}</Name>
5
     <Status
Status

User status ID

Possible domain values can be found here

>{Integer}</Status>
6
     <UserLevel
UserLevel

Type of user: Administrator, Partner, User, PortalUser

Possible domain values can be found here

>
7
          <RamBaseSystemId
RamBaseSystemId

The system identificator name of the system a user belogs to.

>{Integer}</RamBaseSystemId>
8
          <Name
Name

The descriptive name of the system a user belogs to.

>{String}</Name>
9
          <Username
Username

The users login name

>{String}</Username>
10
          <OneTimePassword>
11
               <MobilePhone
MobilePhone

Users mobile number. Used to send one time passwords to user.

>{String}</MobilePhone>
12
               <Email
Email

Users email address. Used to send change notifications and one time passwords

>{String}</Email>
13
               <SendBy
SendBy

Domain value id for onetime password delivery type (email, sms)

Possible domain values can be found here

>{Integer}</SendBy>
14
               <Allow
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.

>{Boolean}</Allow>
15
          </OneTimePassword>
16
          <OpenIdConnect>
17
               <ExternalUserId
ExternalUserId

The single sign on global user id for active directory

>{String}</ExternalUserId>
18
               <TenantId
TenantId

Active directory tenant id

>{String}</TenantId>
19
               <Provider
Provider

The single sign on AD provider

Possible domain values can be found here

>{String}</Provider>
20
          </OpenIdConnect>
21
     </UserLevel>
22
</User>
1
{
2
     "user": {
3
          "userId
UserId

User identifier

": "{Integer}",
4
          "firstName
FirstName

First name of the user

": "{String}",
5
          "name
Name

Name of the user

": "{String}",
6
          "status
Status

User status ID

Possible domain values can be found here

": "{Integer}",
7
          "userLevel
UserLevel

Type of user: Administrator, Partner, User, PortalUser

Possible domain values can be found here

": {
8
               "ramBaseSystemId
RamBaseSystemId

The system identificator name of the system a user belogs to.

": "{Integer}",
9
               "name
Name

The descriptive name of the system a user belogs to.

": "{String}",
10
               "username
Username

The users login name

": "{String}",
11
               "oneTimePassword": {
12
                    "mobilePhone
MobilePhone

Users mobile number. Used to send one time passwords to user.

": "{String}",
13
                    "email
Email

Users email address. Used to send change notifications and one time passwords

": "{String}",
14
                    "sendBy
SendBy

Domain value id for onetime password delivery type (email, sms)

Possible domain values can be found here

": "{Integer}",
15
                    "allow
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.

": "{Boolean}"
16
               },
17
               "openIdConnect": {
18
                    "externalUserId
ExternalUserId

The single sign on global user id for active directory

": "{String}",
19
                    "tenantId
TenantId

Active directory tenant id

": "{String}",
20
                    "provider
Provider

The single sign on AD provider

Possible domain values can be found here

": "{String}"
21
               }
22
          }
23
     }
24
}

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: