Portal details and registration

Your API Portal's name, sign-up rules and registration form live under Settings, Portal settings, Portal details. Each setting is its own block with its own Save Changes button, so you change and save one at a time.

Where do you set the portal name and registration?

Open Settings at the bottom of the dashboard sidebar, then Portal settings, then Portal details. Edit a block, then choose that block's Save Changes. A block's button enables only once its value has changed.

1. Open Settings, Portal settings, Portal details.
2. Find the block you want, for example Portal name or Registration process approval.
3. Change the value.
4. Choose Save Changes on that block.

How do you change your API Portal name?

Edit Portal name and choose Save Changes. The block also shows your portal's address under Your portal is visible at. Renaming does not change that address or the portal's pages.

The name identifies the portal in the dashboard. It is also the portal name in emails your portal sends to developers, such as "Team invitation from" followed by the name. Until you set one, those emails use your tenant name followed by Portal. Renaming needs the Organisation Admin role. To serve the portal on your own address, see Custom domain.

How does registration approval work?

Choose an approval group under Registration process approval. A member of that group must then approve each new developer before they get full access to the portal, and the group is emailed about each registration. Clear the group to let sign-ups through without review.

The dashboard's own description of Default Approval Group mentions scope grant requests only. It also receives production review submissions, as above. You create the groups themselves under Approval groups.

How do you add terms acknowledgements at sign-up?

Fill in Registration acknowledgement text to set the consent checkbox on the sign-up form, and add more checkboxes under Extra Acknowledgements. Then choose Save Changes for the block.

Publish a page with the slug terms under Portal, Pages so that link works. Under Extra Acknowledgements, + Add adds another checkbox with its own label, warning, link text and URL. Remove one with the cross in its corner.

What extra fields can you collect at registration?

Company details and your own custom fields. Additional portal registration fields has a Company toggle. Portal registration custom fields lets you define fields of type String, Boolean or Selection, on plans that include custom registration properties.

With Company on, the registration wizard asks for company details and groups developers into companies by email domain, creating a company for a new domain unless one exists. You then manage them under Consumers, Company. See Teams and companies.

For custom fields, turn on Enable registration custom properties, set the section's Title text and Additional text, then add fields with Add new registration custom property. Each field has:

• A Name, and an API id you can copy.
• A Type: String, Boolean, or Selection.
• A Required flag and an optional Description.
• For Selection, its Options, a Default Value, and Allow multiple values.

The section's defaults are "Additional Details" and "Almost there! Just a few more questions." A field already answered by developers, or used by a redirect rule, can only be disabled, not deleted, so its data is kept. Show disabled properties lists them so you can enable them again.

Can you send developers somewhere after they register?

Yes, on plans that include registration redirects. Under Post registration redirect, turn on Enable post-registration redirects. Either set Always redirect with one Redirect URL for everyone, or add items with Add new redirection item that redirect based on custom field answers.

Each item redirects when all of its conditions are true. A condition pairs a Registration property to evaluate with the Registration property value to match.

How do you block sign-ups from personal email addresses?

Turn on Prohibit under Prohibit registration with public email addresses, then choose Save Changes. Sign-ups with addresses at public email providers are then refused, both in the sign-up form and on the server.

Developers who try see "This portal requires a business or professional email address for registration. Public email addresses (like Gmail, Yahoo, etc.) are not permitted."

How does team domain joining work?

Team domain joining lets developers link their team to their company email domain, so colleagues who register with the same domain can join that team. Turn on Enable team domain joining, and optionally Prevent users from creating their own team when domain joining is available, then save.

How do you set the support email and default product tab?

Both are blocks in Portal details that save on their own. The support email is where developers are told to write when something goes wrong. The default tab decides what developers see first on a product.

Choose plans to lead developers to subscribing, or documentation to lead with the API reference.

Troubleshooting

Match what you see to the fix.

Where to next