Invite and onboard a new user

Overview

Onboard a new member to your organization. This action triggers an automated invitation email.

Use Cases

• New Employee: Onboard a new team member with their required access level.
• External Partner: Invite a stakeholder to collaborate with specific roles.
• Automation: Programmatically create users as part of your internal onboarding flow.

Invitation Lifecycle

1. Request: You provide the user's email and initial configuration.
2. Created: The user account is initialized with confirmed: false.
3. Activation: The user receives an email to set their password and log in.
4. Completion: Once logged in, the user's status changes to confirmed: true.

Workflow Tip

• Use the Location header in the response to immediately access the new user's resource URI.
• You can pre-assign teams and roles during the invitation to ensure the user has access from their first login.

Related Operations

• List Users: GET /public/v1/users
• Discover Roles: GET /public/v1/users/roles/available
• Assign Roles: POST /public/v1/users/{userId}/roles

Required Permission

manage_public_users