> For the complete documentation index, see [llms.txt](https://docs.spurtcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spurtcommerce.com/spurtapi/spurtcommerce-core-api/admin-api/authentication.md).

# Authentication&#x20;

## User Authentication

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/login" method="post" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/userlist" method="get" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/create-user" method="post" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/update-user/{id}" method="put" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/delete-user/{id}" method="delete" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/forgot-password" method="post" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/change-password" method="put" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/edit-profile" method="post" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/logout" method="post" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/forgot-password-link" method="post" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/forgot-password-key-check" method="get" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/reset-password" method="put" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/get-profile" method="get" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

{% openapi src="/files/MHo836TQKC0hKUDkgiFZ" path="/auth/get-sitemap" method="get" %}
[Admin-User1.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2FZEMuPHXViDB3Kgpl7Srt%2FAdmin-User1.json?alt=media\&token=f22ef9a6-9987-4428-9ecd-0f09b7a9db9d)
{% endopenapi %}

## Permission Authentication

{% openapi src="/files/L2pbkOCZB8tJ1WFsdYrd" path="/permission-module/list" method="get" %}
[Admin-Permission.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2Fig9VeB7niqnSh3iefGKu%2FAdmin-Permission.json?alt=media\&token=4759ca88-c4be-4a6d-98db-50ca6cff3ccc)
{% endopenapi %}

{% openapi src="/files/L2pbkOCZB8tJ1WFsdYrd" path="/permission-module/add-permission" method="post" %}
[Admin-Permission.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2Fig9VeB7niqnSh3iefGKu%2FAdmin-Permission.json?alt=media\&token=4759ca88-c4be-4a6d-98db-50ca6cff3ccc)
{% endopenapi %}

{% openapi src="/files/L2pbkOCZB8tJ1WFsdYrd" path="/permission-module/get-permission" method="get" %}
[Admin-Permission.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2Fig9VeB7niqnSh3iefGKu%2FAdmin-Permission.json?alt=media\&token=4759ca88-c4be-4a6d-98db-50ca6cff3ccc)
{% endopenapi %}

{% openapi src="/files/L2pbkOCZB8tJ1WFsdYrd" path="/permission-module/permission-me" method="get" %}
[Admin-Permission.json](https://864699184-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN8Jn3MrTEB2EkQ85HLW9%2Fuploads%2Fig9VeB7niqnSh3iefGKu%2FAdmin-Permission.json?alt=media\&token=4759ca88-c4be-4a6d-98db-50ca6cff3ccc)
{% endopenapi %}

## Create a new user

<mark style="color:green;">`POST`</mark> `/users`

\<Description of the endpoint>

**Headers**

| Name          | Value              |
| ------------- | ------------------ |
| Content-Type  | `application/json` |
| Authorization | `Bearer <token>`   |

**Body**

| Name   | Type   | Description      |
| ------ | ------ | ---------------- |
| `name` | string | Name of the user |
| `age`  | number | Age of the user  |

**Response**

{% tabs %}
{% tab title="200" %}

```json
{
  "id": 1,
  "name": "John",
  "age": 30
}
```

{% endtab %}

{% tab title="400" %}

```json
{
  "error": "Invalid request"
}
```

{% endtab %}
{% endtabs %}