Skip to main content

Members

Members belong to the AISIX Cloud organization. They represent the people or service owners responsible for Cloud administration, API keys, usage, and limits.

AISIX Cloud supports two member onboarding paths:

  • Invite a member when they need to sign in to the dashboard.
  • Create a member directly when you need an API key owner that does not sign in to the dashboard.

Both paths create organization members. The difference is whether the member receives an invitation and can use the dashboard.

Invite a Member

Use an invitation when the person needs dashboard access to manage resources, view usage, or administer the organization.

  1. Open Members and select Invite member.
  2. Enter the member's email address and choose a role.
  3. Send the invitation and share the one-time invitation link.

The invitee opens the link, signs up, sets a password, and joins the organization with the selected role. Until the invitee accepts, the invitation stays pending on the Pending invitations tab.

Create a Member Directly

Create a member directly when the member only needs to own API keys and does not need dashboard access. Typical cases include services, applications, or developers in a private deployment where dashboard access is restricted.

A directly created member:

  • It becomes active immediately, with no invitation link or confirmation step.
  • It can be added to teams and assigned API keys.
  • It can be governed with rate limits and budgets.
  • It has no password, so it cannot sign in to the dashboard.

The member still has a name and email address. Use values that identify the responsible person, service, or application owner so usage and limits can be attributed correctly.

In the Dashboard

  1. Open Members and select Create user.
  2. Enter a Name and an Email that identify the responsible owner.
  3. Select Create user.

The member appears in the list right away. You can then add the member to a team and issue API keys from the environment that serves its traffic.

Use the API

Use the API when you need to provision members from automation.

Authenticate with an organization admin token that has write scope. Admin tokens are scoped to one organization, so the request does not need a separate organization header.

curl -X POST "https://<your-cp-api-host>/api/members" \
-H "Authorization: Bearer $AISIX_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Responsible Person",
"email": "svc-payments@example.com"
}'

A successful call returns 201 Created with the new member:

{
"member": {
"id": "8f3b2a1c-9d4e-4f6a-b7c8-1e2d3f4a5b6c",
"user_id": "2c7d6e5f-4a3b-4c2d-8e1f-9a0b1c2d3e4f",
"email": "svc-payments@example.com",
"display_name": "Responsible Person",
"role": "member"
}
}

The email address must be valid and unique across the deployment. For an application owner, you can use a synthetic address such as svc-payments@example.com. Reusing an existing email address returns 409 Conflict. Directly created members always use the member role.

Next Steps

Continue with Managed Gateway to connect a gateway to the Cloud environment that serves traffic for member-owned API keys.

API7.ai Logo

The digital world is connected by APIs,
API7.ai exists to make APIs more efficient, reliable, and secure.

Sign up for API7 newsletter

Product

API7 Gateway

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2026. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the Apache Software Foundation