Skip to content
Documentation
  • There are no suggestions because the search field is empty.

How to invite a user to an organization?

This article demonstrates the different options available to invite a user to an organization

 

If you started with Zitadel before v3, to simplify this process, it's recommended to enable the Feature Flag "Use V2 Api in Console for User creation" in the Default Settings.

  1. Creating a User via the Console:
    1. Navigate to the Organization
      1. Go to: Organization → Users → New
    2. Configure the User profile
      1. ✅ Check Send an invitation E-Mail for authentication setup and E-Mail verification.
    3. User Creation
      1. An email will automatically be sent to the user to complete initialization.
    4. Accept the invitation
      1. The user clicks the link in the email.
      2. They set a new password.
      3. Their account is now ready to use.
  2. Creating a user via the API
    1. Create the user with the following endpoint:

      1. Create a User - You can request a code to be sent to the user to validate the email and set a password:

        {
          "username": "<username>",
          "organizationId": "<organization_id>",
          "human": {
            "profile": {
            "givenName": "<name>",
            "familyName": "<lastname>",
            "nickName": "<nickname>",
            "displayName": "<display_name>",
            "preferredLanguage": "<lang>",
            "gender": "<gender>"
            },
          "email": {
            "email": "<email>",
            "sendCode": {}
            }
        }
        }
    1. As with the console approach, the user will receive an email with a link to create a password and complete registration

Reference: