Create user

POST

/agent/integration/api/v1/users

This API call will create a user on the Spencer platform.

The attribute authentication_type defines the way of authentication for the user:

SSO: use value company_account. The attribute authentication_id must be present and contain the SSO IDP's UPN of the user (usually email).

username/password: use value username_password. At least one of the following fields must be present: email, email_private, mobile, mobile_private or alias.

IMPORTANT: our endpoints return verbose error messages in their JSON return bodies. Inspect them during development / debugging.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
    "id": "string",
    "firstname": "string",
    "lastname": "string",
    "preferred_language": "nl-BE",
    "authentication_type": "company_account",
    "authentication_id": "string",
    "email": "user@example.com",
    "email_private": "user@example.com",
    "mobile": "+322123456",
    "mobile_private": "+322123456",
    "phone": "+322123456",
    "phone_private": "+322123456",
    "alias": "string",
    "manager_id": "string",
    "sex": "string",
    "country": "st",
    "default_site_id": "string",
    "workstation": "string",
    "subsidiary": "string",
    "company": "string",
    "date_of_birth": "2019-08-24T14:15:22.123Z",
    "company_join_date": "2019-08-24T14:15:22.123Z",
    "archived_at": "2019-08-24T14:15:22.123Z",
    "translations": [
        {
            "locale": "string",
            "contract_type": "string",
            "department": "string",
            "division": "string",
            "sub_division": "string",
            "job_title": "string",
            "domain": "string",
            "region": "string",
            "zone": "string"
        }
    ],
    "user_identifiers": [
        {
            "identifier_key": "string",
            "value": "string"
        }
    ],
    "tags": [
        "string"
    ],
    "property1": "string",
    "property2": "string"
}

Request Code Samples

Shell

HTTP

curl --location '/agent/integration/api/v1/users' \
--header 'x-spencer-request-id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "firstname": "string",
    "lastname": "string",
    "preferred_language": "nl-BE",
    "authentication_type": "company_account",
    "authentication_id": "string",
    "email": "user@example.com",
    "email_private": "user@example.com",
    "mobile": "+322123456",
    "mobile_private": "+322123456",
    "phone": "+322123456",
    "phone_private": "+322123456",
    "alias": "string",
    "manager_id": "string",
    "sex": "string",
    "country": "st",
    "default_site_id": "string",
    "workstation": "string",
    "subsidiary": "string",
    "company": "string",
    "date_of_birth": "2019-08-24T14:15:22.123Z",
    "company_join_date": "2019-08-24T14:15:22.123Z",
    "archived_at": "2019-08-24T14:15:22.123Z",
    "translations": [
        {
            "locale": "string",
            "contract_type": "string",
            "department": "string",
            "division": "string",
            "sub_division": "string",
            "job_title": "string",
            "domain": "string",
            "region": "string",
            "zone": "string"
        }
    ],
    "user_identifiers": [
        {
            "identifier_key": "string",
            "value": "string"
        }
    ],
    "tags": [
        "string"
    ],
    "property1": "string",
    "property2": "string"
}'

Responses

🟢201201.user

application/json

Headers

Bodyapplication/json

Example

{"id":"12345","firstname":"pariatur elit Lorem nulla","lastname":"incididunt ","email":"nulla aliqua","manager_id":"12345","preferred_language":"ut","country":"veniam","company_join_date":"2015-10-06T11:42:06.733Z","phone_private":"culpa","mobile":"Duis Ut enim","email_private":"","workstation":"et adipisicing","subsidiary":"occaecat nulla voluptate adipisicing","company":"magna occaecat nostrud","date_of_birth":"2001-07-29T01:05:54.413Z","translations":[{"locale":"Lorem dolor pariatur mag","contract_type":"irure","department":"exercitation nulla aute magna","division":"laboris","sub_division":"aliquip aliqua exercitation fugiat","job_title":"proident amet non esse dolore","domain":"dolor ipsum","region":"mollit","zone":"p"},{"locale":"dolor et tem","contract_type":"in aliquip ipsum minim","department":"eiusmod cillum non","division":"proident irure elit enim sit","sub_division":"nisi enim et","job_title":"dolor ipsum qui officia veniam","domain":"est elit","region":"Duis exercitation in","zone":"laboris irure"},{"locale":"ad culpa","contract_type":"sint ex","department":"consectetur","division":"proident dolore eu aliqua","sub_division":"ipsum et tempor","job_title":"sit","domain":"ad voluptate veniam dolore et","region":"ea","zone":"ad laboris"},{"locale":"ea","contract_type":"ullamco Lorem esse nostrud Ut","department":"minim ut","division":"eiusmod in sed minim et","sub_division":"commodo ad sed","job_title":"eiusmod mollit qui","domain":"aliquip","region":"magna Ut ipsum","zone":"laborum Lorem voluptate ad"},{"locale":"minim Ut exercitation laborum","contract_type":"consequat irure exercitation","department":"aliqua Excepteur cillum adipisicing","division":"culpa incididunt commodo reprehenderit ut","sub_division":"sunt adipisicing Lorem pariatur consectetur","job_title":"proident","domain":"","region":"eu in","zone":"nulla"}]}

🟠400400.badRequest

🟠401401.unauthorized

🟠403403.forbidden

🟠404404.notFound

🟠409409.conflict

🔴500500.internalServerError

Users

Fetch user