Создание клиента для доступа к API-ресурсу

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

к сведению

В Платформе создан клиент default, параметры которого наследуют все создаваемые клиенты.

Чтобы создать клиента:

1. В меню консоли администрирования выберите Microservice Interaction.

2. На странице Microservice Interaction выберите вкладку Clients.

3. Над списком клиентов, который отображается, вверху слева нажмите +.

4. В окне Client, которое отображается, укажите следующие параметры:

   примечание

   По умолчанию в окне Client отображается сокращенный набор параметров. Если вы хотите отобразить и настроить расширенный набор параметров, в окне Client включите переключатель Show advanced options.

   • на вкладке General:

     • Client Name (обязательный параметр): введите уникальный идентификатор клиента. Идентификатор клиента может включать латинские буквы и цифры. Длина идентификатора не должна превышать 200 символов.
     • Display Name (обязательный параметр): введите имя клиента в произвольной форме. Длина имени не должна превышать 200 символов.
     • Description (необязательный параметр): введите описание клиента. Длина описания не должна превышать 1000 символов.
     • Client ReadOnly: включите переключатель, если вы хотите, чтобы настройки этого клиента нельзя было изменить. По умолчанию переключатель выключен.
     • Active Client: выключите переключатель, если вы хотите запретить работу клиента в случае его дискредитации, например, по причине DDoS-атаки от имени этого клиента. По умолчанию переключатель включен.
     • Use Default Form: включите переключатель, если вы хотите использовать форму авторизации клиента по умолчанию. По умолчанию переключатель выключен, что означает использование настраиваемой формы.

   • на вкладке Options:

     • в группе Basic:

       • Allow Offline Access: включите переключатель, если вы хотите, чтобы клиент мог запрашивать обновляемый токен доступа. По умолчанию переключатель выключен.
       • Allow Access Tokens Via Browser: включите переключатель, если вы хотите, чтобы клиент мог получать токен доступа через браузер. По умолчанию переключатель выключен.

     • в группе Token:

       • Access Token Lifetime: укажите срок действия токена доступа в секундах. По умолчанию указано значение 3600 с.
       • Absolute Refresh Token Lifetime: укажите срок действия (в секундах) токена обновления с момента его создания. Токен обновления используется для получения новых пар токенов — токена доступа и токена обновления — по истечении срока действия текущего токена доступа. По умолчанию указано значение 43200 с.

   • на вкладке Scopes: добавьте области разрешений доступа для создаваемого клиента. Нажмите + и в окне, которое отображается, укажите API-ресурс, далее из отобразившегося списка выберите релевантные области разрешений доступа для создаваемого клиента.

   • на вкладке Grant Types: укажите типы предоставления доступа клиенту или взаимодействия клиента с сервисом токенов. По умолчанию ни один из типов не выбран. Включите один или несколько следующих переключателей:

     • delegation: включите переключатель, если вы хотите, чтобы для аутентификации клиент мог обращаться к другим сервисам от имени интерактивного пользователя.
     • implicit: включите переключатель, если вы хотите, чтобы клиент типа нативного приложения, созданного с использованием инструментов разработки Apple или Google и распространяемого через магазины приложений, или JavaScript-приложения мог получить токен доступа без использования кода авторизации. Этот вариант считается ненадежным и может быть заменен на вариант authorization_code.
     • password: включите переключатель, если вы хотите разрешить авторизацию клиента с помощью имени и пароля пользователя. Этот вариант авторизации считается ненадежным и может быть заменен на вариант authorization_code.
     • authorization_code: включите переключатель, если вы хотите разрешить аутентификацию клиента с помощью идентификатора клиента.
     • client_credentials: включите переключатель, если вы хотите разрешить аутентификацию клиента с помощью идентификатора клиента и секретного ключа.
     • refresh_token: включите переключатель, если вы хотите разрешить клиенту использовать токен обновления и таким образом позволить продлевать доступ клиента к сервису.

   • на вкладке Redirect URIs: укажите следующие параметры только для пользователей сервисов, авторизация в которых происходит в пользовательском интерфейсе, или для Swagger:

     • Redirect URIs (необязательный параметр): введите URL-адрес, на который сервис аутентификации должен отправить токен доступа. Длина URL-адреса не должна превышать 2000 символов.
     • Post Logout Redirect URIs (необязательный параметр): введите URL-адрес, на который будет перенаправлен пользователь после выхода из приложения на базе Платформы. Длина URL-адреса не должна превышать 2000 символов.

5. Нажмите Create Client.

Окно Client закрывается. Параметры клиента сохраняются в базе данных сервиса аутентификации. Созданный клиент отображается в списке клиентов на странице Microservice Interaction→Clients.