> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser.md).

# Sub-user

Additional users with their own rights and their own subset of the account's trackers.

A sub-user is an additional login on a master account, with its own rights and its own subset of the account's trackers. It is how a company gives several employees access to one monitoring account without giving them all the same powers.

Two mechanisms limit what a sub-user can do. **Scoping** limits what they can see: a sub-user is bound to a subset of the master account's trackers, and everything associated with a tracker outside that subset is hidden from them too. **Rights**, granted through a [security group](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md), limit what they can change.

{% hint style="info" %}
A sub-user owns nothing exclusively. Every tracker, rule, and task belongs to the master account even when a sub-user created it. The one exception is reporting: each sub-user has its own reports pool and report schedule.
{% endhint %}

## Sub-user object

A sub-user object is almost identical to an ordinary user.

## The Subuser object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"Subuser":{"type":"object","description":"An additional user with access to the master account, scoped to a subset of its trackers and limited by a security group.\n\nAlmost identical to a normal user. A sub-user owns nothing exclusively: every tracker, rule and task it creates belongs to the master account. The one exception is reports, where each sub-user has its own pool and schedule.","properties":{"id":{"type":["integer","null"],"description":"Sub-user ID. May be null when creating."},"activated":{"type":"boolean","description":"`true` when the sub-user is allowed to log in."},"login":{"type":"string","description":"Sub-user email, used as the login. Must be a valid and unique email address."},"first_name":{"type":"string","description":"First name of the sub-user or contact person."},"middle_name":{"type":"string","description":"Middle name of the sub-user or contact person."},"last_name":{"type":"string","description":"Last name of the sub-user or contact person."},"legal_type":{"type":"string","description":"Legal type of the sub-user.","enum":["legal_entity","individual","sole_trader"]},"phone":{"type":"string","description":"Phone number, 10 to 15 digits."},"post_country":{"type":"string","description":"Country part of the postal address."},"post_index":{"type":"string","description":"Index part of the postal address."},"post_region":{"type":"string","description":"Region part of the postal address."},"post_city":{"type":"string","description":"City from the postal address."},"post_street_address":{"type":"string","description":"Street part of the postal address."},"registered_country":{"type":"string","description":"Country part of the registered address."},"registered_index":{"type":"string","description":"Index part of the registered address."},"registered_region":{"type":"string","description":"Region part of the registered address."},"registered_city":{"type":"string","description":"City from the registered address."},"registered_street_address":{"type":"string","description":"Street part of the registered address."},"state_reg_num":{"type":"string","description":"State registration number, such as an EIN in the USA or an OGRN in Russia. Up to 15 characters.","maxLength":15},"tin":{"type":"string","description":"Taxpayer identification number, also called a VATIN or INN."},"legal_name":{"type":"string","description":"Legal name. For `legal_entity` only."},"iec":{"type":"string","description":"Optional. Industrial Enterprises Classifier, also called a KPP. Used in Russia, for `legal_entity` only."},"security_group_id":{"type":["integer","null"],"description":"ID of the security group this sub-user belongs to. **Null means the default group, which has no rights at all.**"},"creation_date":{"type":"string","description":"When the sub-user was created. **Read-only**, and should not be sent on update.","readOnly":true}}}}}}
```

## API actions

API base path: `/subuser`.

Every operation on this page needs the `multilevel_access` tariff feature on **all** trackers, and the `admin` right, which is available only to master users. Failing either returns error 13 for the right and error 236 for the feature, so those two are not repeated per operation below.

***

## List sub-users

> List the sub-users of the current master account.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Callable with an empty body. Also accepts GET.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"Subuser":{"type":"object","description":"An additional user with access to the master account, scoped to a subset of its trackers and limited by a security group.\n\nAlmost identical to a normal user. A sub-user owns nothing exclusively: every tracker, rule and task it creates belongs to the master account. The one exception is reports, where each sub-user has its own pool and schedule.","properties":{"id":{"type":["integer","null"],"description":"Sub-user ID. May be null when creating."},"activated":{"type":"boolean","description":"`true` when the sub-user is allowed to log in."},"login":{"type":"string","description":"Sub-user email, used as the login. Must be a valid and unique email address."},"first_name":{"type":"string","description":"First name of the sub-user or contact person."},"middle_name":{"type":"string","description":"Middle name of the sub-user or contact person."},"last_name":{"type":"string","description":"Last name of the sub-user or contact person."},"legal_type":{"type":"string","description":"Legal type of the sub-user.","enum":["legal_entity","individual","sole_trader"]},"phone":{"type":"string","description":"Phone number, 10 to 15 digits."},"post_country":{"type":"string","description":"Country part of the postal address."},"post_index":{"type":"string","description":"Index part of the postal address."},"post_region":{"type":"string","description":"Region part of the postal address."},"post_city":{"type":"string","description":"City from the postal address."},"post_street_address":{"type":"string","description":"Street part of the postal address."},"registered_country":{"type":"string","description":"Country part of the registered address."},"registered_index":{"type":"string","description":"Index part of the registered address."},"registered_region":{"type":"string","description":"Region part of the registered address."},"registered_city":{"type":"string","description":"City from the registered address."},"registered_street_address":{"type":"string","description":"Street part of the registered address."},"state_reg_num":{"type":"string","description":"State registration number, such as an EIN in the USA or an OGRN in Russia. Up to 15 characters.","maxLength":15},"tin":{"type":"string","description":"Taxpayer identification number, also called a VATIN or INN."},"legal_name":{"type":"string","description":"Legal name. For `legal_entity` only."},"iec":{"type":"string","description":"Optional. Industrial Enterprises Classifier, also called a KPP. Used in Russia, for `legal_entity` only."},"security_group_id":{"type":["integer","null"],"description":"ID of the security group this sub-user belongs to. **Null means the default group, which has no rights at all.**"},"creation_date":{"type":"string","description":"When the sub-user was created. **Read-only**, and should not be sent on update.","readOnly":true}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/list":{"post":{"tags":["Sub-users"],"summary":"List sub-users","description":"List the sub-users of the current master account.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nCallable with an empty body. Also accepts GET.\n\nRequires the `admin` right.","operationId":"subuserList","responses":{"200":{"description":"The sub-users","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"$ref":"#/components/schemas/Subuser"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 13 - The caller is a sub-user.
* 236 - The account lacks the `multilevel_access` feature.

***

## Register sub-user

> Create a sub-user under the current master account, and return its ID.\
> \
> A new sub-user starts with whatever security group is given in \`security\_group\_id\`. Null means the default group, which has \*\*no rights at all\*\*.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"Subuser":{"type":"object","description":"An additional user with access to the master account, scoped to a subset of its trackers and limited by a security group.\n\nAlmost identical to a normal user. A sub-user owns nothing exclusively: every tracker, rule and task it creates belongs to the master account. The one exception is reports, where each sub-user has its own pool and schedule.","properties":{"id":{"type":["integer","null"],"description":"Sub-user ID. May be null when creating."},"activated":{"type":"boolean","description":"`true` when the sub-user is allowed to log in."},"login":{"type":"string","description":"Sub-user email, used as the login. Must be a valid and unique email address."},"first_name":{"type":"string","description":"First name of the sub-user or contact person."},"middle_name":{"type":"string","description":"Middle name of the sub-user or contact person."},"last_name":{"type":"string","description":"Last name of the sub-user or contact person."},"legal_type":{"type":"string","description":"Legal type of the sub-user.","enum":["legal_entity","individual","sole_trader"]},"phone":{"type":"string","description":"Phone number, 10 to 15 digits."},"post_country":{"type":"string","description":"Country part of the postal address."},"post_index":{"type":"string","description":"Index part of the postal address."},"post_region":{"type":"string","description":"Region part of the postal address."},"post_city":{"type":"string","description":"City from the postal address."},"post_street_address":{"type":"string","description":"Street part of the postal address."},"registered_country":{"type":"string","description":"Country part of the registered address."},"registered_index":{"type":"string","description":"Index part of the registered address."},"registered_region":{"type":"string","description":"Region part of the registered address."},"registered_city":{"type":"string","description":"City from the registered address."},"registered_street_address":{"type":"string","description":"Street part of the registered address."},"state_reg_num":{"type":"string","description":"State registration number, such as an EIN in the USA or an OGRN in Russia. Up to 15 characters.","maxLength":15},"tin":{"type":"string","description":"Taxpayer identification number, also called a VATIN or INN."},"legal_name":{"type":"string","description":"Legal name. For `legal_entity` only."},"iec":{"type":"string","description":"Optional. Industrial Enterprises Classifier, also called a KPP. Used in Russia, for `legal_entity` only."},"security_group_id":{"type":["integer","null"],"description":"ID of the security group this sub-user belongs to. **Null means the default group, which has no rights at all.**"},"creation_date":{"type":"string","description":"When the sub-user was created. **Read-only**, and should not be sent on update.","readOnly":true}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/register":{"post":{"tags":["Sub-users"],"summary":"Register sub-user","description":"Create a sub-user under the current master account, and return its ID.\n\nA new sub-user starts with whatever security group is given in `security_group_id`. Null means the default group, which has **no rights at all**.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nRequires the `admin` right.","operationId":"subuserRegister","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"allOf":[{"$ref":"#/components/schemas/Subuser"}],"description":"The sub-user to create, without the `id` field."},"password":{"type":"string","description":"Password for the new sub-user. Must hold at least one uppercase letter, one lowercase letter, one digit and one special character. The length limits and the accepted special characters are installation config, not platform constants, so read them from `paas_settings.password_policy` in `user/get_info` instead of assuming: the hosted platform asks for 12 to 20 characters. A password that fails the policy returns error 7 naming `password`."}},"required":["user","password"]}}}},"responses":{"200":{"description":"The created sub-user","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"id":{"type":"integer","description":"ID of the new sub-user."}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"409":{"description":"Error 206: the login is already in use.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 201 - Not found in the database, when the given `security_group_id` does not exist.
* 206 - Login already in use.

***

## Update sub-user

> Update a sub-user. Pass a full sub-user object including its \`id\`.\
> \
> \`creation\_date\` is read-only and should not be sent.\
> \
> The password is not changed here.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"Subuser":{"type":"object","description":"An additional user with access to the master account, scoped to a subset of its trackers and limited by a security group.\n\nAlmost identical to a normal user. A sub-user owns nothing exclusively: every tracker, rule and task it creates belongs to the master account. The one exception is reports, where each sub-user has its own pool and schedule.","properties":{"id":{"type":["integer","null"],"description":"Sub-user ID. May be null when creating."},"activated":{"type":"boolean","description":"`true` when the sub-user is allowed to log in."},"login":{"type":"string","description":"Sub-user email, used as the login. Must be a valid and unique email address."},"first_name":{"type":"string","description":"First name of the sub-user or contact person."},"middle_name":{"type":"string","description":"Middle name of the sub-user or contact person."},"last_name":{"type":"string","description":"Last name of the sub-user or contact person."},"legal_type":{"type":"string","description":"Legal type of the sub-user.","enum":["legal_entity","individual","sole_trader"]},"phone":{"type":"string","description":"Phone number, 10 to 15 digits."},"post_country":{"type":"string","description":"Country part of the postal address."},"post_index":{"type":"string","description":"Index part of the postal address."},"post_region":{"type":"string","description":"Region part of the postal address."},"post_city":{"type":"string","description":"City from the postal address."},"post_street_address":{"type":"string","description":"Street part of the postal address."},"registered_country":{"type":"string","description":"Country part of the registered address."},"registered_index":{"type":"string","description":"Index part of the registered address."},"registered_region":{"type":"string","description":"Region part of the registered address."},"registered_city":{"type":"string","description":"City from the registered address."},"registered_street_address":{"type":"string","description":"Street part of the registered address."},"state_reg_num":{"type":"string","description":"State registration number, such as an EIN in the USA or an OGRN in Russia. Up to 15 characters.","maxLength":15},"tin":{"type":"string","description":"Taxpayer identification number, also called a VATIN or INN."},"legal_name":{"type":"string","description":"Legal name. For `legal_entity` only."},"iec":{"type":"string","description":"Optional. Industrial Enterprises Classifier, also called a KPP. Used in Russia, for `legal_entity` only."},"security_group_id":{"type":["integer","null"],"description":"ID of the security group this sub-user belongs to. **Null means the default group, which has no rights at all.**"},"creation_date":{"type":"string","description":"When the sub-user was created. **Read-only**, and should not be sent on update.","readOnly":true}}}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/update":{"post":{"tags":["Sub-users"],"summary":"Update sub-user","description":"Update a sub-user. Pass a full sub-user object including its `id`.\n\n`creation_date` is read-only and should not be sent.\n\nThe password is not changed here.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nRequires the `admin` right.","operationId":"subuserUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"allOf":[{"$ref":"#/components/schemas/Subuser"}],"description":"The sub-user to update, including its `id`."}},"required":["user"]}}}},"responses":{"200":{"description":"Sub-user updated","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 201 - Not found in the database, when no sub-user has the given ID or it belongs to another master user. Also when the given `security_group_id` does not exist.

***

## Delete sub-user

> Delete a sub-user. \*\*This cannot be reversed.\*\*\
> \
> Entities the sub-user created stay with the master account, since a sub-user owns nothing exclusively. The exception is reports: each sub-user has its own report pool and schedule.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Also accepts GET with the same parameters as query-string values.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/delete":{"post":{"tags":["Sub-users"],"summary":"Delete sub-user","description":"Delete a sub-user. **This cannot be reversed.**\n\nEntities the sub-user created stay with the master account, since a sub-user owns nothing exclusively. The exception is reports: each sub-user has its own report pool and schedule.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nAlso accepts GET with the same parameters as query-string values.\n\nRequires the `admin` right.","operationId":"subuserDelete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"ID of a sub-user belonging to the current account.","minimum":1}},"required":["subuser_id"]}}}},"responses":{"200":{"description":"Sub-user deleted","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 201 - Not found in the database, when no sub-user has the given ID or it belongs to another master user.

## More in this section

#### Sub-user places

| Endpoint                                                                                                                 | Method | What it does                |
| ------------------------------------------------------------------------------------------------------------------------ | ------ | --------------------------- |
| [`/subuser/places/bind`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-bind)         | POST   | Bind places to sub-user     |
| [`/subuser/places/unbind`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-unbind)     | POST   | Unbind places from sub-user |
| [`/subuser/places/list_ids`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-list_ids) | POST   | List sub-user place IDs     |
| [`/subuser/places/list`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-list)         | POST   | List sub-user places        |

#### Sub-user security group

| Endpoint                                                                                                                                     | Method | What it does          |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------- |
| [`/subuser/security_group/create`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-create) | POST   | Create security group |
| [`/subuser/security_group/delete`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-delete) | POST   | Delete security group |
| [`/subuser/security_group/list`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-list)     | POST   | List security groups  |
| [`/subuser/security_group/update`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-update) | POST   | Update security group |
| [`/subuser/security_group/assign`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-assign) | POST   | Assign security group |

#### Sub-user session

| Endpoint                                                                                                                | Method | What it does            |
| ----------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------- |
| [`/subuser/session/create`](/docs/navixy-api/user-api/resources/commons/subuser/session.md#post-subuser-session-create) | POST   | Create sub-user session |

#### Sub-user trackers

| Endpoint                                                                                                                | Method | What it does                  |
| ----------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------- |
| [`/subuser/tracker/bind`](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md#post-subuser-tracker-bind)     | POST   | Bind trackers to sub-user     |
| [`/subuser/tracker/unbind`](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md#post-subuser-tracker-unbind) | POST   | Unbind trackers from sub-user |
| [`/subuser/tracker/list`](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md#post-subuser-tracker-list)     | POST   | List sub-user trackers        |

#### Sub-user geofences

| Endpoint                                                                                                              | Method | What it does                   |
| --------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------ |
| [`/subuser/zones/bind`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-bind)         | POST   | Bind geofences to sub-user     |
| [`/subuser/zones/unbind`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-unbind)     | POST   | Unbind geofences from sub-user |
| [`/subuser/zones/list_ids`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-list_ids) | POST   | List sub-user geofence IDs     |
| [`/subuser/zones/list`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-list)         | POST   | List sub-user geofences        |


---

# 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://navixy.com/docs/navixy-api/user-api/resources/commons/subuser.md?ask=<question>&goal=<endgoal>
```

`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.