User Model

Whenever you get in touch with users in our API the data you get or need to send with are modelled following this user model. Please be aware of that all optional properties can be null. Properties that are marked as read-only cannot be changed when using our API directly.

Note: If you want to use the properties position, department and/or location for conditional group tagging, please use a custom profile field and enable tagging for the newly created custom field.

This is an example JSON request for creating (POST) a user.

Copy To Clipboard
1{
2    "externalID": "jd123",
3    "userName": "john.doe",
4    "secret": "start1234",
5    "recoveryCode": "reset1234",
6    "recoveryCodeExpires": "1640905200000",
7    "emails/primary": "john@doe.com",
8    "sendMail": false,
9    "avatar": "{{URL}}",
10    "role": {
11        "type": "admin"
12    },
13    /* fill custom profile fields */
14    "profile": {
15        "{{customProfileFieldId}}": "{{valueXY}}"
16    },
17    /* fill system profile fields */
18    "firstName": "John",
19    "lastName": "Doe",
20    "publicEmailAddress": "john@doe.com",
21    "position": "Developer",
22    "department": "Development & Research",
23    "location": "Chemnitz",
24    "phoneNumber": "+491234567890",
25    /* set user's content language */
26    "config": {
27      "locale": "en_US"
28    }
29}

This is an example JSON response for retrieving (GET) a user.

Copy To Clipboard
1{
2    "activated": "2021-12-14T08:21:13.949Z",
3    "avatar": {
4        "original": {
5            "url": "{{URL}}",
6        },
7        "icon": {
8            "url": "{{URL}}",
9        },
10        "thumb": {
11            "url": "{{URL}}"
12        }
13    },
14    "config": {
15        "locale": "en_US"
16    },
17    "created": "2021-02-28T09:39:44.431Z",
18    "department": "Development & Research",
19    "emails": [
20        {
21            "value": "john@doe.com",
22            "primary": true
23        }
24    ],
25    "externalID": "jd123",
26    "firstName": "John",
27    "groupIDs": [],
28    "id": "603b64e00c3fdb29134eb89b",
29    "lastName": "Doe",
30    "location": "Chemnitz",
31    "mandatoryGroupIDs": null,
32    "phoneNumber": "+491234567890",
33    "position": "Developer",
34    "profile": {
35        /* summary of user system + custom profile fields */
36        "firstName": "John",
37        "lastName": "Doe",
38        "phoneNumber": "+491234567890",
39        "publicEmailAddress": "john@doe.com",
40        "location": "Chemnitz",
41        "position": "Developer",
42        "department": "Development & Research",
43        "{{customProfileFieldId}}": "{{valueXY}}",
44        "avatar": {
45            "original": {
46                "url": "{{URL}}",
47            },
48            "icon": {
49                "url": "{{URL}}",
50            },
51            "thumb": {
52                "url": "{{URL}}"
53            }
54        }
55    },
56    "publicEmailAddress": "john@doe.com",
57    "recoveryCode": {
58        "expires": 1640905200000,
59        "plain": "reset1234"
60    },
61    "role": {
62        "type": "admin"
63    },
64    "userName": {
65        "value": "john.doe",
66        "providerID": "staffbase"
67    },
68    "status": "activated",
69    "tags": [
70        /* tags for group tagging */
71        "profile:{{customProfileFieldId}}:{{valueXY}}"
72    ],
73    "updated": "2021-02-28T09:39:44.441Z"
74}