Merge pull request #388 from DuendeSoftware/joe/polling-intervals

Update reference docs regarding polling intervals
DuendeSoftware · Jan 5, 2024 · a475647 · a475647
2 parents 57343bb + 4a06243
commit a475647
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 15 deletions.
diff --git a/IdentityServer/v6/docs/content/reference/models/client.md b/IdentityServer/v6/docs/content/reference/models/client.md
@@ -261,7 +261,14 @@ Consent screen specific settings.
 
     URI to client logo.
 
-## Device flow
+## Cross Device Flows
+Settings used in the CIBA and OAuth device flows.
+
+* ***PollingInterval***
+
+    Maximum polling interval for the client in cross device flows. If the client polls more frequently than the polling interval during those flows, it will receive a *slow_down* error response. Defaults to *null*, which means the throttling will use the global default appropriate for the flow (*IdentityServerOptions.Ciba.DefaultPollingInterval* or *IdentityServerOptions.DeviceFlow.Interval*).
+
+#### Device Flow
 Device flow specific settings.
 
 * ***UserCodeType***
@@ -272,17 +279,13 @@ Device flow specific settings.
 
     Lifetime to device code in seconds (defaults to 300 seconds / 5 minutes)
 
-## CIBA
+#### CIBA
 Client initiated backchannel authentication specific settings.
 
 * ***CibaLifetime***
 
     Specifies the backchannel authentication request lifetime in seconds. Defaults to *null*.
 
-* ***PollingInterval***
-
-    Backchannel polling interval in seconds. Defaults to *null*.
-
 ## DPoP
 Added in 6.3.0.
 

diff --git a/IdentityServer/v6/docs/content/reference/options.md b/IdentityServer/v6/docs/content/reference/options.md
@@ -567,7 +567,7 @@ OAuth device flow settings. Available on the *DeviceFlow* property of the *Ident
 
 * ***Interval***
 
-    Defines the minimum allowed polling interval on the token endpoint. Defaults to *5*.
+    The maximum frequency in seconds that a client may poll the token endpoint in the device flow. Defaults to *5*.
 
 ## Mutual TLS
 [Mutual TLS]({{< ref "/tokens/authentication/mtls" >}}) settings. Available on the *MutualTls* property of the *IdentityServerOptions* object.
@@ -640,7 +640,7 @@ Settings for [dynamic providers]({{< ref "/ui/login/dynamicproviders">}}). Avail
 
 * ***DefaultPollingInterval***
 
-    The polling interval in seconds that a client is to use when connecting to the token endpoint. Defaults to 5.
+    The maximum frequency in seconds that a client may poll the token endpoint in the CIBA flow. Defaults to 5.
 
 ## Server-side Sessions 
 Settings for [server-side sessions]({{<ref "/ui/server_side_sessions">}}). Added in 6.1.  Available on the *ServerSideSessions* property of the *IdentityServerOptions* object.

diff --git a/IdentityServer/v7/docs/content/reference/models/client.md b/IdentityServer/v7/docs/content/reference/models/client.md
@@ -261,7 +261,14 @@ Consent screen specific settings.
 
     URI to client logo.
 
-## Device flow
+## Cross Device Flows
+Settings used in the CIBA and OAuth device flows.
+
+* ***PollingInterval***
+
+    Maximum polling interval for the client in cross device flows. If the client polls more frequently than the polling interval during those flows, it will receive a *slow_down* error response. Defaults to *null*, which means the throttling will use the global default appropriate for the flow (*IdentityServerOptions.Ciba.DefaultPollingInterval* or *IdentityServerOptions.DeviceFlow.Interval*).
+
+#### Device Flow
 Device flow specific settings.
 
 * ***UserCodeType***
@@ -272,16 +279,13 @@ Device flow specific settings.
 
     Lifetime to device code in seconds (defaults to 300 seconds / 5 minutes)
 
-## CIBA
+#### CIBA
 Client initiated backchannel authentication specific settings.
 
 * ***CibaLifetime***
 
     Specifies the backchannel authentication request lifetime in seconds. Defaults to *null*.
 
-* ***PollingInterval***
-
-    Backchannel polling interval in seconds. Defaults to *null*.
 
 ## DPoP
 Added in 6.3.0.

diff --git a/IdentityServer/v7/docs/content/reference/options.md b/IdentityServer/v7/docs/content/reference/options.md
@@ -567,7 +567,7 @@ OAuth device flow settings. Available on the *DeviceFlow* property of the *Ident
 
 * ***Interval***
 
-    Defines the minimum allowed polling interval on the token endpoint. Defaults to *5*.
+    The maximum frequency in seconds that a client may poll the token endpoint in the device flow. Defaults to *5*.
 
 ## Mutual TLS
 [Mutual TLS]({{< ref "/tokens/authentication/mtls" >}}) settings. Available on the *MutualTls* property of the *IdentityServerOptions* object.
@@ -640,7 +640,7 @@ Settings for [dynamic providers]({{< ref "/ui/login/dynamicproviders">}}). Avail
 
 * ***DefaultPollingInterval***
 
-    The polling interval in seconds that a client is to use when connecting to the token endpoint. Defaults to 5.
+    The maximum frequency in seconds that a client may poll the token endpoint in the CIBA flow. Defaults to 5.
 
 ## Server-side Sessions 
 Settings for [server-side sessions]({{<ref "/ui/server_side_sessions">}}). Added in 6.1.  Available on the *ServerSideSessions* property of the *IdentityServerOptions* object.