Skip to content

Commit b243355

Browse files
Claire update to edit headings and style
1 parent 539f7ca commit b243355

File tree

1 file changed

+20
-22
lines changed
  • src/content/docs/authenticate/device-authorization-flow

1 file changed

+20
-22
lines changed

src/content/docs/authenticate/device-authorization-flow/overview.mdx

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,18 @@ relatedArticles:
1010
- 28c6e830-8e82-4bf8-aab7-87ebafeb68e4
1111
---
1212

13-
Device Authorization Flow (RFC 8628) enables OAuth 2.0 authorization for devices with limited input capabilities, such as smart TVs, gaming consoles, or IoT devices. Users authenticate on a secondary device (like a phone or computer) while the primary device receives the access token.
13+
Kinde's device authorization flow adheres to `RFC 8628`, also known as the OAuth 2.0 Device Authorization Grant. It enables authorization for devices with limited input capabilities, such as smart TVs, gaming consoles, or IoT devices. Users authenticate on a secondary device (like a phone or computer) while the primary device receives the access token.
1414

15-
## How it works
15+
## How the device authentication flow works
1616

17-
The Device Authorization Flow follows these steps:
17+
1. **Device requests authorization**: The device requests a device code and user code from Kinde.
18+
2. **User authenticates**: The user visits a verification URI on another device and enters the user code.
19+
3. **Device polls for token**: The device polls the token endpoint until authorization is complete.
20+
4. **Access granted**: The device receives an access token and can call protected APIs.
1821

19-
1. **Device requests authorization**: The device requests a device code and user code from Kinde
20-
2. **User authenticates**: The user visits a verification URI on another device and enters the user code
21-
3. **Device polls for token**: The device polls the token endpoint until authorization is complete
22-
4. **Access granted**: The device receives an access token and can call protected APIs
22+
## Endpoints for the device authorization flow
2323

24-
## Endpoints
25-
26-
### Device Authorization Endpoint
24+
### Device authorization endpoint
2725

2826
**URL**: `https://<your-subdomain>.kinde.com/oauth2/device/auth`
2927

@@ -51,7 +49,7 @@ The Device Authorization Flow follows these steps:
5149
}
5250
```
5351

54-
### Token Endpoint
52+
### Token endpoint
5553

5654
**URL**: `https://<your-subdomain>.kinde.com/oauth2/token`
5755

@@ -89,11 +87,11 @@ The Device Authorization Flow follows these steps:
8987

9088
The device must poll the token endpoint at regular intervals until the user completes authentication:
9189

92-
- **Initial interval**: Use the `interval` value from the device authorization response (typically 5 seconds)
93-
- **Slow down**: If you receive a `slow_down` error, increase the polling interval by 5 seconds
94-
- **Maximum time**: Stop polling after the `expires_in` time (typically 30 minutes)
90+
- **Initial interval**: Use the `interval` value from the device authorization response (typically 5 seconds).
91+
- **Slow down**: If you receive a `slow_down` error, increase the polling interval by 5 seconds.
92+
- **Maximum time**: Stop polling after the `expires_in` time (typically 30 minutes).
9593

96-
## Error codes
94+
## Device authorization flow error codes
9795

9896
| Error Code | Description | Action |
9997
| ----------------------- | ------------------------------------ | ------------------------------ |
@@ -103,18 +101,18 @@ The device must poll the token endpoint at regular intervals until the user comp
103101
| `expired_token` | Device code has expired | Request a new device code |
104102
| `server_error` | Misconfigured device code | Request a new device code |
105103

106-
## Security considerations
104+
## Security considerations for device authorization
107105

108-
- **User code format**: User codes are formatted as `XXXXXXXX` for easy entry
109-
- **Verification URI**: Users should verify they're on the correct domain
110-
- **Token expiration**: Access tokens expire after 1 hour by default
106+
- **User code format**: User codes are formatted as `XXXXXXXX` for easy entry.
107+
- **Verification URI**: Users should verify they're on the correct domain.
108+
- **Token expiration**: Access tokens expire after 1 hour by default.
111109

112-
## Audience
110+
## Specifying an audience in a device authorization request
113111

114112
If an `audience` is specified in the request, the access token will include the audience in the `aud` claim. Kinde supports requesting multiple audiences.
115113

116-
The API must be authorized for the Device Authorization application.
114+
The API must be authorized for the device authorization application.
117115

118-
## Scopes and permissions
116+
## Scopes and permissions for a device authorization request
119117

120118
If an audience is specified in the request, any scopes which are belong to that audience that are granted to the user by their role will also be granted to the device. The list of scopes will be displayed on the consent screen. If the user consents, the scopes will be included in the `scope` claim of the access token.

0 commit comments

Comments
 (0)