Как зарегистрировать скоуп — Versola Docs
VersolaVersola/docs
0.5.0versola.kzGitHub

Как зарегистрировать скоуп

Пошаговое создание OAuth-скоупа и его claims в административной панели Versola

Скоуп — это именованный набор claims, которые клиент может запросить о пользователе. На этой странице разобрано его создание в административной панели. Общая картина описана в разделе Сущности.

Что понадобится

  • Тенант, которому принадлежит скоуп.
  • Список claims, которые должен выдавать скоуп, с коротким описанием для каждого — описание показывается пользователю на экране согласия.

1. Откройте раздел Scopes

Выберите тенант и откройте Scopes. На каждой карточке показаны описание и ID скоупа; клик по карточке раскрывает ее claims.

Scopes — список скоупов, зарегистрированных в выбранном тенанте
Список OAuth-скоупов в административной панели Versola
Раскрытая карточка скоупа с claims, которые он выдает
Раскрытая карточка скоупа с его claims

2. Начните создание скоупа

Нажмите + Create Scope.

Create New Scope — пустая форма
Пустая форма создания скоупа

3. Заполните идентификацию и claims

  • Scope ID — строчные буквы, цифры и подчеркивания, начинается с буквы (например, orders_read). Неизменяем после создания.
  • Description — показывается пользователям на экране согласия и администраторам по всей панели.
  • Claims — для каждого claim укажите ID (ключ, под которым он попадет в ID-токен и в ответ userinfo) и описание, затем нажмите Add Claim. У скоупа может быть любое количество claims, включая ноль.
Scope ID, описание и добавленный claim
Форма скоупа с заполненными ID, описанием и добавленным claim

4. Создайте скоуп

Нажмите Create Scope. Он сразу доступен для выдачи клиентам: откройте клиента и добавьте скоуп в OAuth Scopes.

Редактирование или удаление скоупа

Иконка карандаша на карточке скоупа позволяет изменить описание или claims — сам Scope ID изменить после создания нельзя. Иконка корзины удаляет скоуп; любой клиент, которому он был выдан, теряет возможность его запрашивать.