Skip to main content
GET
/
manage
/
users
/
accepted
List Accepted Users
curl --request GET \
  --url https://cloud.onyx.app/api/manage/users/accepted \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "role": "limited",
      "is_active": true,
      "password_configured": true
    }
  ],
  "total_items": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.onyx.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Query Parameters

​
q
string | null
​
page_num
integer
default:0
Required range: x >= 0
​
page_size
integer
default:10
Required range: 1 <= x <= 1000
​
roles
enum<string>[]

User roles

  • Basic can't perform any admin actions
  • Admin can perform all admin actions
  • Curator can perform admin actions for groups they are curators of
  • Global Curator can perform admin actions for all groups they are a member of
  • Limited can access a limited set of basic api endpoints
  • Slack are users that have used onyx via slack but dont have a web login
  • External permissioned users that have been picked up during the external permissions sync process but don't have a web login
Available options:
limited,
basic,
admin,
curator,
global_curator,
slack_user,
ext_perm_user
​
is_active
boolean | null

Response

Successful Response

​
items
FullUserSnapshot · object[]
required
​
total_items
integer
required