Skip to main content

List Tenant Members

Required role: admin or higher.

List the users that are members of the acting tenant and their roles.

Responses
200

Members retrieved

Schema OPTIONAL
object[]
display_name string OPTIONAL

The member's name, as the identity provider spells it; null until the provider has been asked.

email string OPTIONAL

Email, if the identity provider supplied one or an administrator recorded one when pre-provisioning the membership.

email_verified boolean OPTIONAL

Whether the identity provider vouches for email. False until the provider has been asked, and for providers that say nothing either way. An email an administrator typed is never verified, so this is what separates an address the provider stands behind from a claim about one.

origin string OPTIONAL

Possible values: [claim, derived, api]

How a membership row came into existence, kept for audit.

provider string

OIDC issuer the user authenticates through.

role string

Possible values: [read, write, admin, owner]

A role in the RBAC model. Declaration order defines the privilege order.

subject string

OIDC subject.

user_id uuid

Identifier of a persisted user (the principal behind an OIDC sub).

403

Caller's role is below the required role

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.