API управления пользователями и ролями от лица системы

API получения сведений о пользователях из внешних источников данных Версия 0.1.200914

Сервер

/sso

Методы

Поиск учетной записи пользователя по `id`

GET /provision/realms/{realm}/externalIdpProfile/v1/by_principalIdAndSocialNetworkId/{principalId}/{socialNetworkId}/person

Получение персональных данных пользователя из социальной сети по уникальному идентификатору пользователя

Способы авторизации
Способ	Описание
HTTP	Системный токен, полученный по схеме `client_credentials` Схема авторизации: `bearer`

Параметры запроса

Параметры, размещаемые в пути метода
`realm`	Обязателен	Пространство (группа) пользователей Тип данных `string`
`principalId`	Обязателен	Идентификатор пользователя в UIDM вида `{prefix}_{id}`, например `sso_____3273f1ad-1811-410f-8ac9-f459312f15f6`. Возвращается в заголовках при запросе на создание учетной записи, или при поиске в поле `id` в теле ответа Тип данных `string`
`socialNetworkId`	Обязателен	Код социальной сети в UIDM, например `esia`, `vkontakte`, `yandex` Тип данных `string`

Ответы сервера

HTTP-код Описание

200

Успешный ответ. Результат поиска в теле ответа

Тело ответа:

application/json

"displayNameNat": string,

// Полное имя пользователя

"shortNameNat": string,

// Краткое имя пользователя

"firstNameNat": string,

// Имя пользователя

"lastNameNat": string,

// Фамилия пользователя

"patronymicNameNat": string,

// Отчество пользователя

"snils": string,

// СНИЛС пользователя

"inn": string,

// ИНН пользователя

"gender": string,

// Пол пользователя

( MALE
| FEMALE )

"citizenship": string,

// Гражданство пользователя

"birthPlace": string,

// Место рождения пользователя

"birthDate": string,

// Дата рождения пользователя, в формате YYYY-MM-DD

"verificationStatus": string,

// Статус верификации

( VERIFIED
| NOT_VERIFIED
| UNDEFINED )

