diff --git a/consent/types.go b/consent/types.go index 25252783975..1b9c4460037 100644 --- a/consent/types.go +++ b/consent/types.go @@ -143,7 +143,7 @@ type HandledLoginRequest struct { Remember bool `json:"remember"` // RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the - // authorization will be remembered indefinitely. + // authorization will be remembered for the duration of the browser session (using a session cookie). RememberFor int `json:"remember_for"` // ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it diff --git a/docs/api.swagger.json b/docs/api.swagger.json index 7934fff632e..3ae10ec54cd 100644 --- a/docs/api.swagger.json +++ b/docs/api.swagger.json @@ -2062,7 +2062,7 @@ "x-go-name": "Remember" }, "remember_for": { - "description": "RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered indefinitely.", + "description": "RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered for the duration of the browser session (using a session cookie).", "type": "integer", "format": "int64", "x-go-name": "RememberFor" diff --git a/sdk/go/hydra/models/handled_consent_request.go b/sdk/go/hydra/models/handled_consent_request.go index 38c6ad90a53..01bacdf7488 100644 --- a/sdk/go/hydra/models/handled_consent_request.go +++ b/sdk/go/hydra/models/handled_consent_request.go @@ -27,7 +27,7 @@ type HandledConsentRequest struct { Remember bool `json:"remember,omitempty"` // RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the - // authorization will be remembered indefinitely. + // authorization will be remembered for the duration of the browser session (using a session cookie). RememberFor int64 `json:"remember_for,omitempty"` // session diff --git a/sdk/go/hydra/models/handled_login_request.go b/sdk/go/hydra/models/handled_login_request.go index 64fda02db89..8e9b513d313 100644 --- a/sdk/go/hydra/models/handled_login_request.go +++ b/sdk/go/hydra/models/handled_login_request.go @@ -51,7 +51,7 @@ type HandledLoginRequest struct { Remember bool `json:"remember,omitempty"` // RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the - // authorization will be remembered indefinitely. + // authorization will be remembered for the duration of the browser session (using a session cookie). RememberFor int64 `json:"remember_for,omitempty"` // Subject is the user ID of the end-user that authenticated. diff --git a/sdk/java/hydra-client-resttemplate/docs/AcceptLoginRequest.md b/sdk/java/hydra-client-resttemplate/docs/AcceptLoginRequest.md index 2b7e2303cc5..d63dc26d9ea 100644 --- a/sdk/java/hydra-client-resttemplate/docs/AcceptLoginRequest.md +++ b/sdk/java/hydra-client-resttemplate/docs/AcceptLoginRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **context** | **Map<String, Object>** | Context is an optional object which can hold arbitrary data. The data will be made available when fetching the consent request under the \"context\" field. This is useful in scenarios where login and consent endpoints share data. | [optional] **forceSubjectIdentifier** | **String** | ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail. | [optional] **remember** | **Boolean** | Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again. | [optional] -**rememberFor** | **Long** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional] +**rememberFor** | **Long** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). | [optional] **subject** | **String** | Subject is the user ID of the end-user that authenticated. | diff --git a/sdk/java/hydra-client-resttemplate/src/main/java/com/github/ory/hydra/model/AcceptLoginRequest.java b/sdk/java/hydra-client-resttemplate/src/main/java/com/github/ory/hydra/model/AcceptLoginRequest.java index cb111874d3a..be265cb1b56 100644 --- a/sdk/java/hydra-client-resttemplate/src/main/java/com/github/ory/hydra/model/AcceptLoginRequest.java +++ b/sdk/java/hydra-client-resttemplate/src/main/java/com/github/ory/hydra/model/AcceptLoginRequest.java @@ -132,10 +132,10 @@ public AcceptLoginRequest rememberFor(Long rememberFor) { } /** - * RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. + * RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). * @return rememberFor **/ - @ApiModelProperty(value = "RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely.") + @ApiModelProperty(value = "RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie).") public Long getRememberFor() { return rememberFor; } diff --git a/sdk/js/swagger/docs/AcceptLoginRequest.md b/sdk/js/swagger/docs/AcceptLoginRequest.md index f0be920106f..39969d35af5 100644 --- a/sdk/js/swagger/docs/AcceptLoginRequest.md +++ b/sdk/js/swagger/docs/AcceptLoginRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **context** | **{String: Object}** | Context is an optional object which can hold arbitrary data. The data will be made available when fetching the consent request under the \"context\" field. This is useful in scenarios where login and consent endpoints share data. | [optional] **forceSubjectIdentifier** | **String** | ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail. | [optional] **remember** | **Boolean** | Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again. | [optional] -**rememberFor** | **Number** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional] +**rememberFor** | **Number** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). | [optional] **subject** | **String** | Subject is the user ID of the end-user that authenticated. | diff --git a/sdk/js/swagger/src/model/AcceptLoginRequest.js b/sdk/js/swagger/src/model/AcceptLoginRequest.js index 0451101d20c..89581e38fba 100644 --- a/sdk/js/swagger/src/model/AcceptLoginRequest.js +++ b/sdk/js/swagger/src/model/AcceptLoginRequest.js @@ -110,7 +110,7 @@ */ exports.prototype['remember'] = undefined; /** - * RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. + * RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). * @member {Number} remember_for */ exports.prototype['remember_for'] = undefined; diff --git a/sdk/php/swagger/docs/Model/AcceptLoginRequest.md b/sdk/php/swagger/docs/Model/AcceptLoginRequest.md index bb28aa761c1..c10bece0ca4 100644 --- a/sdk/php/swagger/docs/Model/AcceptLoginRequest.md +++ b/sdk/php/swagger/docs/Model/AcceptLoginRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **context** | **map[string,object]** | Context is an optional object which can hold arbitrary data. The data will be made available when fetching the consent request under the \"context\" field. This is useful in scenarios where login and consent endpoints share data. | [optional] **force_subject_identifier** | **string** | ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail. | [optional] **remember** | **bool** | Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again. | [optional] -**remember_for** | **int** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional] +**remember_for** | **int** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). | [optional] **subject** | **string** | Subject is the user ID of the end-user that authenticated. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdk/php/swagger/lib/Model/AcceptLoginRequest.php b/sdk/php/swagger/lib/Model/AcceptLoginRequest.php index d713b3b0602..70a37bd4371 100644 --- a/sdk/php/swagger/lib/Model/AcceptLoginRequest.php +++ b/sdk/php/swagger/lib/Model/AcceptLoginRequest.php @@ -291,7 +291,7 @@ public function getRememberFor() /** * Sets remember_for - * @param int $remember_for RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. + * @param int $remember_for RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). * @return $this */ public function setRememberFor($remember_for)