Sign in
Members

Add a member to a tenant

Changed on
post/api/v1/tenants/{name}/members

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/tenants/{name}/members
  • Auth: none declared

Path parameters

namestring Tenant identifier and logical tenant scope; not a Kubernetes Namespace. required

Request body

accountstring required

Email or username of the existing platform user to add.

roleName'tenant-admin' | 'user' required

Role to grant the member (tenant-admin or user).

Example request

{
  "account": "zhang.san@example.com",
  "roleName": "user"
}

Response

Member added.

addedAtstring date-time required

Time the member was added to the tenant.

displayNamestring

Human-readable name of the member.

emailstring email

Email address of the member.

roleName'system-admin' | 'tenant-admin' | 'user' required
userIdstring uuid required

User ID of the member.

usernamestring required

Username of the member.

Example response

{
  "addedAt": "2026-06-20T08:00:00Z",
  "displayName": "Li Wei",
  "email": "li.wei@example.com",
  "roleName": "tenant-admin",
  "userId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
  "username": "li.wei"
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      the response's property type changed from string to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      removed the system-admin enum value from the response property for the response status

    • info

      removed the tenant-admin enum value from the response property for the response status

    • info

      removed the user enum value from the response property for the response status