diff --git a/IdentityServer/v6/docs/content/reference/models/client.md b/IdentityServer/v6/docs/content/reference/models/client.md index 2e344195..496f8fe9 100644 --- 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 index 72475200..0eb46d29 100644 --- 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]({{}}). 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 index 2e344195..b5e21647 100644 --- 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 index 72475200..0eb46d29 100644 --- 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]({{}}). Added in 6.1. Available on the *ServerSideSessions* property of the *IdentityServerOptions* object.