Авторизация

Обновлено 17 января 2025

auth(props)

Инициирует процесс аутентификации, который возвращает параметры авторизации

Параметры:

Параметр	Обязательный	Тип	Описание
scope	Да	string	Область действия токена
state	Да	string	Состояние сессии
nonce	Да	string	Уникальный идентификатор
redirectUri	Да	string	URL для перенаправления
ssoBaseUrl	Нет	string	Базовый URL SSO, для подставляется sberIDRedirectUri
codeChallenge	Нет	string	Код-испытание (PKCE)
codeChallengeMethod	Нет	string	Метод код-испытанияОбновляет токен приложения. Возвращает: Promise
loginHint	Нет	string	Подсказка для логина

Пример использования:

  const onPressAuth = async () => {
    const result = await SID.auth(
        {
          nonce: nonce,
          scope: scope,
          state: state,
          redirectUri: redirectUri,
          ssoBaseUrl: "https://rambler.ru",
          codeChallenge: "",
          codeChallengeMethod: "",
          loginHint: "",
        });
    console.log(result)
  };

loginWithIDWeb(props)

Функция авторизует пользователя через веб. Возвращает результат аутентификации. Параметры аналогины параметрам функции auth, добавляется:

Параметр	Обязательный	Тип	Описание
svcRedirectUrlString	Да	string	URL для редиректа сервиса

autoAuth(props)

Автоматическая аутентификация через приложение. Возвращает результат аутентификации. Параметры аналогичны параметрам функции auth

sendOtherAuth(props)

Отправляет данные об авторизации через другие сервисы. Возвращает результат аутентификации.

Параметр	Обязательный	Тип	Описание
nameAuthService	Да	string	Имя сервиса
isSuccess	Да	Boolean	Успешность авторизации
isUserNew	Да	Boolean	Новый ли пользователь

Пример использования:

  const onPressSendOtherAuth = async () => {
    await SID.sendOtherAuth(
        {
          isSuccess: true, isUserNew: true, nameAuthService: "AuthServiceName"
        }
    )
  }

setClientID(userID)

Устанавливает идентификатор клиента.

Параметр	Обязательный	Тип	Описание
userID	Да	string	Идентификатор клиента

subscribeToAnalytic

Функция, которая подписывается на аналитику и возвращает результат подписки

getSSOUrlStringFrom(props)

Получает URL SSO на основе переданных параметров, который возвращает преобразованный URL или null

Параметр	Обязательный	Тип	Описание
url	Да	string	Исходный URL

getIDAuthResult(props)

Получает результат аутентификации через ID. Возвращает результат или undefined Параметры:

Параметр	Обязательный	Тип	Описание
deeplink	Да	string	Диплинк для получения результата

closeAuthorizationViewControllers

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

subscribeToAppTokenEvents

Подписывается на события, связанные с App Token и возвращает результат подписки.

checkAppTokenForValid

Проверяет токен приложения на валидность. Возвращает статус валидности appToken'a

updateAppToken(props)

Обновляет токен приложения. Возвращает: Promise<string> — Обновленный токен

Параметры: Параметры аналогичны параметрам функции auth, добавляется:

Параметр	Обязательный	Тип	Описание
clientId	Да	string	Идентификатор клиента

goToPartnerSSO(props)

Переходит на партнера по SSO. Возвращает: Promise<string> — Результат перехода

Параметры:

Параметр	Обязательный	Тип	Описание
webLink	Да	string	Ссылка на веб-ресурс
clientId	Нет	string	Идентификатор клиента
partnerColor	Нет	string	Цвет партнера
openIn	Нет	SID_OPEN_IN_TYPE	Тип открытия (браузер или вебвью)

Пример использования:

  const onPressGoToPartnerSSO = () => {
    SID.goToPartnerSSO(
        {
          clientId: clientID,
          openIn: SID_OPEN_IN_TYPE.WEBVIEW,
          partnerColor: "partnerColor",
          webLink: "https://web.telegram.org"
        }
    );
  }

setUIMode(uiMode)

Устанавливает режим интерфейса для SSO. Возвращает успешность установки.

Параметры:

Параметр	Обязательный	Тип	Описание	По умолчанию
uiMode	Да	COLOR_MODE	Режим интерфейса	COLOR_MODE.AUTO

logout

Выходит из аккаунта.