Skip to content

Document set user state directly endpoint. #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
geolich merged 1 commit into from
Dec 10, 2024
Merged

Document set user state directly endpoint. #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions source/includes/_userprovisioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Please note that the base URL for user provisioning is

> One caveat is that User-Pre-Provisioning just provides basic user profile information that is
> linked when a user registers, which means that the pre-provisioned profiles are only listed in
> the user list once they have registered themselves in the Employee Referrals application.
> the user list once they have registered themselves in the Employee Referrals application.

## Ingest User Profiles

> This is an example request body

```json
{
"users": [
"users": [
{
"first_name":"Test",
"last_name":"User",
Expand Down Expand Up @@ -114,6 +114,7 @@ To update a user profile, use the following request:
## Deactivate a User Profile

For deactivating a user profile, set the `active` field to false in the body and call the endpoint for updating a profile as follows.
Note: this only works for pre-provisioned users.

> This is an example request body

Expand All @@ -138,6 +139,35 @@ For deactivating a user profile, set the `active` field to false in the body and
| :-------------- | :------- | :----------------------------------------------------------------------------- |
| identifier | Yes | You may use either of the `personnel_number` or the email address of the user. |

## Change User Profile Status

Directly change a user profile's enabled state.
This works with any type of user provisioning.

> This is an example request body

```json
{
"employeeId":"123",
"active":false
}
```

### HTTP Request

`PUT /v1/companies/{companyId}/users/profile/status`

### UserStatusChange Request Body

Provide either `email` or `employeeId` (`personnel_number`) as `string` to identify the user.
Set `active` to `true` to activate the user, `false` to disable the user.

| Field name | Required | Description |
| :--------------- | :------- | :------------------------------------ |
| email | No | Email address |
| employeeId | No | The id of the employee in your system |
| active | Yes | Set user to active or not |

## Delete a User Profile

To delete a user profile, use the following request:
Expand Down Expand Up @@ -185,4 +215,4 @@ Delete a user profile without pre-provisioning
`DELETE /v1/companies/{companyId}/users/{email}`

**Note for Deleting user without pre-provisioning:**
* This will delete the user in the Employee Referrals systems irreversibly
* This will delete the user in the Employee Referrals systems irreversibly
Loading