API ReferenceEnrolment Intents

Create a new enrolment intent for a group policy

Creates a new enrolment_intent to manage the enrolment of an employee into a group. An enrolment intent represents the intention to enrol an employee into a specific group, and tracks the status and progress of that enrolment process.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Request

This endpoint expects an object.
employee_idstringRequiredformat: "ee_.+"

Identifier for the employee associated with this enrolment intent. Prefixed with ee_.

group_idstringRequiredformat: "gr_.+"

Identifier for the group associated with this enrolment intent. Prefixed with gr_.

force_confirmationbooleanRequired

If set to true, the system will always force the PendingConfirmation state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.

policy_configurationobject or nullOptional
Policy configuration associated with this enrolment intent. You do not have to explicitly provide this field if you want to use the default policy configuration for the group. This simply lets you override specific settings for this enrolment intent.

Response

OK
idstringformat: "ei_.+"

Unique identifier for the enrolment intent. Prefixed with ei_.

employee_idstringformat: "ee_.+"

Identifier for the employee associated with this enrolment intent. Prefixed with ee_.

group_idstringformat: "gr_.+"

Identifier for the group associated with this enrolment intent. Prefixed with gr_.

statusenum
Current status of the enrolment intent.
force_confirmationboolean

If set to true, the system will always force the PendingConfirmation state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.

policieslist of objects or null
Policies to be created as part of this enrolment intent.
objectstring or null
The object type
ineligibility_reasonobject or null

If the enrolment intent status is ineligible, this field provides details about the reason for employees ineligibility.

policy_configurationobject or null
Policy configuration associated with this enrolment intent.
action_requiredobject or null

If the enrolment intent status is action_required, this field provides details about the action that needs to be taken to proceed with the enrolment.

pending_confirmationobject or null

If the enrolment intent status is pending_confirmation, this field provides details about the pending confirmation state.

Errors