OperationPanel
DomainTabbed panel showing all details of an API operation — parameters, request body, responses, and code samples.
Returns a paginated list of users. Requires admin role.
UsersBearerAuth
Path
| Name | In | Type | Required | Description |
|---|---|---|---|---|
userId | path | string (uuid) | required | Unique identifier of the user |
Query
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | optional | Page number (1-based) |
pageSize | query | integer | optional | Results per page |
roledeprecated | query | string | optional | Filter by role admineditorviewer |
Headers
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Authorization | header | string | required | Bearer token |
No request body.
application/json
object
dataarray[object]
totalintegerTotal items
pageinteger
pageSizeinteger
curl -X GET 'https://api.example.com/v1/users?page=1&pageSize=20' \
-H 'Authorization: Bearer <token>' \
-H 'Accept: application/json'<OperationPanel operation={{
method: 'GET',
summary: 'List users',
parameters: [...],
responses: [...],
codeSamples: [...],
}} />Creates a new user account.
Users
Headers
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Authorization | header | string | required | Bearer token |
required
New user payload
application/json
objectA user account object
id*string(uuid)Unique identifier
email*string(email)Email address
name*string
minLength: 1maxLength: 100
roleenumUser role
"admin""editor""viewer"createdAtstring(date-time)
activebooleandefault:
trueapplication/json
objectA user account object
id*string(uuid)Unique identifier
email*string(email)Email address
name*string
minLength: 1maxLength: 100
roleenumUser role
"admin""editor""viewer"createdAtstring(date-time)
activebooleandefault:
truecurl -X POST 'https://api.example.com/v1/users' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"email":"jane@example.com","name":"Jane Doe","role":"editor"}'<OperationPanel operation={{
method: 'POST',
summary: 'Create user',
requestBody: { required: true, content: { 'application/json': { schema: userSchema } } },
responses: [...],
}} />