Skip to content

Commit f947b47

Browse files
committed
docs: update deviceCodeGrantRequest
1 parent 3af0ec3 commit f947b47

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/functions/deviceCodeGrantRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Performs a Device Authorization Grant request at the
1818
| `as` | [`AuthorizationServer`](../interfaces/AuthorizationServer.md) | Authorization Server Metadata. |
1919
| `client` | [`Client`](../interfaces/Client.md) | Client Metadata. |
2020
| `clientAuthentication` | [`ClientAuth`](../type-aliases/ClientAuth.md) | Client Authentication Method. |
21-
| `deviceCode` | `string` | Device Code. |
21+
| `deviceCode` | `string` | Device Code. This is the [`device_code`](../interfaces/DeviceAuthorizationResponse.md#device_code) retrieved from [processDeviceAuthorizationResponse](processDeviceAuthorizationResponse.md). |
2222
| `options`? | [`TokenEndpointRequestOptions`](../interfaces/TokenEndpointRequestOptions.md) | - |
2323

2424
## Returns

src/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5556,7 +5556,9 @@ export async function processDeviceAuthorizationResponse(
55565556
* @param as Authorization Server Metadata.
55575557
* @param client Client Metadata.
55585558
* @param clientAuthentication Client Authentication Method.
5559-
* @param deviceCode Device Code.
5559+
* @param deviceCode Device Code. This is the
5560+
* {@link DeviceAuthorizationResponse.device_code `device_code`} retrieved from
5561+
* {@link processDeviceAuthorizationResponse}.
55605562
*
55615563
* @group Device Authorization Grant
55625564
*

0 commit comments

Comments
 (0)