API

RamBase REST APIs

GET system/users/{userId}

Details about specified user

HTTP method GET
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 2042, version 59

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
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.

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

>{Integer}</UserLevel>
7
     <AdmittanceLevel
AdmittanceLevel

Accumulated admittance level for employee at given date.

This field is greyed out because it is an expandable field. You have to add $expand=AdmittanceLevel in your request URI to get this field

>{Integer}</AdmittanceLevel>
8
     <PriceCategory
PriceCategory

The level a user has in regards to licensing. We have 4 price categories; Self service- (most basic), Single task-, Functional- and Cross functional user (most advanced). Calculated admittance level for a user will define the price category based on threshold values.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=PriceCategory in your request URI to get this field

>{Integer}</PriceCategory>
9
     <LicensedRamBaseSystem
LicensedRamBaseSystem

This field is greyed out because it is an expandable field. You have to add $expand=LicensedRamBaseSystem in your request URI to get this field

>
10
          <RamBaseSystemId
RamBaseSystemId

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

This field is greyed out because it is an expandable field. You have to add $expand=LicensedRamBaseSystem in your request URI to get this field

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

The descriptive name of the system a user belogs to.

This field is greyed out because it is an expandable field. You have to add $expand=LicensedRamBaseSystem in your request URI to get this field

>{String}</Name>
12
     </LicensedRamBaseSystem>
13
     <Authentication
Authentication

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

>
14
          <Username
Username

The users login name

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

>{String}</Username>
15
          <OneTimePassword
OneTimePassword

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

>
16
               <MobilePhone
MobilePhone

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

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

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

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

>{Boolean}</Allow>
20
          </OneTimePassword>
21
          <OpenIdConnect
OpenIdConnect

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

>
22
               <ExternalUserId
ExternalUserId

The single sign on global user id for active directory

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

Active directory tenant id

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

The single sign on AD provider

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

>{String}</Provider>
25
          </OpenIdConnect>
26
     </Authentication>
27
     <ConsultantFor
ConsultantFor

This field is greyed out because it is an expandable field. You have to add $expand=ConsultantFor in your request URI to get this field

>
28
          <RamBasePartnerId
RamBasePartnerId

Unique identifier for a customers partner

This field is greyed out because it is an expandable field. You have to add $expand=ConsultantFor in your request URI to get this field

>{Integer}</RamBasePartnerId>
29
          <Name
Name

The name of a customers partner

This field is greyed out because it is an expandable field. You have to add $expand=ConsultantFor in your request URI to get this field

>{String}</Name>
30
     </ConsultantFor>
31
</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

": "{Integer}",
8
          "admittanceLevel
AdmittanceLevel

Accumulated admittance level for employee at given date.

This field is greyed out because it is an expandable field. You have to add $expand=AdmittanceLevel in your request URI to get this field

": "{Integer}",
9
          "priceCategory
PriceCategory

The level a user has in regards to licensing. We have 4 price categories; Self service- (most basic), Single task-, Functional- and Cross functional user (most advanced). Calculated admittance level for a user will define the price category based on threshold values.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=PriceCategory in your request URI to get this field

": "{Integer}",
10
          "licensedRamBaseSystem
LicensedRamBaseSystem

This field is greyed out because it is an expandable field. You have to add $expand=LicensedRamBaseSystem in your request URI to get this field

": {
11
               "ramBaseSystemId
RamBaseSystemId

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

This field is greyed out because it is an expandable field. You have to add $expand=LicensedRamBaseSystem in your request URI to get this field

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

The descriptive name of the system a user belogs to.

This field is greyed out because it is an expandable field. You have to add $expand=LicensedRamBaseSystem in your request URI to get this field

": "{String}"
13
          },
14
          "authentication
Authentication

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

": {
15
               "username
Username

The users login name

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

": "{String}",
16
               "oneTimePassword
OneTimePassword

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

": {
17
                    "mobilePhone
MobilePhone

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

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

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

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

": "{Boolean}"
21
               },
22
               "openIdConnect
OpenIdConnect

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

": {
23
                    "externalUserId
ExternalUserId

The single sign on global user id for active directory

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

Active directory tenant id

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

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

The single sign on AD provider

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Authentication in your request URI to get this field

": "{String}"
26
               }
27
          },
28
          "consultantFor
ConsultantFor

This field is greyed out because it is an expandable field. You have to add $expand=ConsultantFor in your request URI to get this field

": {
29
               "ramBasePartnerId
RamBasePartnerId

Unique identifier for a customers partner

This field is greyed out because it is an expandable field. You have to add $expand=ConsultantFor in your request URI to get this field

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

The name of a customers partner

This field is greyed out because it is an expandable field. You have to add $expand=ConsultantFor in your request URI to get this field

": "{String}"
31
          }
32
     }
33
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST
Add SystemPermission to User
AOP/100651
POST
Resend invitation email to user
AOP/100652
POST
Resign user
AOP/100758
POST
Temporary leave user
Sets a user to Status 7: Temporary leave
AOP/100759
POST
Activate user
Activates a user to status 4
AOP/100771
POST
Unblock User
AOP/100775
POST
Send system activation email to user
AOP/100780
POST
Invite user by email
AOP/100791
POST
Reset user to invited status
Resets a user back to the invited status.
AOP/100794
POST
Convert to Microsoft AD user
Invites a user to be converted into Microsoft AD user
AOP/100873
POST
RemoveMicrosoft AD and reset user to invited status
AOP/100899
POST
Activate RACR for user
AOP/101545
POST
Activate RBS for user
AOP/101546
POST
Check if user is allowed to perform global data extraction
Check if user has permission PerformGlobalDataExtraction
AOP/101661
POST
Check if user is allowed to perform development in other systems
Check if user has permission PerformDevelopmentInOtherSystems
AOP/101662
POST
Grant JHC user single system permission with selected consultant roles
Grant user access to other system than JHCDEVSYS with developer and/or consultant roles. Companies can be specified. If not, the user will get the roles in all companies in the system.
AOP/101723
POST
Grant user permission to all systems for global data extraction
Grant user access to all other system than JHCDEVSYS for doing global data extraction. No roles will be assigned (as none are needed for global data extraction). Test systems can be included.
AOP/101725
POST
Check if JHC user is allowed to have system permission with no expiry
Check if JHC user is allowed to have no expiry on system permission for production systems, or if system is not a production system.
AOP/101755

Possible error codes the response might return: