> 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/panel-api/resources/account.md).

# Account

## API actions

API path: `panel/account`.

***

## Authenticate dealer

> Authenticate a dealer into the Admin Panel and obtain a session hash. This is the only Admin Panel operation that requires no existing session and no permissions. The returned hash is the credential for every other operation, and the response also reports the full permission set granted to the session, so a client can discover what it is allowed to do without a second call.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Account","description":"Operations for authenticating a dealer into the Admin Panel, inspecting the permissions granted to the current session, and ending that session. All resources under the /panel/account/ 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":[],"paths":{"/panel/account/auth":{"post":{"tags":["Account"],"summary":"Authenticate dealer","description":"Authenticate a dealer into the Admin Panel and obtain a session hash. This is the only Admin Panel operation that requires no existing session and no permissions. The returned hash is the credential for every other operation, and the response also reports the full permission set granted to the session, so a client can discover what it is allowed to do without a second call.","operationId":"accountAuth","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["login","password"],"properties":{"login":{"type":"string","description":"The panel login. Numeric in Navixy-hosted installations."},"password":{"type":"string","description":"The panel password.","format":"password"}}}}}},"responses":{"200":{"description":"Session created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"hash":{"type":"string","description":"The session key. Pass it in the `Authorization` header as `NVX <hash>` on all subsequent requests.","readOnly":true},"permissions":{"$ref":"#/components/schemas/PanelPermissions"}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Access denied, error code 11: the dealer is blocked","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}},"components":{"schemas":{"PanelPermissions":{"type":"object","description":"Permissions granted to a panel session, grouped by category. Each value lists the actions permitted in that category. Which categories appear depends on the features enabled for the dealer, so a category can be absent rather than empty. Treat an absent category as granting nothing.","readOnly":true,"properties":{"base":{"type":"array","description":"Base panel permissions.","items":{"type":"string"}},"service_settings":{"type":"array","description":"Permissions on service settings.","items":{"type":"string"}},"notification_settings":{"type":"array","description":"Permissions on notification settings.","items":{"type":"string"}},"trackers":{"type":"array","description":"Permissions on trackers.","items":{"type":"string"}},"users":{"type":"array","description":"Permissions on end users.","items":{"type":"string"}},"user_sessions":{"type":"array","description":"Permissions on end user sessions.","items":{"type":"string"}},"tariffs":{"type":"array","description":"Permissions on plans.","items":{"type":"string"}},"transactions":{"type":"array","description":"Permissions on billing transactions.","items":{"type":"string"}},"activation_code":{"type":"array","description":"Permissions on activation codes.","items":{"type":"string"}},"password":{"type":"array","description":"Permissions on the dealer password.","items":{"type":"string"}},"email_gateways":{"type":"array","description":"Permissions on email gateways.","items":{"type":"string"}},"subpaas":{"type":"array","description":"Permissions on sub-dealers. Present only when sub-dealer functionality is enabled for the dealer.","items":{"type":"string"}},"paas_payments":{"type":"array","description":"Permissions on PaaS payments.","items":{"type":"string"}},"paas_tariff":{"type":"array","description":"Permissions on the dealer's own PaaS plan.","items":{"type":"string"}}}}},"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 a 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.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}}}
```

The `permissions` object in the response is described under panel account [permissions](/docs/navixy-api/panel-api/getting-started.md#admin-panel-api-permissions).

#### Errors

* 11 - Access denied - if dealer blocked.
* 12 - Dealer not found.

***

*required permissions*: none beyond a valid session.

## Get account permissions

> Return the permission set granted to the current panel session. Takes no parameters beyond the session credential. Use it to re-check permissions without re-authenticating, for example after a dealer's permissions have been changed by the platform owner.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Account","description":"Operations for authenticating a dealer into the Admin Panel, inspecting the permissions granted to the current session, and ending that session. All resources under the /panel/account/ 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":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","name":"Authorization","in":"header"}},"schemas":{"PanelPermissions":{"type":"object","description":"Permissions granted to a panel session, grouped by category. Each value lists the actions permitted in that category. Which categories appear depends on the features enabled for the dealer, so a category can be absent rather than empty. Treat an absent category as granting nothing.","readOnly":true,"properties":{"base":{"type":"array","description":"Base panel permissions.","items":{"type":"string"}},"service_settings":{"type":"array","description":"Permissions on service settings.","items":{"type":"string"}},"notification_settings":{"type":"array","description":"Permissions on notification settings.","items":{"type":"string"}},"trackers":{"type":"array","description":"Permissions on trackers.","items":{"type":"string"}},"users":{"type":"array","description":"Permissions on end users.","items":{"type":"string"}},"user_sessions":{"type":"array","description":"Permissions on end user sessions.","items":{"type":"string"}},"tariffs":{"type":"array","description":"Permissions on plans.","items":{"type":"string"}},"transactions":{"type":"array","description":"Permissions on billing transactions.","items":{"type":"string"}},"activation_code":{"type":"array","description":"Permissions on activation codes.","items":{"type":"string"}},"password":{"type":"array","description":"Permissions on the dealer password.","items":{"type":"string"}},"email_gateways":{"type":"array","description":"Permissions on email gateways.","items":{"type":"string"}},"subpaas":{"type":"array","description":"Permissions on sub-dealers. Present only when sub-dealer functionality is enabled for the dealer.","items":{"type":"string"}},"paas_payments":{"type":"array","description":"Permissions on PaaS payments.","items":{"type":"string"}},"paas_tariff":{"type":"array","description":"Permissions on the dealer's own PaaS plan.","items":{"type":"string"}}}}},"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 a 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.","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":{"/panel/account/get_permissions":{"post":{"tags":["Account"],"summary":"Get account permissions","description":"Return the permission set granted to the current panel session. Takes no parameters beyond the session credential. Use it to re-check permissions without re-authenticating, for example after a dealer's permissions have been changed by the platform owner.","operationId":"accountGetPermissions","responses":{"200":{"description":"Permissions of the current session","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"permissions":{"$ref":"#/components/schemas/PanelPermissions"}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

[General](/docs/navixy-api/user-api/backend-api/errors.md#error-codes) types only.

***

*required permissions*: none beyond a valid session.

## Log out

> End the current panel session. The session hash is invalidated immediately and cannot be reused: any subsequent request with it, including another logout, fails with error code 4. Takes no parameters beyond the session credential.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Account","description":"Operations for authenticating a dealer into the Admin Panel, inspecting the permissions granted to the current session, and ending that session. All resources under the /panel/account/ 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":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","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 a 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.","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":{"/panel/account/logout":{"post":{"tags":["Account"],"summary":"Log out","description":"End the current panel session. The session hash is invalidated immediately and cannot be reused: any subsequent request with it, including another logout, fails with error code 4. Takes no parameters beyond the session credential.","operationId":"accountLogout","responses":{"200":{"$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.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

[General](/docs/navixy-api/user-api/backend-api/errors.md#error-codes) types only.


---

# 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/panel-api/resources/account.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.