Admins

Uses: Kong Gateway Admin API
Related Documentation
OpenAPI Specifications
Incompatible with
konnect
Tags

What is an admin?

Admins in Kong Gateway are RBAC entities used to used to manage all administrators for a specific Workspace. Admins can be managed using the Admin API or Kong Manager and are used in the following operations:

Admins can only interact with entities from within their Workspace. Depending on the admin’s specific role, they can enforce RBAC roles and permissions across that Workspace, including creating and inviting other admins.

Schema

Invite an admin

Inviting an admin can only be done if you have enabled RBAC. You can invite an admin by issuing a POST request to /admins.

If you haven’t configured email capabilities your admin won’t receive an invite link, but the link will still be created. You can copy the generated invite link from the Kong Manager UI and provide it directly to your intended admin.

By default, the invite link expires after 259,200 seconds (3 days). You can customize this time frame by adjusting the admin_invitation_expiry parameter in kong.conf.

FAQs

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!