---
title: "Authenticate a user"
method: POST
path: "/auth/sign-in"
tags: ["Authentication"]
---

# Authenticate a user

`POST /auth/sign-in`

## Request

- Base URL: `https://api-staging.fanheroapi.com`
- URL: `https://api-staging.fanheroapi.com/auth/sign-in`
- Auth: none declared. Required headers: `organization`

Get an authentication token

## Headers

- `organization` string, required

## Request body

- SignInInput
  - `email` string, required: The email address associated with the account
  - `password` string, required: Password

## Response `201`

Successful resopnse

- ResponseSignInOutput
  - `token` ResponseTokenOutput, required
    - `accessToken` string, required
    - `firebaseToken` string, required
  - `account` ResponseAccountOutput, required
    - `id` string: Account ID
    - `display_name` string: Display Name
    - `username` string: Username
    - `first_name` string: First Name
    - `last_name` string: Last name
    - `email` string: Contact email address
    - `status` ResponseAccountStatusOutput
      - `active` boolean, nullable, required: The account is active.
      - `block_temp` string, date-time, nullable, required: The account is temporarily blocked until this date.
      - `block_perm` boolean, nullable, required: The account is permanently blocked.
      - `pending_activation` boolean, nullable, required: The account is pending activation.
      - `gdpr` boolean, nullable, required: The account has GDPR requirements.
    - `organization` string: Organization ID
    - `roles` array[]: Roles
      - RolesDto[]
        - `id` string, required: Role ID
        - `permissions` PermissionDto[], required: Permissions
          - `id` string, required: Permission ID
          - `name` string, required: Permission name
          - `description` string, required: Permission description
          - `subject` SubjectDto, required
            - `id` string: Subject ID
            - `fields` string[]: Fields
            - `entity` string: Entity identified by this subject
          - `actions` string[], required: The actions that this permission allows to be performed on the subject
        - `name` string, required: Role name
        - `description` string, required: Role description
        - `public` boolean, required: If **True**, this role is available to all user, including those that are not logged it.
        - `default` boolean, required: If **True**, this role is assigned to any newly created organization.
    - `channels` ObjectId[]: Channels
    - `is_admin` boolean: Admin account
    - `is_tenant_user` boolean: The account is the owner of the organization
    - `is_super_user` boolean: Super user

## Other responses

- `404`: Account not found

---

[API](https://skmtc.dev/fanhero/apis/user-management-endpoints.md) - [All operations](https://skmtc.dev/fanhero/apis/user-management-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/fanhero/apis/user-management-endpoints/revisions/3f982670c057?raw)