GET
/api/admin/users/listAdminList every user
Lists every registered account (humans and service accounts) with its verification, admin and disabled flags and profile fields.
operationId
get_api_admin_users_listAdministrationAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Platform administrators only
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| data* | object | |
| users* | AdminUserRecord[] | |
| email* | string (email) | |
| email_verified | boolean | |
| uid* | string (uuid) | |
| created_at* | number | minimum: 0 |
| invite_code | string | minLength: 8maxLength: 64pattern: ^[A-Za-z0-9_-]+$ |
| admin | boolean | |
| disabled | boolean | |
| tokens_valid_after | number | minimum: 0 |
| username | string | minLength: 3maxLength: 32pattern: ^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$ |
| first_name | string | minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$ |
| middle_name | string | minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$ |
| last_name | string | minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$ |
| display_name | string | minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$ |
| service_account_app_id | string | minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
JSONExample
"success"true
"message""string"
"data"
"users"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/admin/users/list' \
-b 'refresh_token_<auth_server_app_id>=<value>'