Skip to main content

list users

GET /api/users list users

Required scope: users:manage:all

Query Parameters
q string
Responses
200
Schema — OPTIONAL
data object[] — OPTIONAL
id string — OPTIONAL
uid string — OPTIONAL
username string — OPTIONAL
totp_registered_at date-time — OPTIONAL
metadata object — OPTIONAL
federated_metadata object — OPTIONAL
blocked boolean — OPTIONAL
group string — OPTIONAL
authorized_scopes object[] — OPTIONAL
id string — OPTIONAL
name string
label string
public boolean — OPTIONAL
organizations object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
label string — OPTIONAL
roles object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
scopes object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
public boolean — OPTIONAL
backend object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
type string — OPTIONAL
is_default boolean — OPTIONAL
create_default_organization boolean — OPTIONAL
roles object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
scopes object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
public boolean — OPTIONAL
metadata_fields object[] — OPTIONAL
federated_servers object[] — OPTIONAL
verifiable_credentials object[] — OPTIONAL
verifiable_presentations object[] — OPTIONAL
password_hashing_alg string — OPTIONAL
password_hashing_opts object — OPTIONAL
ldap_pool_size int32 — OPTIONAL
ldap_host string — OPTIONAL
ldap_user_rdn_attribute string — OPTIONAL
ldap_base_dn string — OPTIONAL
ldap_ou string — OPTIONAL
ldap_master_dn string — OPTIONAL
ldap_master_password string — OPTIONAL
smtp_from string — OPTIONAL
smtp_relay string — OPTIONAL
smtp_username string — OPTIONAL
smtp_password string — OPTIONAL
smtp_ssl boolean — OPTIONAL
smtp_tls boolean — OPTIONAL
smtp_port int32 — OPTIONAL
features string[] — OPTIONAL
401

The client is unauthorized to access this resource.

Schema — OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema — OPTIONAL
code string
message string