//[passport](../../../index.md)/[com.yandex.passport.api](../index.md)/[Passport](index.md)

# Passport

[passport]\
open class [Passport](index.md)

## Functions

| Name | Summary |
|---|---|
| [createOptionalPassportPaymentAuthArguments](create-optional-passport-payment-auth-arguments.md) | [passport]<br>@Nullable<br>open fun [createOptionalPassportPaymentAuthArguments](create-optional-passport-payment-auth-arguments.md)(@NonNullintent: Intent): [PassportPaymentAuthArguments](../-passport-payment-auth-arguments/index.md)<br>Достает из Intent аргументы для прохождения платежной авторизации если они там лежат. |
| [createPassportApi](create-passport-api.md) | [passport]<br>@NonNull<br>open fun [createPassportApi](create-passport-api.md)(@NonNullcontext: Context): [PassportApi](../-passport-api/index.md)<br>Возвращает объект, который нужно использовать для вызова методов [PassportApi](../-passport-api/index.md). |
| [createPassportApplicationBindPropertiesBuilder](create-passport-application-bind-properties-builder.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportApplicationBindPropertiesBuilder~~](create-passport-application-bind-properties-builder.md)~~(~~~~)~~~~:~~ [PassportSocialApplicationBindProperties.Builder](../-passport-social-application-bind-properties/-builder/index.md) |
| [createPassportAutoLoginPropertiesBuilder](create-passport-auto-login-properties-builder.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportAutoLoginPropertiesBuilder~~](create-passport-auto-login-properties-builder.md)~~(~~~~)~~~~:~~ [PassportAutoLoginProperties.Builder](../-passport-auto-login-properties/-builder/index.md) |
| [createPassportBindPropertiesBuilder](create-passport-bind-properties-builder.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportBindPropertiesBuilder~~](create-passport-bind-properties-builder.md)~~(~~~~)~~~~:~~ [PassportSocialBindProperties.Builder](../-passport-social-bind-properties/-builder/index.md) |
| [createPassportCode](create-passport-code.md) | [passport]<br>@Deprecated<br>@NonNull<br>~~open~~ ~~fun~~ [~~createPassportCode~~](create-passport-code.md)~~(~~@NonNullenvironment: [PassportEnvironment](../-passport-environment/index.md), @NonNullvalue: String~~)~~~~:~~ [PassportCode](../-passport-code/index.md) |
| [createPassportCookie](create-passport-cookie.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportCookie~~](create-passport-cookie.md)~~(~~@NonNullintent: Intent~~)~~~~:~~ [PassportCookie](../-passport-cookie/index.md) |
| [createPassportCredentials](create-passport-credentials.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportCredentials~~](create-passport-credentials.md)~~(~~@NonNullencryptedId: String, @NonNullencryptedSecret: String~~)~~~~:~~ [PassportCredentials](../-passport-credentials/index.md)<br>Создаёт контейнер для зашифрованной пары client id / client secret. |
| [createPassportEnvironment](create-passport-environment.md) | [passport]<br>@Deprecated<br>@NonNull<br>~~open~~ ~~fun~~ [~~createPassportEnvironment~~](create-passport-environment.md)~~(~~integer: Int~~)~~~~:~~ [PassportEnvironment](../-passport-environment/index.md) |
| [createPassportFilterBuilder](create-passport-filter-builder.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportFilterBuilder~~](create-passport-filter-builder.md)~~(~~~~)~~~~:~~ [PassportFilter.Builder](../-passport-filter/-builder/index.md)<br>Создаёт builder для фильтра аккаунтов по их типу [PassportFilter](../-passport-filter/index.md). |
| [createPassportLoginError](create-passport-login-error.md) | [passport]<br>@NonNull<br>open fun [createPassportLoginError](create-passport-login-error.md)(@NonNullintent: Intent): [PassportLoginError](../-passport-login-error/index.md)<br>Возвращает ошибку неуспешной авторизации. |
| [createPassportLoginOptionalResult](create-passport-login-optional-result.md) | [passport]<br>@Nullable<br>open fun [createPassportLoginOptionalResult](create-passport-login-optional-result.md)(@NonNullintent: Intent): [PassportLoginResult](../-passport-login-result/index.md)<br>Возвращает результат авторизации или null если авторизация не состоялась |
| [createPassportLoginPropertiesBuilder](create-passport-login-properties-builder.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportLoginPropertiesBuilder~~](create-passport-login-properties-builder.md)~~(~~~~)~~~~:~~ [PassportLoginProperties.Builder](../-passport-login-properties/-builder/index.md)<br>Создаёт builder для фильтра показа формы авторизации пользователя [PassportLoginProperties](../-passport-login-properties/index.md). |
| [createPassportLoginResult](create-passport-login-result.md) | [passport]<br>@NonNull<br>open fun [createPassportLoginResult](create-passport-login-result.md)(@NonNullintent: Intent): [PassportLoginResult](../-passport-login-result/index.md)<br>Возвращает результат успешной авторизации. |
| [createPassportPropertiesBuilder](create-passport-properties-builder.md) | [passport]<br>@NonNull<br>@Deprecated<br>~~open~~ ~~fun~~ [~~createPassportPropertiesBuilder~~](create-passport-properties-builder.md)~~(~~~~)~~~~:~~ [PassportProperties.Builder](../-passport-properties/-builder/index.md) |
| [createPassportUid](create-passport-uid.md) | [passport]<br>@Deprecated<br>@NonNull<br>~~open~~ ~~fun~~ [~~createPassportUid~~](create-passport-uid.md)~~(~~value: Long~~)~~~~:~~ [PassportUid](../-passport-uid/index.md)<br>@Deprecated<br>@NonNull<br>~~open~~ ~~fun~~ [~~createPassportUid~~](create-passport-uid.md)~~(~~@NonNullenvironment: [PassportEnvironment](../-passport-environment/index.md), value: Long~~)~~~~:~~ [PassportUid](../-passport-uid/index.md) |
| [createPassportWebAmPropertiesBuilder](create-passport-web-am-properties-builder.md) | [passport]<br>open fun [createPassportWebAmPropertiesBuilder](create-passport-web-am-properties-builder.md)(): [PassportWebAmProperties.Builder](../-passport-web-am-properties/-builder/index.md) |
| [initializePassport](initialize-passport.md) | [passport]<br>open fun [initializePassport](initialize-passport.md)(@NonNullcontext: Context, @NonNullpassportProperties: [PassportProperties](../-passport-properties/index.md))<br>Инициализация API для процесса *:passport* в Application. |
| [isInPassportProcess](is-in-passport-process.md) | [passport]<br>open fun [isInPassportProcess](is-in-passport-process.md)(): Boolean<br>Возвращает true, если текущий процесс *:passport*, иначе – false. |
| [killPassportProcess](kill-passport-process.md) | [passport]<br>open fun [killPassportProcess](kill-passport-process.md)(@NonNullcontext: Context)<br>Убивает паспортный процесс из клиентского процесса. |
| [processTurboAppAuth](process-turbo-app-auth.md) | [passport]<br>@NonNull<br>open fun [processTurboAppAuth](process-turbo-app-auth.md)(@Nullableintent: Intent): [PassportTurboAppResult](../-passport-turbo-app-result/index.md)<br>Обрабатывает результат экрана OAuth скоупов. |

