---
title: "Authenticate against the server."
method: POST
path: "/v1/authenticate"
tags: ["Satori"]
---

# Authenticate against the server.

`POST /v1/authenticate`

## Request

- Base URL: `http://127.0.0.1:7450`
- URL: `http://127.0.0.1:7450/v1/authenticate`
- Auth: HTTP basic

## Request body

- ApiAuthenticateRequest
  - `id` string: Identity ID. Must be between eight and 128 characters (inclusive). Must be an alphanumeric string with only underscores and hyphens allowed.
  - `default` object: Optional default properties to update with this call. If not set, properties are left as they are on the server.
  - `custom` object: Optional custom properties to update with this call. If not set, properties are left as they are on the server.
  - `no_session` boolean: Optional no_session modifies the request to only create/update an identity without creating a new session. If set to 'true' the response won't include a token and a refresh token.

## Response `200`

A successful response.

- ApiSession: A session.
  - `token` string: Token credential.
  - `refresh_token` string: Refresh token.
  - `properties` ApiProperties: Properties associated with an identity.
    - `default` object: Event default properties.
    - `computed` object: Event computed properties.
    - `custom` object: Event custom properties.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/satori-server-api.md) - [All operations](https://skmtc.dev/heroiclabs/apis/satori-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/satori-server-api/revisions/8a698f59ecda?raw)