Onboard a user
Onboards the user via the Zero-Touch (access-template) flow: provisions the access the template rules match for the user’s org info. Does not change the user — set org info and manager beforehand with PATCH /users/; onboarding requires the user to have a manager. Omit scheduled_at to provision now; a future timestamp defers provisioning. Calling again for a user already onboarding reschedules the planned provisioning to the new scheduled_at (omit it to provision now); an onboarding already being provisioned can no longer be rescheduled.
Authorizations
Bearer token authentication. Pass your AccessOwl API token in the Authorization header as Bearer <token>.
Headers
Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.
1 - 255Path Parameters
User ID
Body
Onboard parameters
Request body for onboarding a user via the Zero-Touch (access-template) flow. Omit scheduled_at to provision now; provide a future timestamp to defer provisioning to that date.
When to provision access. Omitted or null provisions now; a future ISO 8601 timestamp defers it. For a user already onboarding, this reschedules the planned provisioning.
Response
User onboarding triggered
A user in the organization
Email address
First name
User ID
Last name
Current status
active, inactive, onboarding, onboarding_provisioning_planned, offboarding, offboarding_planned, offboarded Deactivation timestamp
Departments the user belongs to
Employment type
full_time, part_time, contract, freelance, internship, apprenticeship, working_student, training Full name (computed)
Creation timestamp
Job title
City location
Manager user ID
Teams the user belongs to
Last update timestamp

