Встроенные типы вызовов для аутентификации и их возможности

Применяется: зеленый круг с символом белой галочки, указывающим, что следующее содержимое применяется к внешним клиентам. Внешние клиенты (дополнительные сведения)

Встроенная проверка подлинности поддерживает два потока проверки подлинности:

  • Электронная почта с одноразовым секретным кодом (OTP)
  • Электронная почта и пароль с поддержкой самостоятельного сброса пароля (SSPR)

Клиентское приложение, использующее собственную проверку подлинности для входа пользователей, может использовать любой поток проверки подлинности. Чтобы выполнить успешные вызовы к собственному API проверки подлинности, приложение должно объявить, какие потоки проверки подлинности и возможности он поддерживает. API собственной проверки подлинности позволяет клиентским приложениям объявлять поддерживаемые типы и возможности вызовов с помощью предопределенных значений.

Типы проблем

Типы вызовов являются предопределенными значениями, которые клиентские приложения включают в свои запросы, чтобы объявить, какие потоки проверки подлинности они поддерживают для собственного API проверки подлинности.

В следующей таблице содержатся поддерживаемые значения типов вызовов:

Тип задачи Описание
пароль Этот тип задачи указывает, что приложение поддерживает сбор парольных учетных данных от пользователя.
oob Этот тип вызова указывает, что приложение поддерживает использование одноразовых паролей или кодов секретного кода (OTP), отправленных пользователю с помощью дополнительного канала. В настоящее время API поддерживает только электронную почту и SMS OTP.
перенаправление Этот тип вызова указывает, что приложение поддерживает возврат к делегированной браузером проверке подлинности, также называемой веб-резервным вариантом. Все приложения, совместимые с собственной проверкой подлинности, должны поддерживать эту возможность. Это требование означает, что при каждом вызове приложения к нативному API аутентификации, оно должно включать этот тип задачи. Если клиентское приложение не включает этот тип проверки, запрос завершается ошибкой.

Новые значения добавляются, когда собственная проверка подлинности поддерживает новые методы проверки подлинности.

Значения типов вызовов для нативных потоков проверки подлинности

В следующей таблице приведены значения типов задач, которые приложение должно использовать для различных потоков проверки подлинности.

Поток регистрации Процесс входа SSPR
Электронная почта с паролем oob, парольи перенаправление oob, парольи перенаправление oob и перенаправить
OTP для электронной почты oob и перенаправить oob и перенаправить Неприменимо

Важные заметки:

  • Приложения, использующие собственный API проверки подлинности , должны включать тип вызова перенаправления при объявлении поддерживаемых типов вызовов.
  • Приложения, использующие пакеты SDK для собственной проверки подлинности (Android, iOS или JavaScript), не должны включать тип задачи перенаправления , так как пакет SDK автоматически включает его.

Возможности

Помимо типов проблем клиентские приложения могут указать список возможностей. Хотя challenge_type определяет, какие методы проверки подлинности поддерживает приложение, capabilities укажите, какие дополнительные потоки клиентское приложение может обрабатывать и какие возможности пользовательского интерфейса он может предоставить пользователям.

API собственной проверки подлинности поддерживает следующие возможности:

  • mfa_required: указывает, что клиентское приложение может обрабатывать потоки многофакторной проверки подлинности (MFA), включая отображение соответствующего пользовательского интерфейса для пользователей для выполнения проблем MFA при необходимости.
  • registration_required: клиент может обрабатывать надежную регистрацию проверки подлинности: он может вызывать API регистрации и показывать пользовательский интерфейс, чтобы помочь пользователям регистрировать надежные методы проверки подлинности.

Поведение неподдерживаемых типов и возможностей вызовов

В следующей таблице приведены сведения о поведении, если собственный API проверки подлинности или клиентское приложение не поддерживает заданный тип или возможность:

Сценарий Поведение
Клиентское приложение включает неподдерживаемый тип задачи API собственной проверки подлинности возвращает ошибку и обрабатывает запрос как недопустимый.
Клиентское приложение включает неподдерживаемые возможности API собственной проверки подлинности возвращает ошибку и обрабатывает запрос как недопустимый.
Клиентское приложение не включает необходимый тип проверки Приложение не поддерживает тип вызова, настроенный администратором. API собственной проверки подлинности инициирует веб-резервную версию.
Клиентское приложение не может включать необходимые возможности Приложение обычно работает, если не требуется регистрация MFA или строгой проверки подлинности. Если эти возможности необходимы, но не поддерживаются, собственный API проверки подлинности инициирует веб-резервный вариант для завершения потока проверки подлинности.

Связанное содержимое

  • Last updated on