---
title: "Login for share"
method: POST
path: "/v1/shares/auth/login/"
---

# Login for share

`POST /v1/shares/auth/login/`

## Request

- Base URL: `https://app.iconik.io/API/assets`
- URL: `https://app.iconik.io/API/assets/v1/shares/auth/login/`
- Auth: none declared. Required headers: `App-ID`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/shares/auth/login/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `App-ID` string, required

## Request body

- ShareLoginSchema
  - `app_id` string
  - `hash` string, required
  - `object_id` string
  - `object_type` string
  - `password` string
  - `token` string

## Response `200`

Returns a token

- ShareTokenSchema
  - `app_id` string, required
  - `drm` 'none' | 'standard', required: DRM information for the share token, if applicable
  - `email` string, email, required
  - `expires` string, date-time, required
  - `is_internal_user` boolean, required
  - `object_id` string, required
  - `object_type` string, required
  - `roles` string[], required
  - `share_id` string, required
  - `share_session_id` string, nullable
  - `share_user_id` string, required
  - `system_domain_id` string, required
  - `token` string, required
  - `user_id` string, required
  - `watermark` 'none' | 'standard', required: Watermark information for the share token, if applicable

## Other responses

- `400`: Bad request
- `401`: Share link access is not allowed when forensic watermarking is enabled
- `404`: Share does not exist
- `423`: The share has not started yet; starts in the body is its start date
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-assets.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-assets/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-assets/revisions/62580d9e640e?raw)