> For the complete documentation index, see [llms.txt](https://www.center.daxium-air.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.center.daxium-air.com/api-reference/users.md).
# Users
## List all users
> Returns all users of the account. This endpoint is not prefixed by \`{app\_short}\`.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"UserListResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"server_time":{"type":"integer","format":"int64"}}},"User":{"type":"object","description":"User (object returned by GET APIs)","properties":{"id":{"type":"integer","description":"Unique system-generated identifier"},"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"subscription_id":{"type":"string","description":"UUID of the attached subscription"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Identifiers of the user's groups","items":{"type":"integer"}},"settings":{"type":"object","description":"User settings (e.g. locale)","additionalProperties":true}}}}},"paths":{"/users":{"get":{"summary":"List all users","description":"Returns all users of the account. This endpoint is not prefixed by `{app_short}`.","tags":["users"],"operationId":"listAllUsers","responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResponse"}}}}}}}}}
```
## Get the current user
> Returns the authenticated user and the associated company account.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"CurrentUserResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"company":{"$ref":"#/components/schemas/Company"}}},"User":{"type":"object","description":"User (object returned by GET APIs)","properties":{"id":{"type":"integer","description":"Unique system-generated identifier"},"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"subscription_id":{"type":"string","description":"UUID of the attached subscription"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Identifiers of the user's groups","items":{"type":"integer"}},"settings":{"type":"object","description":"User settings (e.g. locale)","additionalProperties":true}}},"Company":{"type":"object","description":"Company account of the current user","properties":{"created_at":{"type":"integer","format":"int64","description":"Creation date (UNIX timestamp)"},"updated_at":{"type":"integer","format":"int64","description":"Last update date (UNIX timestamp)"},"id":{"type":"integer","description":"Identifier"},"title":{"type":"string","description":"Displayed name"}}}}},"paths":{"/users/me":{"get":{"summary":"Get the current user","description":"Returns the authenticated user and the associated company account.","tags":["users"],"operationId":"getCurrentUser","responses":{"200":{"description":"Current user and company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentUserResponse"}}}}}}}}}
```
## Send a push key
> Registers a push notification key for one of the user's devices.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"PushKeyInput":{"type":"object","description":"Push notification key for a device","properties":{"id":{"type":"string","description":"Unique device identifier"},"key":{"type":"string","description":"Push key"},"os":{"type":"string","description":"Device OS (Android or iOS)"},"os_version":{"type":"string","description":"OS version"},"app_version":{"type":"string","description":"Daxium-Air version"},"name":{"type":"string","description":"Device name"}}}}},"paths":{"/users/pushkey":{"post":{"summary":"Send a push key","description":"Registers a push notification key for one of the user's devices.","tags":["users"],"operationId":"sendPushKey","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushKeyInput"}}}},"responses":{"200":{"description":"Push key registered","content":{"application/json":{"schema":{"type":"object"}}}}}}}}}
```
## List workspace users (or look up by email)
> Returns the workspace users. If the \`username\` parameter is provided,\
> returns the single user matching that email.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"UserListResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"server_time":{"type":"integer","format":"int64"}}},"User":{"type":"object","description":"User (object returned by GET APIs)","properties":{"id":{"type":"integer","description":"Unique system-generated identifier"},"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"subscription_id":{"type":"string","description":"UUID of the attached subscription"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Identifiers of the user's groups","items":{"type":"integer"}},"settings":{"type":"object","description":"User settings (e.g. locale)","additionalProperties":true}}}}},"paths":{"/{app_short}/users":{"get":{"summary":"List workspace users (or look up by email)","description":"Returns the workspace users. If the `username` parameter is provided,\nreturns the single user matching that email.\n","tags":["users"],"operationId":"listAppUsers","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"username","in":"query","description":"Email address to retrieve a specific user","schema":{"type":"string","format":"email"}}],"responses":{"200":{"description":"List of users, or a single user when `username` is provided","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserListResponse"},{"$ref":"#/components/schemas/User"}]}}}}}}}}}
```
## Create a user
> Creates a user. Provide \`plainPassword\` for Daxium authentication, or \`ssoProvider\`\
> for authentication via the company's SSO provider.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"UserInput":{"type":"object","required":["username","system_groups"],"description":"Body for creating or updating a user. Provide `plainPassword` for Daxium\nauthentication, or `ssoProvider` for SSO authentication.\n","properties":{"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"locale":{"type":"string","enum":["en","fr"],"description":"User language"},"subscription_id":{"type":"string","description":"Subscription UUID (see the `/subscriptions` API)"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Group identifiers (see the `/{app_short}/groups` API)","items":{"type":"integer"}},"plainPassword":{"type":"object","description":"Password. The `first` and `second` keys are mandatory and must be identical.\nRules: at least 1 uppercase, 1 lowercase, 1 digit, 8 characters total.\n","properties":{"first":{"type":"string","format":"password"},"second":{"type":"string","format":"password"}}},"force_login_password":{"type":"integer","enum":[0,1],"description":"[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication"},"ssoProvider":{"type":"integer","nullable":true,"description":"[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)"}}},"User":{"type":"object","description":"User (object returned by GET APIs)","properties":{"id":{"type":"integer","description":"Unique system-generated identifier"},"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"subscription_id":{"type":"string","description":"UUID of the attached subscription"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Identifiers of the user's groups","items":{"type":"integer"}},"settings":{"type":"object","description":"User settings (e.g. locale)","additionalProperties":true}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Unique error code prefixed with `DAERR-`"},"message":{"type":"string"},"url":{"type":"string","format":"uri","description":"Link to the detailed error documentation"},"api_version":{"type":"string"},"infos":{"type":"array","items":{},"description":"Additional context (may be empty)"},"server_time":{"type":"string","description":"Unix timestamp as string"}}}}},"paths":{"/{app_short}/users":{"post":{"summary":"Create a user","description":"Creates a user. Provide `plainPassword` for Daxium authentication, or `ssoProvider`\nfor authentication via the company's SSO provider.\n","tags":["users"],"operationId":"createUser","parameters":[{"$ref":"#/components/parameters/AppShort"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInput"}}}},"responses":{"200":{"description":"User created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Invalid data (password, ssoProvider, groups or subscription invalid)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The email (username) already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Create multiple users (async)
> Creates up to 100 users asynchronously. Poll the returned \`callbackUrl\`.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"UserInput":{"type":"object","required":["username","system_groups"],"description":"Body for creating or updating a user. Provide `plainPassword` for Daxium\nauthentication, or `ssoProvider` for SSO authentication.\n","properties":{"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"locale":{"type":"string","enum":["en","fr"],"description":"User language"},"subscription_id":{"type":"string","description":"Subscription UUID (see the `/subscriptions` API)"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Group identifiers (see the `/{app_short}/groups` API)","items":{"type":"integer"}},"plainPassword":{"type":"object","description":"Password. The `first` and `second` keys are mandatory and must be identical.\nRules: at least 1 uppercase, 1 lowercase, 1 digit, 8 characters total.\n","properties":{"first":{"type":"string","format":"password"},"second":{"type":"string","format":"password"}}},"force_login_password":{"type":"integer","enum":[0,1],"description":"[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication"},"ssoProvider":{"type":"integer","nullable":true,"description":"[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)"}}},"CallbackUrlResponse":{"type":"object","properties":{"callbackUrl":{"type":"string","description":"URL to poll for async job status"}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Unique error code prefixed with `DAERR-`"},"message":{"type":"string"},"url":{"type":"string","format":"uri","description":"Link to the detailed error documentation"},"api_version":{"type":"string"},"infos":{"type":"array","items":{},"description":"Additional context (may be empty)"},"server_time":{"type":"string","description":"Unix timestamp as string"}}}}},"paths":{"/{app_short}/users/multiple":{"post":{"summary":"Create multiple users (async)","description":"Creates up to 100 users asynchronously. Poll the returned `callbackUrl`.","tags":["users"],"operationId":"createMultipleUsers","parameters":[{"$ref":"#/components/parameters/AppShort"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/UserInput"}}}}},"responses":{"200":{"description":"Async job accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackUrlResponse"}}}},"400":{"description":"Empty payload or more than 100 users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Update multiple users (async)
> Updates up to 100 users asynchronously. Poll the returned \`callbackUrl\`.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"UserInput":{"type":"object","required":["username","system_groups"],"description":"Body for creating or updating a user. Provide `plainPassword` for Daxium\nauthentication, or `ssoProvider` for SSO authentication.\n","properties":{"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"locale":{"type":"string","enum":["en","fr"],"description":"User language"},"subscription_id":{"type":"string","description":"Subscription UUID (see the `/subscriptions` API)"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Group identifiers (see the `/{app_short}/groups` API)","items":{"type":"integer"}},"plainPassword":{"type":"object","description":"Password. The `first` and `second` keys are mandatory and must be identical.\nRules: at least 1 uppercase, 1 lowercase, 1 digit, 8 characters total.\n","properties":{"first":{"type":"string","format":"password"},"second":{"type":"string","format":"password"}}},"force_login_password":{"type":"integer","enum":[0,1],"description":"[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication"},"ssoProvider":{"type":"integer","nullable":true,"description":"[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)"}}},"CallbackUrlResponse":{"type":"object","properties":{"callbackUrl":{"type":"string","description":"URL to poll for async job status"}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Unique error code prefixed with `DAERR-`"},"message":{"type":"string"},"url":{"type":"string","format":"uri","description":"Link to the detailed error documentation"},"api_version":{"type":"string"},"infos":{"type":"array","items":{},"description":"Additional context (may be empty)"},"server_time":{"type":"string","description":"Unix timestamp as string"}}}}},"paths":{"/{app_short}/users/multiple":{"put":{"summary":"Update multiple users (async)","description":"Updates up to 100 users asynchronously. Poll the returned `callbackUrl`.","tags":["users"],"operationId":"updateMultipleUsers","parameters":[{"$ref":"#/components/parameters/AppShort"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/UserInput"}}}}},"responses":{"200":{"description":"Async job accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackUrlResponse"}}}},"400":{"description":"Empty payload or more than 100 users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## GET /{app\_short}/users/multiple/callback/{callback\_id}
> Poll async user job status
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"UsersCallbackResponse":{"type":"object","properties":{"callbackDetails":{"type":"object","properties":{"status":{"type":"string","enum":["Planned","Running","Finished","Finished with errors","Failed","In timeout"],"description":"Current job status"},"nbRecordsTodo":{"type":"integer","description":"Number of users to process"},"nbRecordsDone":{"type":"integer","description":"Number of users already processed"},"nbSuccess":{"type":"integer","description":"Number of users processed successfully"},"nbErrors":{"type":"integer","description":"Number of users that failed"},"success":{"type":"array","description":"Users created/updated successfully. Format: {\"\": {\"id\": }}","items":{"type":"object","additionalProperties":true}},"errors":{"type":"array","description":"Errors per user. Format: {\"\": {\"\": [\"\"]}}","items":{"type":"object","additionalProperties":true}}}}}}}},"paths":{"/{app_short}/users/multiple/callback/{callback_id}":{"get":{"summary":"Poll async user job status","tags":["users"],"operationId":"getMultipleUsersCallback","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"callback_id","in":"path","required":true,"description":"Callback identifier (UUID)","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Status and per-user results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersCallbackResponse"}}}}}}}}}
```
## GET /{app\_short}/users/{user\_id}
> Get a user by identifier
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"User":{"type":"object","description":"User (object returned by GET APIs)","properties":{"id":{"type":"integer","description":"Unique system-generated identifier"},"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"subscription_id":{"type":"string","description":"UUID of the attached subscription"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Identifiers of the user's groups","items":{"type":"integer"}},"settings":{"type":"object","description":"User settings (e.g. locale)","additionalProperties":true}}}}},"paths":{"/{app_short}/users/{user_id}":{"get":{"summary":"Get a user by identifier","tags":["users"],"operationId":"getUser","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"user_id","in":"path","required":true,"description":"User identifier","schema":{"type":"integer"}}],"responses":{"200":{"description":"User object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}}}}}}
```
## PATCH /{app\_short}/users/{user\_id}
> Update a user
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"users"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Short name of the workspace instance (e.g. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"UserInput":{"type":"object","required":["username","system_groups"],"description":"Body for creating or updating a user. Provide `plainPassword` for Daxium\nauthentication, or `ssoProvider` for SSO authentication.\n","properties":{"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"locale":{"type":"string","enum":["en","fr"],"description":"User language"},"subscription_id":{"type":"string","description":"Subscription UUID (see the `/subscriptions` API)"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Group identifiers (see the `/{app_short}/groups` API)","items":{"type":"integer"}},"plainPassword":{"type":"object","description":"Password. The `first` and `second` keys are mandatory and must be identical.\nRules: at least 1 uppercase, 1 lowercase, 1 digit, 8 characters total.\n","properties":{"first":{"type":"string","format":"password"},"second":{"type":"string","format":"password"}}},"force_login_password":{"type":"integer","enum":[0,1],"description":"[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication"},"ssoProvider":{"type":"integer","nullable":true,"description":"[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)"}}},"User":{"type":"object","description":"User (object returned by GET APIs)","properties":{"id":{"type":"integer","description":"Unique system-generated identifier"},"username":{"type":"string","format":"email","description":"Email address (login), must be unique"},"active":{"type":"boolean","description":"Status (active / inactive)"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"subscription_id":{"type":"string","description":"UUID of the attached subscription"},"system_groups":{"type":"array","description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","items":{"type":"integer"}},"groups":{"type":"array","description":"Identifiers of the user's groups","items":{"type":"integer"}},"settings":{"type":"object","description":"User settings (e.g. locale)","additionalProperties":true}}}}},"paths":{"/{app_short}/users/{user_id}":{"patch":{"summary":"Update a user","tags":["users"],"operationId":"updateUser","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"user_id","in":"path","required":true,"description":"User identifier","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInput"}}}},"responses":{"200":{"description":"User updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://www.center.daxium-air.com/api-reference/users.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.