## Properties

| Name | Summary |
|---|---|
| [ACTION_LOGIN_RESULT](-a-c-t-i-o-n_-l-o-g-i-n_-r-e-s-u-l-t.md) | [passport]<br>@Deprecated<br>~~val~~ [~~ACTION_LOGIN_RESULT~~](-a-c-t-i-o-n_-l-o-g-i-n_-r-e-s-u-l-t.md)~~:~~ String |
| [EXTRA_PAYMENT_ARGUMENTS](-e-x-t-r-a_-p-a-y-m-e-n-t_-a-r-g-u-m-e-n-t-s.md) | [passport]<br>val [EXTRA_PAYMENT_ARGUMENTS](-e-x-t-r-a_-p-a-y-m-e-n-t_-a-r-g-u-m-e-n-t-s.md): String |
| [EXTRA_PHONE_NUMBER](-e-x-t-r-a_-p-h-o-n-e_-n-u-m-b-e-r.md) | [passport]<br>val [EXTRA_PHONE_NUMBER](-e-x-t-r-a_-p-h-o-n-e_-n-u-m-b-e-r.md): String |
| [PASSPORT_ENVIRONMENT_PRODUCTION](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-p-r-o-d-u-c-t-i-o-n.md) | [passport]<br>val [PASSPORT_ENVIRONMENT_PRODUCTION](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-p-r-o-d-u-c-t-i-o-n.md): [PassportEnvironment](../-passport-environment/index.md)<br> Статичный объект, указывающий на боевое внешнее паспортное окружение - условный [passport.yandex.ru](https://passport.yandex.ru). |
| [PASSPORT_ENVIRONMENT_RC](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-r-c.md) | [passport]<br>val [PASSPORT_ENVIRONMENT_RC](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-r-c.md): [PassportEnvironment](../-passport-environment/index.md)<br> Статичный объект, указывающий на релиз-кандидат внешнего паспортного окружение - условный [passport-rc.yandex.ru](https://passport-rc.yandex.ru). |
| [PASSPORT_ENVIRONMENT_TEAM_PRODUCTION](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-t-e-a-m_-p-r-o-d-u-c-t-i-o-n.md) | [passport]<br>val [PASSPORT_ENVIRONMENT_TEAM_PRODUCTION](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-t-e-a-m_-p-r-o-d-u-c-t-i-o-n.md): [PassportEnvironment](../-passport-environment/index.md)<br> Статичный объект, указывающий на боевое внутреннее паспортное окружение - условный [passport.yandex-team.ru](https://passport.yandex-team.ru). |
| [PASSPORT_ENVIRONMENT_TEAM_TESTING](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-t-e-a-m_-t-e-s-t-i-n-g.md) | [passport]<br>val [PASSPORT_ENVIRONMENT_TEAM_TESTING](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-t-e-a-m_-t-e-s-t-i-n-g.md): [PassportEnvironment](../-passport-environment/index.md)<br> Статичный объект, указывающий на тестовое внутреннее паспортное окружение - условный [passport-test.yandex-team.ru](https://passport-test.yandex-team.ru). |
| [PASSPORT_ENVIRONMENT_TESTING](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-t-e-s-t-i-n-g.md) | [passport]<br>val [PASSPORT_ENVIRONMENT_TESTING](-p-a-s-s-p-o-r-t_-e-n-v-i-r-o-n-m-e-n-t_-t-e-s-t-i-n-g.md): [PassportEnvironment](../-passport-environment/index.md)<br> Статичный объект, указывающий на тестовое внешнее паспортное окружение - условный [passport-test.yandex.ru](https://passport-test.yandex.ru). |
| [RESULT_ERROR](-r-e-s-u-l-t_-e-r-r-o-r.md) | [passport]<br>val [RESULT_ERROR](-r-e-s-u-l-t_-e-r-r-o-r.md): Int<br>Activity result code в случае ошибки, если ошибку нужно обработать вне активити. |
| [RESULT_OK_WITH_TASK_ID](-r-e-s-u-l-t_-o-k_-w-i-t-h_-t-a-s-k_-i-d.md) | [passport]<br>val [RESULT_OK_WITH_TASK_ID](-r-e-s-u-l-t_-o-k_-w-i-t-h_-t-a-s-k_-i-d.md): Int<br>Activity result code after success authorization with task id as result |
| [RESULT_SKIP](-r-e-s-u-l-t_-s-k-i-p.md) | [passport]<br>val [RESULT_SKIP](-r-e-s-u-l-t_-s-k-i-p.md): Int<br>Activity result code в случае если пользователь нажал кнопку &quot;Пропустить&quot; |