"contacts": [

// Контактные данные пользователя

{

"contactType": string,

// Тип контакта

( phone
| email )

"address": string,

// Значение адреса (email или номер телефона), в зависимости от `contactType`, строка не более 1000 символов

"verificationStatus": string,

// Статус верификации

( VERIFIED
| NOT_VERIFIED
| UNDEFINED )

"addresses": [

// Адреса пользователя

{

"type": string,

// Тип адреса

( POST
| OFFICIAL
| RESIDENCE
| WORK )

"zipCode": string,

// Почтовый индекс

"countryId": string,

// Страна

"region": string,

// Область

"area": string,

// Район

"city": string,

// Город

"settlement": string,

// Населенный пункт

"street": string,

// Улица

"house": string,

// Дом

"building": string,

// Строение

"frame": string,

// Корпус

"flat": string,

// Квартира

"addressStr": string,

// Адрес как строка

"documents": [

// Документы пользователя

{

"type": string,

// Тип документа

"number": string,

// Номер документа

"series": string,

// Серия документа

"issueDate": string,

// Дата выдачи документа

"issuedBy": string,

// Наименование органа выдавшего документ

"issuedById": string,

// Код органа выдавшего документ

"validTo": string,

// Срок действия документа

"verificationStatus": string,

// Статус верификации

( VERIFIED
| NOT_VERIFIED
| UNDEFINED )

400

Некорректный запрос либо данные из ЕСИА сейчас получить невозможно

Заголовки ответа

X-Context-Id: string

// Уникальный идентификатор запроса для сквозного логирования

Тело ответа:

application/json

"error": {

"code": integer,

// Код ответа

"message": string,

// Описание ошибки

Пример:

"error": {

"code": "400",

"message": "External IDP error",

}

401

Доступ запрещен. Авторизация не пройдена

404

Адресуемая сущность не найдена. Ошибка является non-retryable

Заголовки ответа

X-Context-Id: string

// Уникальный идентификатор запроса для сквозного логирования

Тело ответа:

application/json

"error": {

"code": integer,

// Код ответа

"message": string,

// Описание ошибки

Поиск учетной записи пользователя по токену

GET /provision/realms/{realm}/externalIdpProfile/v1/ty_token/{socialNetworkId}/person

Получение персональных данных пользователя из социальной сети по токену, полученному через сценарий валидации учетной записи социальной сети social-validate

Способы авторизации
Способ	Описание
HTTP	Пользовательский токен, полученный через сценарий `social-validate` Схема авторизации: `bearer`

Параметры запроса

Параметры, размещаемые в пути метода
`realm`	Обязателен	Пространство (группа) пользователей Тип данных `string`
`socialNetworkId`	Обязателен	Код социальной сети в UIDM, например `esia`, `vkontakte`, `yandex` Тип данных `string`

Ответы сервера

HTTP-код Описание

200

Успешный ответ. Результат поиска в теле ответа

Тело ответа:

application/json

"displayNameNat": string,

// Полное имя пользователя

"shortNameNat": string,

// Краткое имя пользователя

"firstNameNat": string,

// Имя пользователя

"lastNameNat": string,

// Фамилия пользователя

"patronymicNameNat": string,

// Отчество пользователя

"snils": string,

// СНИЛС пользователя

"inn": string,

// ИНН пользователя

"gender": string,

// Пол пользователя

( MALE
| FEMALE )

"citizenship": string,

// Гражданство пользователя

"birthPlace": string,

// Место рождения пользователя

"birthDate": string,

// Дата рождения пользователя, в формате YYYY-MM-DD

"verificationStatus": string,

// Статус верификации

( VERIFIED
| NOT_VERIFIED
| UNDEFINED )

"contacts": [

// Контактные данные пользователя

{

"contactType": string,

// Тип контакта

( phone
| email )

"address": string,

// Значение адреса (email или номер телефона), в зависимости от `contactType`, строка не более 1000 символов

"verificationStatus": string,

// Статус верификации

( VERIFIED
| NOT_VERIFIED
| UNDEFINED )

"addresses": [

// Адреса пользователя

{

"type": string,

// Тип адреса

( POST
| OFFICIAL
| RESIDENCE
| WORK )

"zipCode": string,

// Почтовый индекс

"countryId": string,

// Страна

"region": string,

// Область

"area": string,

// Район

"city": string,

// Город

"settlement": string,

// Населенный пункт

"street": string,

// Улица

"house": string,

// Дом

"building": string,

// Строение

"frame": string,

// Корпус

"flat": string,

// Квартира

"addressStr": string,

// Адрес как строка

"documents": [

// Документы пользователя

{

"type": string,

// Тип документа

"number": string,

// Номер документа

"series": string,

// Серия документа

"issueDate": string,

// Дата выдачи документа

"issuedBy": string,

// Наименование органа выдавшего документ

"issuedById": string,

// Код органа выдавшего документ

"validTo": string,

// Срок действия документа

"verificationStatus": string,

// Статус верификации

( VERIFIED
| NOT_VERIFIED
| UNDEFINED )

400

Некорректный запрос либо данные из ЕСИА сейчас получить невозможно

Заголовки ответа

X-Context-Id: string

// Уникальный идентификатор запроса для сквозного логирования

Тело ответа:

application/json

"error": {

"code": integer,

// Код ответа

"message": string,

// Описание ошибки

Пример:

"error": {

"code": "400",

"message": "External IDP error",

}

401

Доступ запрещен. Авторизация не пройдена

404

Адресуемая сущность не найдена. Ошибка является non-retryable

Заголовки ответа

X-Context-Id: string

// Уникальный идентификатор запроса для сквозного логирования

Тело ответа:

application/json

"error": {

"code": integer,

// Код ответа

"message": string,

// Описание ошибки