---
title: "POST /api/v1/external-users/authenticate"
method: POST
path: "/api/v1/external-users/authenticate"
tags: ["External Users"]
---

# POST /api/v1/external-users/authenticate

`POST /api/v1/external-users/authenticate`

Authenticates an external user.

## Headers

- `authorization` string, required — The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

## Request body

- object
  - `channelId` string, uuid, required — A UUID v4 string that identifies an entity.
  - `externalId` string, nullable, required
  - `id` string, uuid, nullable, required — A UUID v4 string that identifies an entity.
  - `identifier` string, nullable, required

## Response `200`

The external user was authenticated and access token generated.

- object
  - `createdAt` string, date-time, required
  - `id` string, uuid, required — A UUID v4 string that identifies an entity.
  - `updatedAt` string, date-time, required
  - `blocked` boolean, required — Whether the external user is blocked.
  - `channelId` string, uuid, required — The ID of the channel associated with the external user.
  - `externalId` string, nullable, required — External reference in the integrated system.
  - `externalUserGroupId` string, uuid, nullable, required — The ID of the external user group associated with the external user.
  - `identifier` string, nullable, required — A unique identifier of the external user (usernames, emails, phone numbers and etc).
  - `name` string, nullable, required — The display name of the external user.
  - `superIdentityId` string, uuid, required — The ID of the super identity associated with the external user.
  - `tierId` string, uuid, nullable, required — The ID of the tier associated with the external user.
  - `workspaceId` string, uuid, required — The ID of the workspace associated with the external user.
  - `accessToken` string, required

## Other responses

- `400` — Invalid data provided.
- `401` — Unauthorized.
- `404` — Channel not found.

---

[API](https://skmtc.dev/zaia/apis/public-api.md) · [All operations](https://skmtc.dev/zaia/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zaia/public-api/revisions/58da3b2ba49f/schema)