--- title: Configuring React Native apps for the Device Authorization Grant description: Configure React Native apps to authenticate users with the OAuth 2.0 Device Authorization Grant using the OidcDeviceClient low-level API or the DeviceAuthGrantProvider and useDeviceAuthGrant hook component: orchsdks page_id: orchsdks:oidc:use-cases/device-authorization-grant/react-native canonical_url: https://developer.pingidentity.com/orchsdks/oidc/use-cases/device-authorization-grant/react-native.html llms_txt: https://developer.pingidentity.com/orchsdks/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md revdate: Tue, 23 Sep 2026 00:00:00 +0000 keywords: ["OAuth 2.0", "OpenID Connect", "Device Authorization Grant", "RFC 8628", "SDK", "React Native"] section_ids: configuring_a_react_native_app_as_the_requesting_device: Configuring a React Native app as the requesting device rn_device_server_config: Before you begin rn_device_modules: Step 1. Installing modules rn_device_configure_client: Step 2. Creating the device client specifying_the_device_authorization_endpoint_for_advanced_identity_cloud_and_pingam: Specifying the device authorization endpoint for Advanced Identity Cloud and PingAM rn_device_start_flow: Step 3. Starting the flow rn_device_poll: Step 4. Polling for success rn_device_errors: Step 5. Handling errors using_the_high_level_api_with_deviceauthgrantprovider: Using the high-level API with DeviceAuthGrantProvider example_a_complete_device_authorization_screen: "Example: a complete device authorization screen" configuring_a_react_native_app_as_the_approving_device: Configuring a React Native app as the approving device approving_a_device_authorization_flow_natively: Approving a device authorization flow natively approving_a_device_authorization_flow_in_app_using_the_browser: Approving a device authorization flow in-app using the browser getting_the_verificationuricomplete_value: Getting the verificationUriComplete value learn_more: Learn more --- # Configuring React Native apps for the Device Authorization Grant [icon: circle-check, set=far]PingOne [icon: circle-check, set=far]PingOne Advanced Identity Cloud [icon: circle-check, set=far]PingAM [icon: react, set=fab]React Native You can configure React Native apps built with the Orchestration SDK to authenticate users using the [OAuth 2.0 Device Authorization Grant (RFC 8628)](https://datatracker.ietf.org/doc/html/rfc8628). This is suitable for devices with limited input capabilities, such as smart TVs, kiosks, or IoT devices. The requesting app starts an authorization request, displays a short code and URL to the user, and polls in the background while the user authenticates on a separate browser-capable device. The Orchestration SDK for React Native provides two ways to implement the flow: * A low-level API, using `createOidcDeviceClient()` and the `OidcDeviceClient` it returns, which gives you direct control over the status stream and token handling. * A high-level API, using the `DeviceAuthGrantProvider` component and the `useDeviceAuthGrant()` hook, which manages polling state, saved tokens, and user info for you. Use the low-level API when you need full control over the flow and your own state management. Use the high-level API for most apps, because it handles the lifecycle, token persistence, and user info retrieval on your behalf. This page shows both approaches as the requesting device, and then how to use a React Native app as the approving device. ## Configuring a React Native app as the requesting device To configure a React Native app as the requesting device in the Device Authorization Grant flow, complete each of the following steps: * [Before you begin](#rn_device_server_config) * [Step 1. Installing modules](#rn_device_modules) * [Step 2. Creating the device client](#rn_device_configure_client) * [Step 3. Starting the flow](#rn_device_start_flow) * [Step 4. Polling for success](#rn_device_poll) * [Step 5. Handling errors](#rn_device_errors) ## Before you begin You need to prepare your authorization server to support the Device Authorization Grant. Select your server from the options below and complete the tasks before proceeding to configure your application. * PingOne * Advanced Identity Cloud * PingAM This tutorial requires you to configure your PingOne server as follows: > **Collapse: Task 1. Create a demo user** > > The samples and tutorials in this documentation often require that you have an identity set up so that you can test authentication. > > To create a demo user in PingOne, follow these steps: > > 1. Log in to your PingOne administration console. > > 2. In the left panel, navigate to Directory > Users. > > 3. Next to the Users label, click the plus icon ([icon: plus, set=fa]). > > PingOne displays the Add User panel. > > 4. Enter the following details: > > * **Given Name** = `Demo` > > * **Family Name** = `User` > > * **Username** = `demo` > > * **Email** = `demo.user@example.com` > > * **Population** = `Default` > > * **Password** = `Ch4ng3it!` > > 5. Click Save. > **Collapse: Task 2. Register a public OAuth 2.0 client with device authorization enabled** > > To register a *public* OAuth 2.0 client application in PingOne for use with the Orchestration SDKs for Android and iOS, follow these steps: > > 1. Log in to your PingOne administration console. > > 2. In the left panel, navigate to Applications > Applications. > > 3. Next to the Applications label, click the plus icon ([icon: plus, set=fa]). > > PingOne displays the Add Application panel. > > 4. In Application Name, enter a name for the profile, for example `sdkNativeClient` > > 5. Select Native as the Application Type, and then click Save. > > 6. On the Configuration tab, click the pencil icon ([icon: pencil, set=fa]). > > 1. In Grant Type, select the following values: > > `Authorization Code` > > `Refresh Token` > > `Device Authorization` > > 2. In Redirect URIs, enter the following values: > > `org.forgerock.oidc://oauth2redirect` > > 3. In Token Endpoint Authentication Method, select `None`. > > 4. Click Save. > > 7. On the Resources tab, next to Allowed Scopes, click the pencil icon ([icon: pencil, set=fa]). > > 1. In Scopes, select the following values: > > `email` > > `phone` > > `profile` > > | | | > | - | ------------------------------------------ | > | | The `openid` scope is selected by default. | > > 8. Optionally, on the Policies tab, click the pencil icon ([icon: pencil, set=fa]) to select the authentication policies for the application. > > | | | > | - | -------------------------------------------------------------------------------------------------------------------------------------- | > | | Applications that have no authentication policy assignments use the environment's default authentication policy to authenticate users. | > > If you have a DaVinci license, you can select PingOne policies or DaVinci Flow policies, but not both. If you do not have a DaVinci license, the page only displays PingOne policies. > > To use a *PingOne policy*: > > 1. Click [icon: plus, set=fa]Add policies and then select the policies that you want to apply to the application. > > 2. Click Save. > > PingOne applies the policies in the order in which they appear in the list. PingOne evaluates the first policy in the list first. If the requirements are not met, PingOne moves to the next one. > > For more information, see [Authentication policies for applications](https://docs.pingidentity.com/pingone/applications/p1_auth_policies_for_applications.html). > > To use a *DaVinci Flow policy*: > > 1. You must clear all PingOne policies. Click Deselect all PingOne Policies. > > 2. In the confirmation message, click Continue. > > 3. On the DaVinci Policies tab, select the policies that you want to apply to the application. > > 4. Click Save. > > PingOne applies the first policy in the list. > > 9. Click Save. > > 10. Enable the OAuth 2.0 client application by using the toggle next to its name: > > ![Enable the application using the toggle.](../../../_images/pingone-apps-enable-native-client-en.png)Figure 1. Enable the application using the toggle. > > The application is now configured to accept client connections from and issue OAuth 2.0 tokens to the Android and iOS PingOne example applications and tutorials covered by this documentation. This tutorial requires you to configure your PingOne Advanced Identity Cloud tenant as follows: > **Collapse: Task 1. Create a demo user** > > The samples and tutorials in this documentation often require that you have an identity set up so that you can test authentication. > > To create a demo user in PingOne Advanced Identity Cloud, follow these steps: > > 1. Log in to your PingOne Advanced Identity Cloud tenant. > > 2. In the left panel, click Identities > Manage. > > 3. Click [icon: plus, set=fa]New Alpha realm - User. > > 4. Enter the following details: > > * **Username** = `demo` > > * **First Name** = `Demo` > > * **Last Name** = `User` > > * **Email Address** = `demo.user@example.com` > > * **Password** = `Ch4ng3it!` > > 5. Click Save. > **Collapse: Task 2. Register a public OAuth 2.0 client with device authorization enabled** > > Public clients do not use a client secret to obtain tokens because they are unable to keep them hidden. The Orchestration SDKs commonly use this type of client to obtain tokens, as they cannot guarantee safekeeping of the client credentials in a browser or on a mobile device. > > To register a *public* OAuth 2.0 client application for use with the SDKs in PingOne Advanced Identity Cloud, follow these steps: > > 1. Log in to your PingOne Advanced Identity Cloud tenant. > > 2. In the left panel, click Applications. > > 3. Click [icon: plus, set=fa]Custom Application. > > 4. Select OIDC - OpenId Connect as the sign-in method, and then click Next. > > 5. Select Native / SPA as the application type, and then click Next. > > 6. In Name, enter a name for the application, such as `Public SDK Client`. > > 7. In Owners, select a user that is responsible for maintaining the application, and then click Next. > > | | | > | - | ---------------------------------------------------------------------------------- | > | | When trying out the SDKs, you could select the `demo` user you created previously. | > > 8. In Client ID, enter `sdkPublicClient` > > 9. Select **Configure for SDK Sample Apps**. > > 10. Click Create Application. > > PingOne Advanced Identity Cloud creates the application and displays the details screen. > > 11. On the Sign On tab: > > 1. In Sign-In URLs, ensure the following values appear, or add them if they don't: > > `org.forgerock.oidc://oauth2redirect` > > | | | > | - | ----------------------------------------------------------- | > | | Also add any other domains where you host SDK applications. | > > 2. In Grant Types, ensure the following values appear: > > `Authorization Code` > > `Refresh Token` > > `Device Code` > > 3. In Scopes, ensure the following values appear: > > `openid profile email address` > > 12. Click Show advanced settings, and on the Authentication tab, confirm the following properties: > > 1. In Token Endpoint Authentication Method, select `none`. > > 2. In Client Type, select `Public`. > > 3. Enable the Implied Consent property. > > 13. Click Save. > > The application is now configured to accept client connections from and issue OAuth 2.0 tokens to the example applications and tutorials covered by this documentation. > **Collapse: Task 3. Configure the OAuth 2.0 provider** > > The provider specifies the supported OAuth 2.0 configuration options for a realm. > > To ensure the PingOne Advanced Identity Cloud OAuth 2.0 provider service is configured for use with the Orchestration SDKs, follow these steps: > > 1. In your PingOne Advanced Identity Cloud tenant, navigate to Native Consoles > Access Management. > > 2. In the left panel, click [icon: plug, set=fa]Services. > > 3. In the list of services, click OAuth2 Provider. > > 4. On the Core tab, ensure Issue Refresh Tokens is enabled. > > 5. On the Consent tab, ensure Allow Clients to Skip Consent is enabled. > > 6. Click Save Changes. This tutorial requires you to configure your PingAM server as follows: > **Collapse: Task 1. Create a demo user** > > The samples and tutorials in this documentation often require that you have an identity set up so that you can test authentication. > > To create a demo user in PingAM, follow these steps: > > 1. Log in to the PingAM admin UI as an administrator. > > 2. Navigate to [icon: address-card, set=fa]Identities, and then click [icon: plus, set=fa]Add Identity. > > 3. Enter the following details: > > * **User ID** = `demo` > > * **Password** = `Ch4ng3it!` > > * **Email Address** = `demo.user@example.com` > > 4. Click Create. > **Collapse: Task 2. Register a public OAuth 2.0 client with device authorization enabled** > > Public clients do not use a client secret to obtain tokens because they are unable to keep them hidden. The Orchestration SDKs commonly use this type of client to obtain tokens, as they cannot guarantee safekeeping of the client credentials in a browser or on a mobile device. > > To register a *public* OAuth 2.0 client application for use with the SDKs in AM, follow these steps: > > 1. Log in to the PingAM admin UI as an administrator. > > 2. Navigate to [icon: list-alt, set=fa]Applications > OAuth 2.0 > Clients, and then click [icon: plus, set=fa]Add Client. > > 3. In Client ID, enter `sdkPublicClient`. > > 4. Leave Client secret empty. > > 5. In Redirection URIs, enter the following values: > > `org.forgerock.oidc://oauth2redirect` > > | | | > | - | ---------------------------------------------------------------------- | > | | Also add any other domains where you will be hosting SDK applications. | > > 6. In Scopes, enter the following values: > > `openid profile email address` > > 7. Click Create. > > PingAM creates the new OAuth 2.0 client, and displays the properties for further configuration. > > 8. On the Core tab: > > 1. In Client type, select `Public`. > > 2. Disable Allow wildcard ports in redirect URIs. > > 3. Click Save Changes. > > 9. On the Advanced tab: > > 1. In Grant Types, enter the following values: > > ```none > Authorization Code > Refresh Token > ``` > > ```none > Device Code > ``` > > 2. In Token Endpoint Authentication Method, select `None`. > > 3. Enable the Implied consent property. > > 10. Click Save Changes. > **Collapse: Task 3. Configure the OAuth 2.0 provider** > > The provider specifies the supported OAuth 2.0 configuration options for a realm. > > To ensure the PingAM OAuth 2.0 provider service is configured for use with the Orchestration SDKs, follow these steps: > > 1. Log in to the PingAM admin UI as an administrator. > > 2. In the left panel, click [icon: plug, set=fa]Services. > > 3. In the list of services, click OAuth2 Provider. > > 4. On the Core tab, ensure Issue Refresh Tokens is enabled. > > 5. On the Consent tab, ensure Allow Clients to Skip Consent is enabled. > > 6. Click Save Changes. ## Step 1. Installing modules Install the **OIDC** module for React Native, and its dependency, the **Core** module: * yarn * npm ```shell yarn add @ping-identity/rn-core yarn add @ping-identity/rn-oidc ``` ```shell npm install @ping-identity/rn-core npm install @ping-identity/rn-oidc ``` After installation, run `pod install` in your `ios/` directory to link the native dependencies on iOS: ```shell cd ios && pod install ``` ## Step 2. Creating the device client Use `createOidcDeviceClient()` to configure the connection to your authorization server. The configuration is similar to `createOidcClient()`, but the flow does not redirect back to your app. Required parameters to configure the device client (PingOne example) ```typescript import { createOidcDeviceClient } from '@ping-identity/rn-oidc'; const deviceClient = createOidcDeviceClient({ clientId: '6c7eb89a-66e9-ab12-cd34-eeaf795650b2', discoveryEndpoint: 'https://auth.pingone.com/3072206d-c6ce-ch15-m0nd-f87e972c7cc3/as/.well-known/openid-configuration', redirectUri: 'org.forgerock.oidc://oauth2redirect', scopes: ['openid', 'email', 'address', 'profile'], }); ``` Update the following properties with values that match your environment: * *clientId* The client ID from your OAuth 2.0 application. For example, `6c7eb89a-66e9-ab12-cd34-eeaf795650b2` * *discoveryEndpoint* The `.well-known` endpoint from your OAuth 2.0 application. > **Collapse: How do I find my PingOne .well-known URL?** > > To find the `.well-known` endpoint for an OAuth 2.0 client in PingOne: > > 1. Log in to your PingOne administration console. > > 2. Go to **Applications > Applications**, and then select your OAuth 2.0 client. > > For example, sdkPublicClient. > > 3. On the **Overview** tab, expand the **Connection Details** section, and then copy the **OIDC Discovery Endpoint** value. > > ![Locating the .well-known URL in a PingOne client profile.](../../../_images/p1-client-well-known.png) > **Collapse: How do I find my PingOne Advanced Identity Cloud URL?** > > You can view the `.well-known` endpoint for an OAuth 2.0 client in the PingOne Advanced Identity Cloud admin console: > > 1. Log in to your PingOne Advanced Identity Cloud administration console. > > 2. Click Applications, and then select the OAuth 2.0 client you created earlier. For example, sdkPublicClient. > > 3. On the Sign On tab, in the Client Credentials section, copy the Discovery URI value. > > For example, `https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/alpha/.well-known/openid-configuration` > > | | | > | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | | If you are using a custom domain, your `.well-known` is formed as follows:`https:///.well-known/openid-configuration`Learn more in [Access OIDC configuration discovery endpoint](https://docs.pingidentity.com/pingoneaic/latest/realms/custom-domains.html#access-oidc-configuration-discovery-endpoint). | > **Collapse: How do I find my PingAM URL?** > > To form the `.well-known` URL for an PingAM server, concatenate the following information into a single URL: > > 1. The base URL of the PingAM component of your deployment, including the port number and deployment path. > > For example, `https://openam.example.com:8443/openam` > > 2. The string `/oauth2` > > 3. The hierarchy of the realm that contains the OAuth 2.0 client. > > You must specify the entire hierarchy of the realm, starting at the Top Level Realm. Prefix each realm in the hierarchy with the `realms/` keyword. > > For example, `/realms/root/realms/customers` > > | | | > | - | ------------------------------------------------------------------------------- | > | | If you omit the realm hierarchy, the top level `ROOT` realm is used by default. | > > 4. The string `/.well-known/openid-configuration` > > For example, `https://openam.example.com:8443/openam/oauth2/realms/root/.well-known/openid-configuration` For example, `https://auth.pingone.com/3072206d-c6ce-ch15-m0nd-f87e972c7cc3/as/.well-known/openid-configuration` * *redirectUri* The redirect URI as configured in the OAuth 2.0 client profile. The Device Authorization Grant does not redirect back to your app, so the custom scheme setup in [Configuring React Native apps for OIDC sign-on](../../usage/react-native-centralized-login.html) (intent filter and URL type) is not needed for this use case. The Orchestration SDK still passes the value to the browser session when the app opens the verification URL in-app, so it must match a value registered in your OAuth 2.0 client. For example, `org.forgerock.oidc://oauth2redirect` * *scopes* The scopes you added to your OAuth 2.0 application. For example, `'openid', 'email', 'address', 'profile'` ### Specifying the device authorization endpoint for Advanced Identity Cloud and PingAM If you are using the device authorization flow with an Advanced Identity Cloud tenant or PingAM server you must also add the device authorization endpoint in the configuration, as it is not present in the data returned by the `.well-known` endpoint. Provide an ***openId*** object containing a ***deviceAuthorizationEndpoint*** value: Adding the device authorization endpoint to the device client config (PingOne Advanced Identity Cloud example) ```typescript const deviceClient = createOidcDeviceClient({ clientId: 'sdkPublicClient', discoveryEndpoint: 'https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/realms/alpha/.well-known/openid-configuration', scopes: ['openid', 'email', 'address', 'profile'], openId: { deviceAuthorizationEndpoint: 'https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/realms/root/realms/alpha/device/code', }, }); ``` Learn more about the [/oauth2/device/code](https://docs.pingidentity.com/pingoneaic/am-oauth2/rest-api-oauth2-device-code.html) endpoint in the Advanced Identity Cloud documentation. ## Step 3. Starting the flow Call `authorize()` on the device client to start the flow. Pass a callback function that receives an `OidcDeviceFlowStatus` object at each stage of the authorization process. The `authorize()` method returns a promise that resolves to a `stop()` function. Call `stop()` to cancel the flow and stop polling. | | | | - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Only a single flow can run on a client at a time. Calling `authorize()` while a flow is already active returns a `state_error` of "already active".Call `stop()` to clear any existing flow, or wait until the flow reaches one of the terminal status types, such as `success`. | The first stage to handle is `started`. This status contains an `OidcDeviceAuthorizationResponse` object with the values you need to present to the user, so that they can authenticate on a different device. Handle the started status to display the values from the server ```typescript const stop = await deviceClient.authorize((status) => { if (status.type === 'started') { const userCode = status.response.userCode; const verificationUri = status.response.verificationUri; const verificationUriComplete = status.response.verificationUriComplete; // Display userCode and verificationUri in your UI. // Optionally, generate a QR code from verificationUriComplete. } }); ``` The response object contains the following properties: * `deviceCode` The device code used internally for polling. You do not need to use this value directly. * `userCode` The short human-readable code the user enters on the approving device. * `verificationUri` The URL the user navigates to on the approving device to authorize the request. * `verificationUriComplete` An optional URL with the `userCode` already embedded as a query parameter. Use this to generate a QR code: when the user scans it, the authorization server's page opens with the code pre-filled, so the user does not need to type it manually. * `expiresIn` The number of seconds until the device code expires. * `interval` The minimum number of seconds the Orchestration SDK waits between polling requests. | | | | - | ------------------------------------------------------------------------------------------------------------------------------- | | | Rendering the QR code or any specific UI is the responsibility of your app.The Orchestration SDK only provides the data values. | ## Step 4. Polling for success After emitting `started`, the Orchestration SDK automatically begins polling the server's token endpoint. You do not need to manage the polling loop yourself. The two events to handle when polling are as follows: * `polling` Emitted after each poll while the user has not yet approved the request. Use this to update a progress indicator if needed. The status includes `pollCount`, `pollInterval`, and `nextPollAt` values. * `success` Emitted after the user approves the request and the server returns a token. The Orchestration SDK automatically saves the tokens in the configured storage solution. After `success`, call `deviceClient.user()` to get a user object with methods for retrieving and managing the tokens. Add polling and success cases ```typescript const stop = await deviceClient.authorize((status) => { switch (status.type) { case 'started': // Display codes break; case 'polling': // Optional: update a progress indicator // status.pollCount, status.pollInterval, status.nextPollAt break; case 'success': // Authentication complete — tokens saved! break; } }); ``` After authenticating, use the user object to access the tokens and user information: Accessing tokens and user info after success ```typescript const user = await deviceClient.user(); if (user) { const tokens = await user.token(); // Access, ID, and refresh tokens const profile = await user.userinfo(); // Claims from the userinfo endpoint } ``` The user object exposes the following methods: * `token()` Returns the saved token set, including the access token, ID token, and refresh token. * `refresh()` Requests new tokens using the refresh token. * `userinfo(cache?)` Returns claims from the userinfo endpoint. Pass `false` to bypass the cached result. * `revoke()` Revokes the access token. * `logout()` Ends the user's session. When you have finished with the device client, call `deviceClient.dispose()` to release it and cancel any active flow. ## Step 5. Handling errors The Orchestration SDK emits three terminal error statuses you should check for: * `expired` The device code expired before the user approved the request. Restart the flow to obtain a new device code. * `accessDenied` The user explicitly denied the authorization request. * `failure` An unrecoverable error occurred. The `error` property contains the cause, with `message`, and optionally `code` and `status` values. Complete flow handler with all cases ```typescript const stop = await deviceClient.authorize((status) => { switch (status.type) { case 'started': // Display codes break; case 'polling': // Optional: update a progress indicator break; case 'success': // Authentication complete — tokens saved! break; case 'expired': // The device code has expired — restart the flow break; case 'accessDenied': // The user denied the request break; case 'failure': // Handle unexpected errors: status.error.message break; } }); ``` ## Using the high-level API with DeviceAuthGrantProvider The `DeviceAuthGrantProvider` component and `useDeviceAuthGrant()` hook wrap the device client in React state, so you do not need to manage the status stream or token persistence yourself: Wrap your app or screen in the provider ```typescript import { DeviceAuthGrantProvider } from '@ping-identity/rn-oidc'; function App() { return ( ); } ``` Inside the provider, call `useDeviceAuthGrant()` with no arguments to access the shared state and actions: Consuming the device authorization state and actions ```typescript import { useDeviceAuthGrant } from '@ping-identity/rn-oidc'; function DeviceAuthorizationScreen() { const [ { status, authorizationResponse, isFlowActive, isLoading, isAuthenticated }, actions, ] = useDeviceAuthGrant(); // Render your UI from status and authorizationResponse, // and call actions such as authorize() from your event handlers. } ``` The hook returns a `[state, actions]` tuple. Learn about the state properties and actions available on the tuple in the tabs below: * `state` * `actions` **State properties returned by useDeviceAuthGrant()** | Property | Description | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `status` | The latest `OidcDeviceFlowStatus`, or `null` before the flow starts. | | `authorizationResponse` | The `OidcDeviceAuthorizationResponse` from the `started` status, containing `userCode`, `verificationUri`, and `verificationUriComplete`, or `null`. | | `isLoading` | `true` while an action, such as `authorize()`, is running. | | `isRestoring` | `true` while the provider restores any previously saved user on mount. | | `isFlowActive` | `true` while a device authorization flow is in progress. | | `isAuthenticated` | `true` when a valid user has been restored or a flow has completed successfully. | | `user` | The authenticated user object, or `null`. | | `tokens` | The saved token set, or `null`. | | `userInfo` | Claims from the userinfo endpoint, or `null`. | | `error` | The most recent error, or `null`. | **Actions returned by useDeviceAuthGrant()** | Action | Description | | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `restore()` | Restores any previously saved user from storage. The provider calls this automatically on mount. | | `authorize()` | Starts the device authorization flow. Concurrent calls are ignored while a flow is active. | | `cancel()` | Cancels the active flow and stops polling. | | `openVerificationUrl(verificationUri?)` | Opens the verification URL in the system browser on the current device.If you omit the argument:- The Orchestration SDK uses `verificationUriComplete` from the last `started` status, falling back to `verificationUri`. - If the `started` status does not yet exist, calling `openVerificationUrl` without an argument throws `argument_error`, and the URI falls back to `''`. You should only call `verificationUriComplete` after the `status` state returns `started`.The returned promise resolves with the browser result; for example, `success` or `cancel` when the user dismisses the browser.Polling continues independently while the browser is open. | | `token()` | Returns the saved token set, or `null`. | | `refresh()` | Requests new tokens using the refresh token. | | `userinfo(cache?)` | Returns claims from the userinfo endpoint. Pass `false` to bypass the cached value. | | `revoke()` | Revokes the access token. | | `logout()` | Revokes tokens and ends the session. | | `clear()` | Resets the transient state, including the status, authorization response, tokens, user info, and error, without affecting the authenticated user. | | `dispose()` | Cancels any active flow and releases the client. | ### Example: a complete device authorization screen The following example combines the provider and hook to render the user code, open the verification URL, and handle every status the flow can emit: Complete device authorization screen ```typescript import React, { useEffect } from 'react'; import { ActivityIndicator, Button, Text, View } from 'react-native'; import { useDeviceAuthGrant } from '@ping-identity/rn-oidc'; function DeviceAuthorizationScreen() { const [ { status, authorizationResponse, isFlowActive, isAuthenticated, error }, actions, ] = useDeviceAuthGrant(); useEffect(() => { if (isAuthenticated) { // The user approved the request — navigate to your signed-in UI. } }, [isAuthenticated]); if (status?.type === 'success' \|\| isAuthenticated) { return Authorization successful; } if (status?.type === 'expired') { return ( The code has expired. Please start again.