System User

This subcategory has APIs for configuring details regarding the system user logged in to AhsayCBS. This includes other functions such as adding new users, removing them, and authorizing which users have admin rights or not. Additionally, already existing users can be listed for the API user’s benefit.

• AddSysUser
• UpdateSysUser
• RemoveSysUser
• AuthSystemUser
• ListSystemUsers

AddSysUser

This API can be used to add a system user(s).

The settings can be found on the AhsayCBS web console at:

• System Settings > Basic > Administrative Access

URL

https://CBS.EXAMPLE.COM/obs/api/json/AddSysUser.do

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"api_user",
	"Password":"qWeRtY123456!@#$%",
	"PasswordHashed":"false",
	"Role":"API_ONLY"
}

OUTPUT 1

{
	"Status":"OK"
}

OUTPUT 2 - If another user with the same user name already exists

{
	"Status":"Error",
	"Message":"Name is already used. Please use another name.",
	"ExptType":"java.lang.Exception"
}

Example 2: INPUT IsSendConsolidatedReport for Role = ADMIN

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"AdminTom",
	"Password":"qWeRtY123456!@#$%",
	"Role":"ADMN",
	"IsSendConsolidatedReport":"true"
}

OUTPUT

{
	"Status":"Error",
	"Message":"Update consolidated report setting for ‘Admin’ system user through ‘UpdateServerConfig.do’",
	"ExptType":"java.lang.Exception"
}

Example 3: INPUT IsShowRebrandingPages for Role = ADMIN

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"AdminTom",
	"Password":"qWeRtY123456!@#$%",
	"Role":"ADMN",
	"IsShowRebrandingPages":"false"
}

OUTPUT

{
	"Status":"Error",
	"Message":"Invalid parameter IsShowRebrandingPages for ADMIN system user",
	"ExptType":"java.lang.Exception"
}

UpdateSysUser

This API can be used to update the password and status of a system user.

The settings can be found on the AhsayCBS web console at:

• System Settings > Basic > Administrative Access

URL

https://CBS.EXAMPLE.COM/obs/api/json/UpdateSysUser.do

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"admin123",
	"Password":"changepassword",
	"PasswordHashed":"false"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Missing the LoginName parameter

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"Password":"changepassword"
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter LoginName is null/empty!",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 3

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"admin123",
	"Password":"changepassword",
	"Status":"ENABLED"
}

OUTPUT

{
	"Status":"OK"
}

Example 4

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"admin123",
	"Password":"changepassword",
	"Status":"LOCKED"
}

OUTPUT

{
	"Status":"Error",
	"Message":"Invalid value.  ‘Status’ must be ‘ENABLED’ or ‘SUSPENDED’",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 5

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"LoginName":"admin123",
	"Password":"changepassword",
	"Status":0
}

OUTPUT

{
	"Status":"Error",
	"Message":"JSONObject\”Status\”\not a string",
	"ExptType":"org.json.JONException"
}

Example 6

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample"
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter LoginName is null/empty!",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

RemoveSysUser

This API can be used to remove a system user.

The settings can be found on the AhsayCBS web console at:

• System Settings > Basic > Administrative Access

URL

https://CBS.EXAMPLE.COM/obs/api/json/RemoveSysUser.do

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"RemoveLoginName":"dummyAdmin"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: If the system user does not exist

INPUT

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"RemoveLoginName":"nosuchuser"
}

OUTPUT

{
	"Status":"Error",
	"Message":"System user ‘nosuchuser’ does not exist",
	"ExptType":"org.json.JSONException"
}

AuthSystemUser

The settings can be found on the AhsayCBS web console at:

• System Settings > Basic > Administrative Access

URL

https://CBS.EXAMPLE.COM/obs/api/json/AuthSystemUser.do

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1: For SysUser with Admin role

INPUT

{
	"SysUser":"Admin",
	"SysPwd":"password"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: For SysUser with Read-Only Admin role

INPUT

{
	"SysUser":"Read-Only Admin",
	"SysPwd":"sample"
}

OUTPUT

{
	"Status":"Error",
	"Message":"Incorrect system username/password",
	"ExptType":"com.ahsay.obs.core.dbs.c"
}

ListSystemUsers

This API lists the information of all system users.

The settings can be found on the AhsayCBS web console at:

• System Settings > Basic > Administrative Access

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListSystemUsers.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

SystemUserRole

SystemUser

Example

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
		"Role":"ADMIN",
		"Status":"ENABLED",
		"HashedPwd":"ggeRi1mrAu37jPPCb6q6sRyBRlz/VxUgHbso6jqZu0I=",
		"IsShowRebrandingPages":false,
		"Name":"system",
		"IsFreeTrialOfferAllowed":true
		}
	]
}