Onboard users to organizations¶

Organization administrators can add users to their organization using the following methods.

Onboard users from

Before you begin

Make sure you have created an organization in Asgardeo and onboarded an administrator. See how to create an organization and onboard admins.
In the following guides, the organization's management interface is referred to as the Console. Make sure you switch to the correct organization and perform actions within its Console. Learn how to switch organizations.

Onboard new users from the Console¶

Organization administrators can use the Console to create users in the organization. Users can be added individually or as a collection from the Console.

To add a single user, follow this guide.
To add multiple users, follow this guide.

Onboard users from a secondary user store¶

Organization administrators can configure multiple secondary user stores for the organization. Once configured, users from the secondary user stores can log into the organization and perform operations permitted by the roles assigned to them.

To connect a secondary user store, follow this guide.

Invite existing users from the parent organization¶

Sometimes, organizations might need help from parent organization members when carrying out administrative tasks. In such cases, organization administrators can invite parent organization users to join. Additionally, if more parent organization members are needed, administrators can delegate the task of joining them to those who have already joined the organization.

When you invite users, you can also assign them to specific roles to provide the right level of permissions.

Prerequisites¶

In order to invite users from the parent organization, get to know the usernames of the users through an offline channel.

Invite users¶

If a user of the organization with Asgardeo Console access needs to invite a user from the parent organization, follow the steps below.

Login to your organization using the link https://console.asgardeo.io/t/{root-organization-name}/o/{organization-id}.
Go to User Management > Users and click Add user. From there, select Invite Parent User.
Enter the usernames of the user that you want to invite to the organization. You can enter multiple usernames by pressing enter after each username input.
Select the groups that you want to assign to the invited users.
Click Invite.
The invited users will receive an email notification with the invitation link which they can click to accept.
Note
- You can only invite users from your immediate parent organization.
- Asgardeo Console allows you to invite users from the DEFAULT user store of your immediate parent. To invite a user from a different user store, use the invite parent user API.

If a user, who is a member of both the organization and parent organization, wishes to invite more members from the parent organization, follow the steps below.

Login to your organization (root) on the Asgardeo Console.
Go to Organizations and select the organization to which you wish to invite users.
Switch to that organization.
Go to User Management > Users and click + Add user. From there, select Invite Parent User.
Enter the usernames of the users that you want to invite to the organization. You can enter multiple usernames by pressing enter after each username input.
Select the groups that you want to assign to the invited users.
Click Invite.
You can see whether the invitation is successful or not as follows.
The invited users will receive an email notification with the invitation link. The invited users can accept the invitation by clicking the link.

Accept invitations¶

The invited users will receive an email similar to the following, containing an invitation link valid for 72 hours.
Click the Accept Invitation button in the email to accept it.
Once the invitation is accepted, the invited users will be displayed in the Asgardeo Console as follows.

Manage invitations¶

Inorder to view or delete the invitations via Asgardeo Console:

Login to the relevant organization space of the Asgardeo Console.
Go to User Management > Users and click Invitations tab.
You can view the list of invitations that are sent to the users of the parent organization with their status.
If required, invitations can be deleted by clicking the Delete icon.

Invite users without sending email notifications from Asgardeo¶

In order to disable sending email notifications internally from Asgardeo, manageNotificationsInternally property can be set to false in Parent Organization's User Invitation API. The following sample request can be used to obtain the confirmation code without sending email notifications.

curl --location --request POST 'https://api.asgardeo.io/t/{{ organization_name }}/o/api/server/v1/guests/invite' \
--header 'Authorization: Bearer <access-token-obtained-for-the-organization>' \
--header 'Content-Type: application/json' \
--data '{
 "usernames": [
    "[email protected]",
    "[email protected]"
 ],
 "roles": [
    "f5b761ca-62f2-48ba-935b-f7b460f58e5c",
    "657fgq22-62f2-48ba-935b-f7bfgh6438fd"
 ],
 "groups": [
    "48badf-rty20-48ba-935b-f7b460f58e5c",
    "fd234100-c115-45dc-ad11-70846b783866"
 ],
 "properties": [
    {
       "key" : "manageNotificationsInternally",
       "value" : "false"
    }
 ]
}'

Sample Response will contain the confirmation code as follows.

   [
       {
           "username": "[email protected]",
           "result": {
               "status": "Successful"
           },
           "confirmationCode": "390feadd-4e03-404c-95bd-1c451acc2bad"
       },
       {
           "username": "[email protected]",
           "result": {
               "status": "Successful"
           },
           "confirmationCode": "7474473c-64d4-4a11-8f50-fe5c63bae88f"
       }
   ]

If you are sending the invitation email through an external service, include this confirmation code, which need to be accepted through following invitation accepting API. If your applications wants to proceed parent user invitation flow without any email sending, applications can invoke the following API call as the next step.

curl --location --request POST 'https://api.asgardeo.io/t/{{ organization_name }}/o/api/server/v1/guests/invitation/accept' \
--header 'Authorization: Bearer <access-token-obtained-for-the-organization>' \
--header 'Content-Type: application/json' \
--data '{
   "confirmationCode": "2663329b-c8c5-4c71-9500-9ea8c4e77d94"
}'