> 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/session.md).

# Sub-user session

Open a session as one of your sub-users, without knowing their password.

This operation opens a session as one of the master account's [sub-users](/docs/navixy-api/user-api/resources/commons/subuser.md) and returns its hash. It is how a master user acts on a sub-user's behalf, for support or for an integration that needs a sub-user's restricted view, without knowing their password.

The hash that comes back is used exactly like one from [`user/auth`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-auth), and carries that sub-user's rights and scoping.

## API actions

API base path: `/subuser/session`.

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.

***

## Create sub-user session

> Open a session as one of your sub-users, and return its hash. This is how a master user works on a sub-user's behalf without knowing their password.\
> \
> The returned hash is used exactly like one from \`user/auth\`, and carries that sub-user's rights and scoping.\
> \
> \*\*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":{"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/session/create":{"post":{"tags":["Sub-users"],"summary":"Create sub-user session","description":"Open a session as one of your sub-users, and return its hash. This is how a master user works on a sub-user's behalf without knowing their password.\n\nThe returned hash is used exactly like one from `user/auth`, and carries that sub-user's rights and scoping.\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":"subuserSessionCreate","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":"The new session","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"hash":{"type":"string","description":"Session hash for the sub-user, to send in the `Authorization` header."}}}}}},"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.


---

# 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/session.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.