Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update reference docs regarding polling intervals #388

Merged
merged 1 commit into from
Jan 5, 2024
Merged

Update reference docs regarding polling intervals #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions IdentityServer/v6/docs/content/reference/models/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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***
Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions IdentityServer/v6/docs/content/reference/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
14 changes: 9 additions & 5 deletions IdentityServer/v7/docs/content/reference/models/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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***
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions IdentityServer/v7/docs/content/reference/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Loading