Как зарегистрировать scope — Versola Docs
/docs
До 1.00.7.5versola.ioGitHub
RUEN

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

Создайте scope и его claims в консоли администратора Versola и выдайте scope клиенту

Scope — именованный набор claims, которые клиент может запросить о пользователе. Здесь вы создадите scope в консоли администратора и выдадите его клиенту. Нужен тенант. Поля и правила описаны в разделе Scope.

Предварительные требования

  • Тенант, выбранный в переключателе тенантов консоли.
  • Claims, которые должен отдавать scope, и короткое описание каждого для экрана согласия.

1. Откройте Scopes

Откройте Scopes в нужном тенанте. Страница называется OAuth Scopes. На карточке — описание и ID scope. Раскройте карточку, чтобы увидеть claims.

Scope выбранного тенанта, есть поиск по ID
Страница OAuth Scopes со списком scope.
Раскрытый scope openid: он отдает claim sub
Scope раскрыт: видны его claims.

2. Начните новый scope

Нажмите + Create Scope.

Create New Scope: ID, описание и claims
Пустая форма Create New Scope.

3. Заполните scope

  1. Scope ID: строчные латинские буквы, цифры и подчеркивания, первый символ — буква, например payments_export. Двоеточия, точки и дефисы отклоняются, поэтому payments:export — недопустимый scope ID. Позже ID изменить нельзя.
  2. Description: текст, который пользователь видит на экране согласия. Вкладки под полем, здесь en и ru, — это языки, включенные в Locales на странице System settings. Английский обязателен.
  3. Claims, если нужны. Введите Claim ID — имя claim пользователя, который нужно отдавать, например email. Добавьте его описание и нажмите Add Claim. Повторите для каждого claim. Для Claim ID те же правила символов, что и для scope ID.
Заполнены Scope ID и описание, claims пока не добавлены
Форма Create New Scope заполнена.

4. Создайте scope

Нажмите Create Scope. Scope появится в списке. Если ID или claim не подходят под правила, Central API отклонит сохранение, а консоль покажет ошибку.

5. Выдайте scope клиенту

Пока клиенту не разрешено запрашивать scope, он ничего не делает. Откройте клиента, нажмите Edit в его разделе Scopes и включите scope. См. Клиент. У service app scope нет, для него используйте разрешения.

Изменение и удаление scope

Нажмите карандаш на карточке, чтобы изменить описание или claims. ID не меняется. Крестик удаляет scope после подтверждения. Клиенты сохраняют ID в своих списках scope, но он больше не отдает ни одного claim, поэтому уберите его и там.

Что дальше