Configure Self-Sign-Up¶
Choreo allows you to configure self-sign-up to enable users to access your Developer Portal via a self-sign-up page.
This page walks you through the steps to configure self-sign-up to the Developer Portal.
Prerequisites¶
- Sign in to the Choreo Console at https://console.choreo.dev/ using your Google, GitHub, or Microsoft account.
-
If you are a new user, create an organization with a unique organization name. For example, "Stark Industries".
Configure self-sign-up¶
- Click Settings in the left navigation menu of the Choreo Console.
- Click Copy Handle to copy the organization handle to the clipboard.
-
Go to the Asgardeo sign-up page and register using the same email address/user account you used to sign up with Choreo.
Tip
You must sign up to Asgardeo with the same email address/user account you used to sign in to Choreo because the organization name is reserved for that user account.
-
In the Organization Name field, paste the organization handle that you copied from the Settings page in Choreo.
-
Click Create. This creates a new organization so that you can proceed to access your workspace.
-
Send an email similar to the following to [email protected] requesting to configure enterprise IdP for the Developer Portal of your organization.
Tip
Be sure you mention the organization name or handle in the request.
Sample email
Subject : [Stark Industries] Configure enterprise IdP for Developer Portal
Hi CS team,
I need to configure enterprise IdP for my organization’s Developer Portal to enable self-sign-up. Can you please do the necessary configurations to proceed? My organization details are as follows: - Organization name: Stark Industries - Organization handle: starkindustries
Thank you
The Choreo support team will perform the necessary configurations and respond to you.
-
On receiving the response, sign in to your Asgardeo account and click View all applications.
You will see an application named WSO2_LOGIN_FOR_CHOREO_DEV_PORTAL.
-
Click on the application to edit it and enter your organization’s Developer Portal URL as the Access URL of the application. For example,
https://devportal.choreo.dev/starkindustries
. - Click Update.
-
To add user attributes, follow these steps:
- Click the User Attributes tab.
-
Select user attributes as follows:
- To add the email as a mandatory user attribute, expand Email and select the Mandatory checkbox for it.
- To add the first name and the last name as optional, expand Profile and select the Requested checkbox for the First Name and the Last Name fields.
-
Click Update.
-
To add the user attributes as OpenID Connect scopes, follow these steps:
-
To configure basic authentication as the sign-in method, follow these steps:
-
To configure self-registration, follow these steps:
Once you complete these steps, the Choreo support team will perform the final self-sign-up configuration, and you will see a sign-up link similar to the following in your Developer Portal:
Users can click LOGIN/SIGN UP and then click Create an account to sign up to your Developer Portal without having to send you a request to register them.
Approve or reject new users¶
To manage the users who try to access your Developer Portal via self-sign-up, you can follow either of the following approaches:
- Enable auto-approval: This involves automating the user approval process. When you enable auto-approval, you allow each user who signs up to access your Developer Portal by default.
- Manually approve/reject: This allows you to view all the user registrations in a list and approve/reject each registration as required.
Enable auto-approval for new user registrations¶
To enable auto-approval and automatically approve each new user account registered to your Developer Portal, follow the steps given below:
-
Click Settings in the left navigation menu of the Choreo Console.
-
Click Self Signups.
-
Toggle the Auto-approval switch.
Once you enable auto-approval, the users can sign in to your Developer Portal and view your APIs and applications soon after they create an account.
Manually approve or reject user accounts¶
If you have not enabled auto-approval, you can manually approve/reject the new user registrations. Once a user creates an account, Choreo sends an email to ask the user to confirm the account. To manually approve/reject user accounts that were confirmed by users, follow the steps given below:
-
Click Settings in the left navigation menu of the Choreo Console.
-
Click Self Signups. You will see the user accounts listed for approval.
-
If you want to approve a user account, click Approve for it. If not, click Reject.
If you approve, the user will receive an email confirming that the user account is approved.
If you reject the user account, Choreo sends an email to inform the user that the user account is rejected. Once you reject a user account, that user cannot sign up to your Developer Portal via that account again.