---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
vcsPath: motorway/magacg/support/docs/src/ru-x-ai/methods/user.get-ya-id.v0.md
alternate:
  - href: https://yamagistrali.ru/docs/ru-x-ai/methods/user.get-ya-id.v0.md
    type: text/markdown
    title: Markdown version
  - href: https://yamagistrali.ru/docs/ru-x-ai/llms.txt
    rel: describedby
---
<div class="openapi">

# Получить идентификаторы текущего пользователя

<!-- markdownlint-disable-file -->

[Порядок работы для агента](https://yamagistrali.ru/docs/ru-x-ai/concepts/agent-workflow.md) · [Методы API и схема OpenAPI](https://yamagistrali.ru/docs/ru-x-ai/methods/index.md).

## Назначение

Вызовите этот метод первым при проверке доступа на тестовом стенде. Он показывает, под какой учётной записью выполнен запрос. Для проверки профиля сотрудника нужен отдельный вызов, а для бизнес-операции — отдельная проверка прав.

> **Метод:** `GET /api/user/getYaId/v0`

## Доступ

|  |  |
|---|---|
| **Аутентификация** | Требуется |
| **Роли организаций** | — |
| **Права пользователя** | — |
| **Область доступа** | Идентификаторы текущего аутентифицированного пользователя |

|  |  |
|---|---|
| **Эффект** | Только чтение |
| **Повтор вызова** | Безопасно повторять |
| **Повтор после ошибки** | Только после временных ошибок |
| **Автоматизация** | Требуется подтверждение |
| **Чувствительность данных** | Содержит чувствительные данные |

Для вызова нужна аутентификация. Метод работает в пределах текущей учётной записи и не требует роли организации или отдельных прав.

## Входные данные

Отправьте GET-запрос без тела и параметров.

## Результат

`emailId` — идентификатор почтовой учётной записи, связанной с запросом.

`yaId` — идентификатор Яндекс ID той же учётной записи.

Успешный ответ подтверждает аутентификацию для этого вызова. Если для сценария нужна роль сотрудника, продолжите с `GET /api/users/userEmployees/get/list/v0`.

### Что сообщить пользователю

Укажите стенд и сообщите, подтвердилась ли аутентификация. При ошибке сообщите HTTP-статус, если он получен. Токен, идентификаторы и тела запроса и ответа оставьте в клиенте.

## Повтор запроса

Метод только читает данные. Ограничивайте число повторов и повторяйте запрос только после временных сетевых ошибок или ошибок сервера. После сбоя аутентификации или настройки дождитесь, пока пользователь восстановит доступ.

## Работа с чувствительными данными

Метод возвращает идентификаторы учётной записи. Раскрывайте исходное значение только по явному запросу, при подтверждённой необходимости и с действующим доступом. Выбирайте минимум полей. Исключите исходные идентификаторы из журналов, трассировок, метрик, диагностики, обычного контекста ИИ и примеров.

| Поле | Класс данных | Субъект | По умолчанию | Ограничения |
|---|---|---|---|---|
| `response.data.emailId` | Внутренний идентификатор | Аутентификация | Не показывать | Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения |

| Поле | Класс данных | Субъект | По умолчанию | Ограничения |
|---|---|---|---|---|
| `response.data.yaId` | Внутренний идентификатор | Аутентификация | Не показывать | Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения |

## Проверенные примеры

Используйте пример для проверки формата без отправки запроса в рабочий сервис.

**Аутентифицированная синтетическая учётная запись** · _синтетический пример_

Оба идентификатора созданы только для документации и не принадлежат реальному пользователю.

**Сокращённый ответ**

```json
{
  "data": {
    "emailId": "email-id-example",
    "yaId": "yandex-id-example"
  }
}
```

> Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде `example` показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://partner-test-yamagistrali.ru/api/user/getYaId/v0
```

</div>

Тестовый стенд

</div>

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "data": {
    "emailId": "example",
    "yaId": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [UserGetYaIdV0Response](https://yamagistrali.ru/docs/ru-x-ai/methods/user.get-ya-id.v0.md#entity-UserGetYaIdV0Response)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "emailId": "example",
  "yaId": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### UserGetYaIdV0Response {#entity-UserGetYaIdV0Response}

#|
|| **Name** | **Description** ||
||

_emailId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_yaId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "emailId": "example",
  "yaId": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Bad Request

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/user.get-ya-id.v0.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### Error {#entity-Error}

#|
|| **Name** | **Description** ||
||

_info_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: object

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_message_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

Forbidden

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/user.get-ya-id.v0.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

Internal Server Error

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/user.get-ya-id.v0.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.