3.2. Create a User
Method | URL |
---|---|
POST | /oauth2/ctid/create |
Creates a new user via the OAuth flow.
Request Body
Key | Required? | Data Type | Description |
---|---|---|---|
brokerCrmName | Yes | string | Please, see Section 2.3. |
email | Yes | string | The user’s email address. |
firstName | No | string | The user’s first name. The value of this parameter can be used for sending notifications (e.g., ‘Dear |
preferredLanguage | No | string | The user’s preferred language. Takes Alpha-2 (ISO 369-2) codes as values. |
Output
Key | Data Type | Description |
---|---|---|
userId | integer | The unique ID of a specific user. |
Request Example
curl -X POST ‘https://HOST:PORT/cid/oauth2/ctid/create?token=04d95575-c9af-42fba72e-2f0ce93f01d4’ -H ‘Content-Type: application/json’ -H ‘Accept: application/json’ -d ‘{"brokerCrmName": "BESTBROKERCRM", "email": "president%40bestbroker.com", "firstName": "Trader", "preferredLanguage": "en"}’
Expected Response Status Code
201
Response Example
{
"userId": 10345533
}
Last update: February 6, 2023