Get Started
Application
Equipment
Comment
Request
User
User
Archive a User
Archive a User
PATCH
/
v1
/
users
/
{uid}
/
archive
curl --request PATCH \
--url https://api.siit.io/v1/users/{uid}/archive \
--header 'Authorization: Bearer <token>'
{
"result": {
"uid": "<string>",
"emails": [
"<string>"
],
"role_name": "owner",
"status": "employee",
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"slack_user_id": "<string>",
"department_uid": "<string>",
"office_location_uid": "<string>",
"legal_entity_uid": "<string>",
"team_uids": [
"<string>"
],
"hire_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"gender": "female",
"job_title": "<string>",
"preferred_language": "<string>",
"report_to_uid": "<string>",
"timezone": "<string>",
"work_phone": "<string>",
"microsoft_entra_ids": [
"<string>"
],
"archived_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The UID of the User
Response
200 - application/json
Successful
The response is of type object
.
curl --request PATCH \
--url https://api.siit.io/v1/users/{uid}/archive \
--header 'Authorization: Bearer <token>'
{
"result": {
"uid": "<string>",
"emails": [
"<string>"
],
"role_name": "owner",
"status": "employee",
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"slack_user_id": "<string>",
"department_uid": "<string>",
"office_location_uid": "<string>",
"legal_entity_uid": "<string>",
"team_uids": [
"<string>"
],
"hire_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"gender": "female",
"job_title": "<string>",
"preferred_language": "<string>",
"report_to_uid": "<string>",
"timezone": "<string>",
"work_phone": "<string>",
"microsoft_entra_ids": [
"<string>"
],
"archived_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
}