Expo AuthSession
一个通用库，提供 API 来处理基于浏览器的身份验证。
AuthSession 通过利用 WebBrowser 和 加密 在你的应用中启用基于 Web 浏览器的身份验证（例如，基于浏览器的 OAuth 流）。有关实现细节，请参阅此参考，有关使用方法，请参阅 验证 指南。
¥AuthSession enables web browser-based authentication (for example, browser-based OAuth flows) in your app by utilizing WebBrowser and Crypto. For implementation details, refer to this reference, and for usage, see the Authentication guide.
注意：
AuthSession支持通用 OAuth 和 OpenID Connect 基于浏览器的身份验证工作流。如果可用，我们建议使用你的身份提供商提供的库，因为它将处理特定于该提供商的实现细节。例如，使用@react-native-google-signin/google-signin进行 Google 身份验证，使用react-native-fbsdk-next进行 Facebook 身份验证。有关更多信息，请参阅 验证 概述。¥Note:
AuthSessionenables general-purpose OAuth and OpenID Connect browser-based auth workflows. Where available, we recommend using a library supplied by your identity provider, as it will handle implementation details specific to that provider. For example, use@react-native-google-signin/google-signinfor Google authentication andreact-native-fbsdk-nextfor Facebook. For more information, see Authentication overview.
安装
¥Installation
expo-crypto是对等依赖，必须与expo-auth-session一起安装。¥
expo-cryptois a peer dependency and must be installed alongsideexpo-auth-session.
- npx expo install expo-auth-session expo-cryptoIf you are installing this in an existing React Native app, start by installing expo in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.
Are you using this library in a bare React Native app?
使用 uri-scheme 命令行接口 轻松添加、删除、列出和打开你的 URI。
¥Use the uri-scheme CLI to easily add, remove, list, and open your URIs.
要使你的原生应用处理 mycoolredirect://，只需运行：
¥To make your native app handle mycoolredirect:// simply run:
- npx uri-scheme add mycoolredirect你现在应该能够通过运行以下命令来查看所有项目方案的列表：
¥You should now be able to see a list of all your project's schemes by running:
- npx uri-scheme list你可以测试它以确保它像这样工作：
¥You can test it to ensure it works like this:
# Rebuild the native apps, be sure to use an emulator- yarn android- yarn ios# Open a URI scheme- npx uri-scheme open mycoolredirect://some/redirect在独立应用中的使用
¥Usage in standalone apps
{
"expo": {
"scheme": "mycoolredirect"
}
}
为了能够深层链接回你的应用，你需要在项目 app.config.js 或 app.json 中设置 scheme，然后构建独立应用（无法通过更新进行更新）。如果你不包含方案，则身份验证流程将完成，但无法将信息传回你的应用，并且用户必须手动退出身份验证模式（导致事件取消）。
¥to be able to deep link back into your app, you will need to set a scheme in your project app.config.js, or app.json, and then build your standalone app (it can't be updated with an update). If you do not include a scheme, the authentication flow will complete, but it will be unable to pass the information back into your application and the user will have to manually exit the authentication modal (resulting in a canceled event).
指南
¥Guides
指南已移动：认证指南。
¥The guides have moved: Authentication Guide.
基于 Web 浏览器的身份验证流程如何工作
¥How web browser based authentication flows work
移动应用中基于浏览器的身份验证的典型流程如下：
¥The typical flow for browser-based authentication in mobile apps is as follows:
-
引发：用户按下登录按钮
¥Initiation: the user presses a sign in button
-
打开网络浏览器：该应用会打开一个 Web 浏览器，访问身份验证提供商登录页面。为登录页面打开的 URL 通常包含用于标识应用的信息以及成功时重定向到的 URL。注意：Web 浏览器应与你的系统 Web 浏览器共享 Cookie，以便用户在已在系统浏览器上进行身份验证的情况下无需再次登录 - Expo 的 WebBrowser API 负责处理此问题。
¥Open web browser: the app opens up a web browser to the authentication provider sign in page. The url that is opened for the sign in page usually includes information to identify the app, and a URL to redirect to on success. Note: the web browser should share cookies with your system web browser so that users do not need to sign in again if they are already authenticated on the system browser -- Expo's WebBrowser API takes care of this.
-
身份验证提供商重定向：身份验证成功后，身份验证提供程序应通过重定向到应用在登录页面 (详细了解链接在移动应用中的工作原理) 上的查询参数中提供的 URL 来重定向回应用，前提是该 URL 位于允许的重定向 URL 的白名单中。将重定向 URL 列入白名单对于防止恶意行为者冒充你的应用非常重要。重定向包括 URL 中的数据（例如用户 ID 和令牌）、位置哈希、查询参数或两者。
¥Authentication provider redirects: upon successful authentication, the authentication provider should redirect back to the application by redirecting to URL provided by the app in the query parameters on the sign in page (read more about how linking works in mobile apps), provided that the URL is in the allowlist of allowed redirect URLs. Allowlisting redirect URLs is important to prevent malicious actors from pretending to be your application. The redirect includes data in the URL (such as user id and token), either in the location hash, query parameters, or both.
-
应用处理重定向：重定向由应用处理，并从重定向 URL 解析数据。
¥App handles redirect: the redirect is handled by the app and data is parsed from the redirect URL.
安全考虑
¥Security considerations
-
切勿将任何密钥放入应用代码中，这样做没有安全的方法！相反，你应该将密钥存储在服务器上，并公开一个端点，该端点为你的客户端进行 API 调用并将数据传回。
¥Never put any secret keys inside your application code, there is no secure way to do this! Instead, you should store your secret key(s) on a server and expose an endpoint that makes API calls for your client and passes the data back.
API
import * as AuthSession from 'expo-auth-session';
Hooks
| Parameter | Type | Description |
|---|---|---|
| config | AuthRequestConfig | A valid |
| discovery | null | DiscoveryDocument | A loaded |
Load an authorization request for a code. When the prompt method completes then the response will be fulfilled.
In order to close the popup window on web, you need to invoke
WebBrowser.maybeCompleteAuthSession(). See the Identity example for more info.
If an Implicit grant flow was used, you can pass the response.params to TokenResponse.fromQueryParams()
to get a TokenResponse instance which you can use to easily refresh the token.
[AuthRequest | null, AuthSessionResult | null, (options: AuthRequestPromptOptions) => Promise<AuthSessionResult>]Returns a loaded request, a response, and a prompt method in a single array in the following order:
request- An instance ofAuthRequestthat can be used to prompt the user for authorization. This will benulluntil the auth request has finished loading.response- This isnulluntilpromptAsynchas been invoked. Once fulfilled it will return information about the authorization.promptAsync- When invoked, a web browser will open up and prompt the user for authentication. Accepts anAuthRequestPromptOptionsobject with options about how the prompt will execute.
Example
const [request, response, promptAsync] = useAuthRequest({ ... }, { ... });
| Parameter | Type |
|---|---|
| request | null | AuthRequest |
| discovery | null | DiscoveryDocument |
| customOptions(optional) | AuthRequestPromptOptions |
[AuthSessionResult | null, PromptMethod]| Parameter | Type | Description |
|---|---|---|
| issuerOrDiscovery | IssuerOrDiscovery | URL using the |
Given an OpenID Connect issuer URL, this will fetch and return the DiscoveryDocument
(a collection of URLs) from the resource provider.
DiscoveryDocument | nullReturns null until the DiscoveryDocument has been fetched from the provided issuer URL.
Example
const discovery = useAutoDiscovery('https://example.com/auth');
| Parameter | Type |
|---|---|
| config | AuthRequestConfig |
| discovery | null | DiscoveryDocument |
| AuthRequestInstance | AuthRequest |
AuthRequest | nullClasses
Type: Class extends TokenRequest<AccessTokenRequestConfig> implements AccessTokenRequestConfig
Access token request. Exchange an authorization code for a user access token.
AccessTokenRequest Properties
GrantTypeAccessTokenRequest Methods
Headers{
clientId: string,
clientSecret: undefined | string,
code: string,
extraParams: undefined | Record<string, string>,
grantType: GrantType,
redirectUri: string,
scopes: undefined | string[]
}Type: Class extends ResponseError
Represents an authorization response error: Section 5.2. Often times providers will fail to return the proper error message for a given error code. This error method will add the missing description for more context on what went wrong.
AuthError Properties
stringUsed to assist the client developer in understanding the error that occurred.
Type: Class implements Omit<AuthRequestConfig, 'state'>
Used to manage an authorization request according to the OAuth spec: Section 4.1.1. You can use this class directly for more info around the authorization.
Common use-cases:
- Parse a URL returned from the authorization server with
parseReturnUrlAsync(). - Get the built authorization URL with
makeAuthUrlAsync(). - Get a loaded JSON representation of the auth request with crypto state loaded with
getAuthRequestConfigAsync().
Example
// Create a request.
const request = new AuthRequest({ ... });
// Prompt for an auth code
const result = await request.promptAsync(discovery);
// Get the URL to invoke
const url = await request.makeAuthUrlAsync(discovery);
// Get the URL to invoke
const parsed = await request.parseReturnUrlAsync("<URL From Server>");
AuthRequest Properties
AuthRequest Methods
Load and return a valid auth request based on the input config.
Promise<AuthRequestConfig>| Parameter | Type |
|---|---|
| discovery | AuthDiscoveryDocument |
| promptOptions(optional) | AuthRequestPromptOptions |
Prompt a user to authorize for a code.
Promise<AuthSessionResult>Type: Class extends TokenRequest<RefreshTokenRequestConfig> implements RefreshTokenRequestConfig
Refresh request.
RefreshTokenRequest Properties
GrantTypeRefreshTokenRequest Methods
Headers{
clientId: string,
clientSecret: undefined | string,
extraParams: undefined | Record<string, string>,
grantType: GrantType,
refreshToken: undefined | string,
scopes: undefined | string[]
}Request Methods
Type: Class extends CodedError
ResponseError Properties
stringUsed to assist the client developer in understanding the error that occurred.
Type: Class extends Request<RevokeTokenRequestConfig, boolean> implements RevokeTokenRequestConfig
Revocation request for a given token.
RevokeTokenRequest Methods
Headers{
clientId: undefined | string,
clientSecret: undefined | string,
token: string,
tokenTypeHint: undefined | TokenTypeHint
}| Parameter | Type | Description |
|---|---|---|
| discovery | Pick<DiscoveryDocument, 'revocationEndpoint'> | The |
Perform a token revocation request.
Promise<boolean>Type: Class extends ResponseError
TokenError Properties
stringUsed to assist the client developer in understanding the error that occurred.
Type: Class extends Request<T, TokenResponse>
A generic token request.
TokenRequest Properties
GrantTypeTokenRequest Methods
HeadersType: Class implements TokenResponseConfig
Token Response.
TokenResponse Methods
| Parameter | Type |
|---|---|
| params | Record<string, any> |
Creates a TokenResponse from query parameters returned from an AuthRequest.
TokenResponseTokenResponseConfig| Parameter | Type |
|---|---|
| token | Pick<TokenResponse, 'expiresIn' | 'issuedAt'> |
| secondsMargin(optional) | number |
Determines whether a token refresh request must be made to refresh the tokens
boolean| Parameter | Type |
|---|---|
| config | Omit<TokenRequestConfig, 'refreshToken' | 'grantType'> |
| discovery | Pick<DiscoveryDocument, 'tokenEndpoint'> |
Promise<TokenResponse>Methods
| Parameter | Type | Description |
|---|---|---|
| config | AccessTokenRequestConfig | Configuration used to exchange the code for a token. |
| discovery | Pick<DiscoveryDocument, 'tokenEndpoint'> | The |
Exchange an authorization code for an access token that can be used to get data from the provider.
Promise<TokenResponse>Returns a discovery document with a valid tokenEndpoint URL.
| Parameter | Type | Description |
|---|---|---|
| issuer | string | An |
Fetch a DiscoveryDocument from a well-known resource provider that supports auto discovery.
Promise<DiscoveryDocument>Returns a discovery document that can be used for authentication.
| Parameter | Type | Description |
|---|---|---|
| config | Pick<TokenResponse, 'accessToken'> | The |
| discovery | Pick<DiscoveryDocument, 'userInfoEndpoint'> | The |
Returns the current time in seconds.
number| Parameter | Type |
|---|---|
| urlPath(optional) | string |
| options(optional) | Omit<CreateURLOptions, 'queryParams'> |
stringDeprecated Use
makeRedirectUri()instead.
| Parameter | Type |
|---|---|
| path(optional) | string |
Get the URL that your authentication provider needs to redirect to. For example: https://auth.expo.io/@your-username/your-app-slug. You can pass an additional path component to be appended to the default redirect URL.
Note This method will throw an exception if you're using the bare workflow on native.
stringExample
const url = AuthSession.getRedirectUrl('redirect');
// Managed: https://auth.expo.io/@your-username/your-app-slug/redirect
// Web: https://localhost:19006/redirect
| Parameter | Type |
|---|---|
| issuer | string |
Append the well known resources path and OpenID connect discovery document path to a URL https://tools.ietf.org/html/rfc5785
string| Parameter | Type | Description |
|---|---|---|
| config | AuthRequestConfig | A valid |
| issuerOrDiscovery | IssuerOrDiscovery | A loaded |
Build an AuthRequest and load it before returning.
Promise<AuthRequest>Returns an instance of AuthRequest that can be used to prompt the user for authorization.
| Parameter | Type | Description |
|---|---|---|
| options(optional) | AuthSessionRedirectUriOptions | Additional options for configuring the path. Default: {} |
Create a redirect url for the current platform and environment. You need to manually define the redirect that will be used in a bare workflow React Native app, or an Expo standalone app, this is because it cannot be inferred automatically.
- Web: Generates a path based on the current
window.location. For production web apps, you should hard code the URL as well. - Managed workflow: Uses the
schemeproperty of your app config. - Bare workflow: Will fallback to using the
nativeoption for bare workflow React Native apps.
stringThe redirectUri to use in an authentication request.
Example
const redirectUri = makeRedirectUri({
scheme: 'my-scheme',
path: 'redirect'
});
// Development Build: my-scheme://redirect
// Expo Go: exp://127.0.0.1:8081/--/redirect
// Web dev: https://localhost:19006/redirect
// Web prod: https://yourwebsite.com/redirect
const redirectUri2 = makeRedirectUri({
scheme: 'scheme2',
preferLocalhost: true,
isTripleSlashed: true,
});
// Development Build: scheme2:///
// Expo Go: exp://localhost:8081
// Web dev: https://localhost:19006
// Web prod: https://yourwebsite.com
| Parameter | Type | Description |
|---|---|---|
| config | RefreshTokenRequestConfig | Configuration used to refresh the given access token. |
| discovery | Pick<DiscoveryDocument, 'tokenEndpoint'> | The |
Refresh an access token.
- If the provider didn't return a
refresh_tokenthen the access token may not be refreshed. - If the provider didn't return a
expires_inthen it's assumed that the token does not expire. - Determine if a token needs to be refreshed via
TokenResponse.isTokenFresh()orshouldRefresh()on an instance ofTokenResponse.
Promise<TokenResponse>Returns a discovery document with a valid tokenEndpoint URL.
See: Section 6.
| Parameter | Type |
|---|---|
| issuerOrDiscovery | IssuerOrDiscovery |
Utility method for resolving the discovery document from an issuer or object.
Promise<DiscoveryDocument>| Parameter | Type | Description |
|---|---|---|
| config | RevokeTokenRequestConfig | Configuration used to revoke a refresh or access token. |
| discovery | Pick<DiscoveryDocument, 'revocationEndpoint'> | The |
Revoke a token with a provider. This makes the token unusable, effectively requiring the user to login again.
Promise<boolean>Returns a discovery document with a valid revocationEndpoint URL. Many providers do not support this feature.
Types
Config used to exchange an authorization code for an access token.
See: Section 4.1.3
Type: TokenRequestConfig extended by:
| Property | Type | Description |
|---|---|---|
| code | string | The authorization code received from the authorization server. |
| redirectUri | string | If the |
Type: Pick<DiscoveryDocument, 'authorizationEndpoint'>
Type: ResponseErrorConfig extended by:
| Property | Type | Description |
|---|---|---|
| state(optional) | string | Required only if state is used in the initial request |
Represents an OAuth authorization request as JSON.
| Property | Type | Description |
|---|---|---|
| clientId | string | A unique string representing the registration information provided by the client. The client identifier is not a secret; it is exposed to the resource owner and shouldn't be used alone for client authentication. The client identifier is unique to the authorization server. |
| clientSecret(optional) | string | Client secret supplied by an auth provider. There is no secure way to store this on the client. |
| codeChallenge(optional) | string | Derived from the code verifier by using the |
| codeChallengeMethod(optional) | CodeChallengeMethod | Method used to generate the code challenge. You should never use Default: CodeChallengeMethod.S256 |
| extraParams(optional) | Record<string, string> | Extra query params that'll be added to the query string. |
| prompt(optional) | Prompt | Prompt[] | Informs the server if the user should be prompted to login or consent again. This can be used to present a dialog for switching accounts after the user has already been logged in. |
| redirectUri | string | After completing an interaction with a resource owner the server will redirect to this URI. Learn more about linking in Expo. |
| responseType(optional) | ResponseType | string | |
| scopes(optional) | string[] | List of strings to request access to. |
| state(optional) | string | Used for protection against Cross-Site Request Forgery. |
| usePKCE(optional) | boolean | Should use Proof Key for Code Exchange. Default: true |
Options passed to the promptAsync() method of AuthRequests.
This can be used to configure how the web browser should look and behave.
Type: Omit<WebBrowserOpenOptions, 'windowFeatures'> extended by:
| Property | Type | Description |
|---|---|---|
| url(optional) | string | URL to open when prompting the user. This usually should be defined internally and left |
| windowFeatures(optional) | WebBrowserWindowFeatures | Only for: Web Features to use with |
Options passed to makeRedirectUri.
| Property | Type | Description |
|---|---|---|
| isTripleSlashed(optional) | boolean | Should the URI be triple slashed |
| native(optional) | string | Manual scheme to use in Bare and Standalone native app contexts. Takes precedence over all other properties.
You must define the URI scheme that will be used in a custom built native application or standalone Expo application.
The value should conform to your native app's URI schemes.
You can see conformance with |
| path(optional) | string | Optional path to append to a URI. This will not be added to |
| preferLocalhost(optional) | boolean | Attempt to convert the Expo server IP address to localhost. This is useful for testing when your IP changes often, this will only work for iOS simulator. Default: false |
| queryParams(optional) | Record<string, string | undefined> | Optional native scheme
URI protocol |
| scheme(optional) | string | URI protocol |
Object returned after an auth request has completed.
- If the user cancelled the authentication session by closing the browser, the result is
{ type: 'cancel' }. - If the authentication is dismissed manually with
AuthSession.dismiss(), the result is{ type: 'dismiss' }. - If the authentication flow is successful, the result is
{ type: 'success', params: Object, event: Object }. - If the authentication flow is returns an error, the result is
{ type: 'error', params: Object, error: string, event: Object }.
Type: object shaped as below:
| Property | Type | Description |
|---|---|---|
| type | 'cancel' | 'dismiss' | 'opened' | 'locked' | How the auth completed. |
Or object shaped as below:
| Property | Type | Description |
|---|---|---|
| authentication | TokenResponse | null | Returned when the auth finishes with an |
| error(optional) | AuthError | null | Possible error if the auth failed with type |
| errorCode | string | null |
|
| params | Record<string, string> | Query params from the |
| type | 'error' | 'success' | How the auth completed. |
| url | string | Auth URL that was opened |
| Property | Type | Description |
|---|---|---|
| authorizationEndpoint(optional) | string | Used to interact with the resource owner and obtain an authorization grant. |
| discoveryDocument(optional) | ProviderMetadata | All metadata about the provider. |
| endSessionEndpoint(optional) | string | URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. |
| registrationEndpoint(optional) | string | URL of the OP's Dynamic Client Registration Endpoint. |
| revocationEndpoint(optional) | string | Used to revoke a token (generally for signing out). The spec requires a revocation endpoint, but some providers (like Spotify) do not support one. |
| tokenEndpoint(optional) | string | Used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). |
| userInfoEndpoint(optional) | string | URL of the OP's UserInfo Endpoint used to return info about the authenticated user. |
Deprecated See Facebook authentication.
Type: ProviderAuthRequestConfig extended by:
| Property | Type | Description |
|---|---|---|
| androidClientId(optional) | string | Android native client ID for use in development builds and bare workflow. |
| iosClientId(optional) | string | iOS native client ID for use in development builds and bare workflow. |
| webClientId(optional) | string | Expo web client ID for use in the browser. |
| Property | Type | Description |
|---|---|---|
| body(optional) | Record<string, string> | - |
| dataType(optional) | string | - |
| headers(optional) | Headers | - |
| method(optional) | string | - |
Deprecated See Google authentication.
Type: ProviderAuthRequestConfig extended by:
| Property | Type | Description |
|---|---|---|
| androidClientId(optional) | string | Android native client ID for use in standalone, and bare workflow. |
| iosClientId(optional) | string | iOS native client ID for use in standalone, bare workflow, and custom clients. |
| language(optional) | string | Language code ISO 3166-1 alpha-2 region code, such as 'it' or 'pt-PT'. |
| loginHint(optional) | string | If the user's email address is known ahead of time, it can be supplied to be the default option. If the user has approved access for this app in the past then auth may return without any further interaction. |
| selectAccount(optional) | boolean | When Default: false. |
| shouldAutoExchangeCode(optional) | boolean | Should the hook automatically exchange the response code for an authentication token. Defaults to |
| webClientId(optional) | string | Expo web client ID for use in the browser. |
Type: Record<string, string> extended by:
| Property | Type | Description |
|---|---|---|
| Accept(optional) | string | - |
| Authorization(optional) | string | - |
| Content-Type | string | - |
URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier.
Type: string
Literal Type: multiple types
Acceptable values are: Issuer | DiscoveryDocument
| Parameter | Type |
|---|---|
| options(optional) | AuthRequestPromptOptions |
Type: AuthRequestConfig extended by:
| Property | Type | Description |
|---|---|---|
| language(optional) | string | Language for the sign in UI, in the form of ISO 639-1 language code optionally followed by a dash and ISO 3166-1 alpha-2 region code, such as 'it' or 'pt-PT'. Only set this value if it's different from the system default (which you can access via expo-localization). |
OpenID Providers have metadata describing their configuration. ProviderMetadata
Type: Record<string, string | boolean | string[]> ProviderMetadataEndpoints extended by:
| Property | Type | Description |
|---|---|---|
| backchannel_logout_session_supported(optional) | boolean | - |
| backchannel_logout_supported(optional) | boolean | - |
| check_session_iframe(optional) | string | - |
| claim_types_supported(optional) | string[] | a list of the Claim Types that the OpenID Provider supports. |
| claims_locales_supported(optional) | string[] | Languages and scripts supported for values in Claims being returned. |
| claims_parameter_supported(optional) | boolean | Boolean value specifying whether the OP supports use of the claims parameter, with Default: false |
| claims_supported(optional) | string[] | a list of the Claim Names of the Claims that the OpenID Provider may be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. |
| code_challenge_methods_supported(optional) | CodeChallengeMethod[] | - |
| display_values_supported(optional) | string[] | a list of the |
| frontchannel_logout_session_supported(optional) | boolean | - |
| frontchannel_logout_supported(optional) | boolean | - |
| grant_types_supported(optional) | string[] | JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. If omitted, the default value is ["authorization_code", "implicit"]. |
| id_token_signing_alg_values_supported(optional) | string[] | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. The algorithm RS256 MUST be included. |
| jwks_uri(optional) | string | URL of the OP's JSON Web Key Set JWK document. |
| op_policy_uri(optional) | string | URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP. The registration process SHOULD display this URL to the person registering the Client if it is given. |
| op_tos_uri(optional) | string | URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service. The registration process should display this URL to the person registering the Client if it is given. |
| request_parameter_supported(optional) | boolean | Boolean value specifying whether the OP supports use of the request parameter, with Default: false |
| request_uri_parameter_supported(optional) | boolean | Whether the OP supports use of the Default: true |
| require_request_uri_registration(optional) | boolean | Whether the OP requires any Default: false |
| response_modes_supported(optional) | string[] | JSON array containing a list of the OAuth 2.0 |
| response_types_supported(optional) | string[] | JSON array containing a list of the OAuth 2.0 |
| scopes_supported(optional) | string[] | JSON array containing a list of the OAuth 2.0 RFC6749 scope values that this server supports. |
| service_documentation(optional) | string | URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider. In particular, if the OpenID Provider does not support Dynamic Client Registration, then information on how to register Clients needs to be provided in this documentation. |
| subject_types_supported(optional) | string[] | JSON array containing a list of the Subject Identifier types that this OP supports.
Valid types include |
| token_endpoint_auth_methods_supported(optional) | ('client_secret_post' | 'client_secret_basic' | 'client_secret_jwt' | 'private_key_jwt' | string)[] | A list of Client authentication methods supported by this Token Endpoint.
If omitted, the default is |
| ui_locales_supported(optional) | string[] | Languages and scripts supported for the user interface, represented as a JSON array of BCP47 language tag values. |
| Property | Type | Description |
|---|---|---|
| authorization_endpoint | string | URL of the OP's OAuth 2.0 Authorization Endpoint. |
| device_authorization_endpoint(optional) | string | - |
| end_session_endpoint(optional) | string | - |
| introspection_endpoint(optional) | string | - |
| issuer(optional) | Issuer | - |
| registration_endpoint(optional) | string | - |
| revocation_endpoint(optional) | string | - |
| token_endpoint | string | URL of the OP's OAuth 2.0 Token Endpoint. This is required unless only the Implicit Flow is used. |
| userinfo_endpoint(optional) | string | URL of the OP's UserInfo Endpoint. |
Config used to request a token refresh, or code exchange.
See: Section 6
Type: TokenRequestConfig extended by:
| Property | Type | Description |
|---|---|---|
| refreshToken(optional) | string | The refresh token issued to the client. |
Server response error.
Type: Record<string, any> extended by:
| Property | Type | Description |
|---|---|---|
| error | string | Error code |
| error_description(optional) | string | Additional message |
| error_uri(optional) | string | URI for more info on the error |
Config used to revoke a token.
See: Section 2.1
Type: Partial<TokenRequestConfig> extended by:
| Property | Type | Description |
|---|---|---|
| token | string | The token that the client wants to get revoked. |
| tokenTypeHint(optional) | TokenTypeHint | A hint about the type of the token submitted for revocation. |
Object returned from the server after a token response.
| Property | Type | Description |
|---|---|---|
| access_token | string | - |
| expires_in(optional) | number | - |
| id_token(optional) | string | - |
| issued_at(optional) | number | - |
| refresh_token(optional) | string | - |
| scope(optional) | string | - |
| token_type(optional) | TokenType | - |
Config used to request a token refresh, revocation, or code exchange.
| Property | Type | Description |
|---|---|---|
| clientId | string | A unique string representing the registration information provided by the client. The client identifier is not a secret; it is exposed to the resource owner and shouldn't be used alone for client authentication. The client identifier is unique to the authorization server. |
| clientSecret(optional) | string | Client secret supplied by an auth provider. There is no secure way to store this on the client. |
| extraParams(optional) | Record<string, string> | Extra query params that'll be added to the query string. |
| scopes(optional) | string[] | List of strings to request access to. |
| Property | Type | Description |
|---|---|---|
| accessToken | string | The access token issued by the authorization server. |
| expiresIn(optional) | number | The lifetime in seconds of the access token. For example, the value If omitted, the authorization server should provide the expiration time via other means or document the default value. |
| idToken(optional) | string | ID Token value associated with the authenticated session. |
| issuedAt(optional) | number | Time in seconds when the token was received by the client. |
| refreshToken(optional) | string | The refresh token, which can be used to obtain new access tokens using the same authorization grant. |
| scope(optional) | string | The scope of the access token. Only required if it's different to the scope that was requested by the client. |
| state(optional) | string | Required if the "state" parameter was present in the client authorization request. The exact value received from the client. |
| tokenType(optional) | TokenType | The type of the token issued. Value is case insensitive. |
Enums
CodeChallengeMethod.Plain ＝ "plain"This should not be used. When used, the code verifier will be sent to the server as-is.
Grant type values used in dynamic client registration and auth requests.
See: Appendix A.10
GrantType.AuthorizationCode ＝ "authorization_code"Used for exchanging an authorization code for one or more tokens.
GrantType.ClientCredentials ＝ "client_credentials"Used for client credentials flow.
GrantType.RefreshToken ＝ "refresh_token"Used when exchanging a refresh token for a new token.
Informs the server if the user should be prompted to login or consent again. This can be used to present a dialog for switching accounts after the user has already been logged in. You should use this in favor of clearing cookies (which is mostly not possible on iOS).
See: Section 3.1.2.1.
Prompt.Consent ＝ "consent"Server should prompt the user for consent before returning information to the client.
If it cannot obtain consent, it must return an error, typically consent_required.
Prompt.Login ＝ "login"The server should prompt the user to reauthenticate.
If it cannot reauthenticate the End-User, it must return an error, typically login_required.
Prompt.None ＝ "none"Server must not display any auth or consent UI. Can be used to check for existing auth or consent.
An error is returned if a user isn't already authenticated or the client doesn't have pre-configured consent for the requested claims, or does not fulfill other conditions for processing the request.
The error code will typically be login_required, interaction_required, or another code defined in Section 3.1.2.6.
The client informs the authorization server of the desired grant type by using the response type.
See: Section 3.1.1.
ResponseType.IdToken ＝ "id_token"A custom registered type for getting an id_token from Google OAuth.
ResponseType.Token ＝ "token"For requesting an access token (implicit grant) as described by Section 4.2.1.
A hint about the type of the token submitted for revocation. If not included then the server should attempt to deduce the token type.
See: Section 2.1
高级用法
¥Advanced usage
过滤掉链接处理程序中的 AuthSession 事件
¥Filtering out AuthSession events in Linking handlers
你可能想要处理应用中的入站链接的原因有很多，例如推送通知或只是常规深度链接（你可以在 链接 中阅读有关此内容的更多信息）；身份验证重定向只是深层链接的一种类型，AuthSession 会为你处理这些特定链接。在你自己的 Linking.addEventListener 处理程序中，你可以通过检查 URL 是否包含 +expo-auth-session 字符串来过滤掉 AuthSession 处理的深层链接 - 如果包含，你可以忽略它。这是可行的，因为 AuthSession 将 +expo-auth-session 添加到默认的 returnUrl 中；但是，如果你提供自己的 returnUrl，你可能需要考虑添加类似的标识符，以便能够从其他处理程序中过滤掉 AuthSession 事件。
¥There are many reasons why you might want to handle inbound links into your app, such as push notifications or just regular deep linking (you can read more about this in the Linking); authentication redirects are only one type of deep link, and AuthSession handles these particular links for you. In your own Linking.addEventListener handlers, you can filter out deep links that are handled by AuthSession by checking if the URL includes the +expo-auth-session string -- if it does, you can ignore it. This works because AuthSession adds +expo-auth-session to the default returnUrl; however, if you provide your own returnUrl, you may want to consider adding a similar identifier to enable you to filter out AuthSession events from other handlers.
使用 React 导航
¥With React Navigation
如果你在 React Navigation 中使用深度链接，则通过 Linking.addEventListener 进行过滤是不够的，因为深度链接是 处理方式不同。相反，要过滤这些事件，请将自定义 getStateFromPath 函数添加到链接配置中，然后按照与上述相同的方式按 URL 进行过滤。
¥If you are using deep linking with React Navigation, filtering through Linking.addEventListener will not be sufficient because deep linking is handled differently. Instead, to filter these events, add a custom getStateFromPath function to your linking configuration, and then filter by URL in the same way as described above.