Versions Compared

Old Version 3

changes.mady.by.user Troels Nielsen

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

Creates a new entity/user account in the Rubiq database with fields specified in a contract between the calling application and the Rubiq platform. A unique Rubiq entity ID is automatically assigned to the new entity, and optionally a key with an external type.



 
Endpoint ID:

1001

Method
Status
colourGreen
titlePOST
URL:

/userentity/ {highlight:orange}orange{highlight}

{contract-id}


contract-id

Identifies the set of contract fields passed in the request body. If omitted, the default contract for the particular app is used.

Request body:

JSON data with properties corresponding to the fields in the specified contract

Code Block
titleExample 1 - Contract specifies full name, email and password:
{
	"name": "John Doe",
	"email": "mailbox@mailserver.com",
	"password": "password"
}



Span
stylewhite-space:pre
Response body:


JSON data with key(s) for the newly created account and data for the account. The result will always hold the

dialogportal™ master key

Rubiq entity ID and if the app making the request is configured to use a specific external key, this key is also included in the response.

Code Block
titleExample 1 – App setting specifies no specific key:
{
	"
dpKey
id": 123456
	"name": "John Doe",
	"email": "mailbox@mailserver.com",
}


Code Block
titleExample 2 – App setting specifies external key type:
{
	"
dpKey
id": 123456,
	"extKeyType": 12,
	"extKey": "key"
	"name": "John Doe",
	"email": "mailbox@mailserver.com",
}

 

Status codes:201

Account was created with success

 


303

Account already exists, redirected to “Get Account Data”


 400

Request is valid but data validation failed

In case SMS verification is enabled, the following sub codes may be returned:

400.3Mobile number is not in a valid format
400.4Mobile number is not unique (the mobile number belongs to an active entity - this includes entities that have not yet been verified)
400.5Mobile number is not unique (the mobile number belongs to an inactive entity)