@@ -6,15 +6,15 @@ Please note that the base URL for user provisioning is
6
6
7
7
> One caveat is that User-Pre-Provisioning just provides basic user profile information that is
8
8
> linked when a user registers, which means that the pre-provisioned profiles are only listed in
9
- > the user list once they have registered themselves in the Employee Referrals application.
9
+ > the user list once they have registered themselves in the Employee Referrals application.
10
10
11
11
## Ingest User Profiles
12
12
13
13
> This is an example request body
14
14
15
15
``` json
16
16
{
17
- "users" : [
17
+ "users" : [
18
18
{
19
19
"first_name" :" Test" ,
20
20
"last_name" :" User" ,
@@ -114,6 +114,7 @@ To update a user profile, use the following request:
114
114
## Deactivate a User Profile
115
115
116
116
For deactivating a user profile, set the ` active ` field to false in the body and call the endpoint for updating a profile as follows.
117
+ Note: this only works for pre-provisioned users.
117
118
118
119
> This is an example request body
119
120
@@ -138,6 +139,35 @@ For deactivating a user profile, set the `active` field to false in the body and
138
139
| :-------------- | :------- | :----------------------------------------------------------------------------- |
139
140
| identifier | Yes | You may use either of the ` personnel_number ` or the email address of the user. |
140
141
142
+ ## Change User Profile Status
143
+
144
+ Directly change a user profile's enabled state.
145
+ This works with any type of user provisioning.
146
+
147
+ > This is an example request body
148
+
149
+ ``` json
150
+ {
151
+ "employeeId" :" 123" ,
152
+ "active" :false
153
+ }
154
+ ```
155
+
156
+ ### HTTP Request
157
+
158
+ ` PUT /v1/companies/{companyId}/users/profile/status `
159
+
160
+ ### UserStatusChange Request Body
161
+
162
+ Provide either ` email ` or ` employeeId ` (` personnel_number ` ) as ` string ` to identify the user.
163
+ Set ` active ` to ` true ` to activate the user, ` false ` to disable the user.
164
+
165
+ | Field name | Required | Description |
166
+ | :--------------- | :------- | :------------------------------------ |
167
+ | email | No | Email address |
168
+ | employeeId | No | The id of the employee in your system |
169
+ | active | Yes | Set user to active or not |
170
+
141
171
## Delete a User Profile
142
172
143
173
To delete a user profile, use the following request:
@@ -185,4 +215,4 @@ Delete a user profile without pre-provisioning
185
215
` DELETE /v1/companies/{companyId}/users/{email} `
186
216
187
217
** Note for Deleting user without pre-provisioning:**
188
- * This will delete the user in the Employee Referrals systems irreversibly
218
+ * This will delete the user in the Employee Referrals systems irreversibly
0 commit comments