The Terminated User Processing API is designed to streamline the process of managing terminated users in HRIS (Human Resources Information Systems) and ensuring that these changes are communicated to downstream systems, such as Physical Access Control Systems (PACS). When this API is invoked, it creates an event that is subscribed to by downstream systems through the Oloid workflow.
API Name
Terminated User Sync API
API Endpoint
https://<domain>/cloudkey/custom-actions
Authorization
1. API Key : Authorization: <API_KEY>
2. OAuth 2.0 : Authorization: Bearer <access_token>
Use the client ID and secret provided by Customer Success Representative to obtain an access token from the OAuth 2.0 Login endpoint.
Mandatory Fields
The following fields are required when making a request to this endpoint:
- `EndpointID`: The unique identifier for the endpoint.
- `EmployeeID`: The identifier for the employee in the HRIS system.
- `Firstname`: The first name of the employee.
- `Lastname`: The last name of the employee.
- `Status`: Must be set to `TERMINATED` to indicate the user’s termination status.
Additional Fields
While the above fields are mandatory, the system can accept additional fields as needed.
Example Request
Here’s an example of how to use the API with `curl`:
curl --location 'https://<domain>/cloudkey/custom-actions' \
--header 'Authorization: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"EndpointID": "<ENDPOINT_ID>",
"EmployeeID": "A123",
"Firstname": "Test",
"Lastname": "User 1",
"Status": "TERMINATED"
}'
curl --location 'https://<domain>/cloudkey/custom-actions' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"EndpointID": "<ENDPOINT_ID>",
"EmployeeID": "A123",
"Firstname": "Test",
"Lastname": "User 1",
"Status": "TERMINATED"
}'
Workflow Integration
- Upon successful API invocation, an event is created that downstream systems can subscribe to via the Oloid workflow.
- This ensures terminated user information is propagated efficiently to all necessary systems, maintaining synchronization and compliance.
Notes
- Make sure to replace `<API_KEY>` and `<ENDPOINT_ID>` with the actual values provided to you.
- The API expects a JSON payload, so ensure your request body is formatted correctly.
Contact
For any issues or further assistance, please reach out to Customer Support or your Customer Success representative.