Platform

List Tenant Members

Required role: admin or higher.

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

get/v0/tenant/users

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Response

Members retrieved

display_namestring nullable

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

emailstring nullable

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

email_verifiedboolean

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'claim' | 'derived' | 'api'

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

providerstring required

OIDC issuer the user authenticates through.

role'read' | 'write' | 'admin' | 'owner' required

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

subjectstring required

OIDC subject.

user_idstring uuid required

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

Changes

No recorded changes to this operation across all 51 revisions of this API.