Access Keys:
Skip to content (Access Key - 0)
Live Chat

Create User Account

Skip to end of metadata
Go to start of metadata
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

API URL

http://api.banckle.com/platform/users

Description

Add a user account to a company.

Supported Request Methods:

POST

Requires Authentication

true

API Parameters:

HTTP Request Parameters
Required
  • _token: caller's token, generated by the 'authenticate' or OAuth API's. Caller must own permission 'PERMISSION_COMPANY_ADMIN'. For example the super admin or assigned company administrator user. Please see Banckle Customer User/Role section.
Optional
  • None
HTTP Request Body
Supported Formats

xml, json

Required Parameters
  • userId: the login id of the user.
  • password: the password of the user.
  • email: the email of the user.
Optional Parameters
  • lastName: last name of the user.
  • firstName: first name of the user.
  • middleName: middle name of the user.
  • department: department the user belongs to.
  • title: title of the user.
  • permissions : banckle products permission, such as PERMISSION_COMPANY_ADMIN
  • roleIds :  role ids, separate with ";" , such as  "1;2;4"
  • fullResponse: Set this parameter to get back the full added user information.
Example Responses:
JSON
{
	"stat": "ok",
	"status_code": "200",
	"id" : 6322
}
JSON, with FULL Response
{
	"stat": "ok",
	"status_code": "200",
	"user" :
		{
			"id" : 6322,
			"uid" : "infoway",
			"email" : "[email protected]",
			"createdDate" : 1300668603140,
			"upatedDate" : 1300668603140,
			"createdBy" : "[email protected]"
		}
}
JSON, FAILED Response
{
    "stat": "fail",
    "status_code": "404"
    "err": {
        "code": "3002",
        "msg": "The email has already used by another user."
    }
}
Adaptavist Theme Builder (4.2.0) Powered by Atlassian Confluence 3.3, the Enterprise Wiki