Unified Identity Management logo figure Unified Identity Management logo figure
Поиск Поиск по документации

Jsonresponse

_eventId

Идентификатор действия. Определяется отдельно для каждого состояния.

access_token

Выданный токен доступа или иной токен.

constraints.attributes.max

Максимальное значение для данного атрибута.

constraints.attributes.min

Минимальное значение для данного атрибута.

constraints.attributes.skip

Регулярное выражение валидации значения для поля.

constraints.attributes

Перечень атрибутов ограничений.

constraints.name

Имя ограничения.

constraints

Список ограничений на поле.

error

Строковый код ошибки.

error_description

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

errors

Список ошибок, сообщение может быть привязано к полю (field).

execution

Идентификатор предсессии аутентификации.

expires_in

Время до истечения срока действия токена в секундах.

externalAuthError

Модель данных, содержащая ошибки внешней системы (определяется интеграционным сценарием).

fields

Список полей формы.

form.errors.field

Поле, в котором найдена ошибка, опционально.

form.errors.message

Сообщение об ошибке валидации, опционально.

form.name

Имя формы.

form

Форма получения параметров аутентификации пользователя.

JWTToken

Токен для длительного хранения и последующей аутентификации в сценарии автоматического входа.

message

Сообщение об ошибке (определяется интеграционным сценарием).

mpt

Опционально: мультиплатформенный токен. Служит для замены ввода логина, пароля и OTP в сценарии аутентификации. Наличие этого токена в ответе зависит от конфигурации сервиса UIDM.

old_token

Опционально: токен, выданный внешней системой.

otpCode

Атрибуты, относящиеся к одноразовому паролю (OTP).

password

Атрибуты, относящиеся к паролю.

refresh_expires_in

Время до истечения срока действия токена обновления доступа (в секундах).

refresh_token

Выданный токен обновления доступа.

scope

Список scope (в формате JSON Array) разрешенных для использования от имени пользователя или приложения. Возможные значения этого атрибута задаются конфигурацией UIDM.

serverUrl

URL для запросов на сервер.

step

Идентификатор шага.

token_type

Тип выданного токена:

Bearer

для сценариев …

JWTToken

для сценария получения системного токена.

username

Атрибуты, относящиеся к имени пользователя (логину).

view.blockedFor

Время до разблокировки (в секундах).

view.category

Указывает на тип сценария, в рамках которого выполняется проверка действительности OTP-кода.

view.expireOtpCodeTime

Срок действия одноразового пароля (в секундах).

extendedAttributes.signingRequestId

Уникальный идентификатор запроса на подписание документов.

view.isBlocked

Признак блокировки пользователя.

view.method

Указывает на способ отправки OTP-кода (например, в других сценариях UIDM код может отправляться на адрес электронной почты).

view.msisdn

Телефонный номер (MSISDN), на который было отправлено сообщение с одноразовым паролем (OTP).

Телефонный номер маскируется перед передачей в соответствии с настройками com.rooxteam.sso.masking.msisdn.search и com.rooxteam.sso.masking.msisdn.replace. Если эти настройки заданы, то все вхождения подстроки из параметра com.rooxteam.sso.masking.msisdn.search будут заменены на значения, заданные в com.rooxteam.sso.masking.msisdn.replace.

Если эти настройки не заданы, то будут переданы крайние правые цифры телефонного номера. Количество передаваемых цифр задано настройкой com.rooxteam.uidm.masking.msisdn.characters.count. Если эта настройка не задана, возвращаются четыре последних (правых) цифры телефонного номера.

view.otpCodeNumber

Порядковый номер отправленного UIDM OTP-кода. Глобальный счётчик отправленных сообщений сбрасывается ежедневно в 00:00.

view.nextOtpCodePeriod

Время до наступления возможности направления нового одноразового пароля (в секундах). Значение идентично полю view.nextOtpPeriod. // end::jsonresponse-view.nextOtpCodePeriod[]

view.nextOtpPeriod

Время до наступления возможности направления нового одноразового пароля (в секундах). Значение идентично полю view.nextOtpCodePeriod. // end::jsonresponse-view.nextOtpPeriod[]

view.otpCodeAvailableAttempts

Количество попыток ввода одноразового пароля (OTP).

view

Дополнительные данные текущего шага. Блок содержит сведения, которые клиент (фронт) может использовать для отображения пользователю. Выбор состава отображаемых сведений оставлен на усмотрение разработчика клиентского приложения. // end::jsonresponse-view[]

realm

Группа пользователей UIDM. Всегда используется значение /customer.

sub

Идентификатор приложения-клиента.

roles

Список ролей, присвоенных клиенту, для которого создавался токен.

client_id

Идентификатор приложения-клиента.

auth_level

Уровень авторизации пользователя, всегда 0, игнорируется.