You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**ContactUrl** | **string** | The URL to the project's Contact page. | [optional]
24
25
**FaviconDarkUrl** | **string** | | [optional]
25
26
**FaviconLightUrl** | **string** | | [optional]
26
27
**LogoDarkUrl** | **string** | | [optional]
27
28
**LogoLightUrl** | **string** | | [optional]
29
+
**PrivacyPolicyUrl** | **string** | The URL to the project's Privacy Policy page. | [optional]
28
30
**Stylesheet** | **string** | | [optional]
31
+
**TermsOfServiceUrl** | **string** | The URL to the project's Terms of Service page. | [optional]
29
32
30
33
[[Back to Model list]](../../README.md#documentation-for-models)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to README]](../../README.md)
**VarEnvironment** | **string** | prod Production stage Staging dev Development |
9
9
**Name** | **string** | The project's name. |
10
+
**AccountExperienceContactUrl** | **string** | Holds the URL to the account experience's Contact page. This governs the \"contact_url\" setting. | [optional]
10
11
**AccountExperienceCustomTranslations** | [**List<ClientRevisionAccountExperienceCustomTranslation>**](ClientRevisionAccountExperienceCustomTranslation.md) | The Account Experience's Custom Translations Contains all Custom Translations for this project. | [optional]
11
12
**AccountExperienceDefaultLocale** | **string** | Holds the default locale for the account experience. This governs the \"default_locale\" setting. | [optional]
12
13
**AccountExperienceEnabledLocales** | **List<string>** | The Account Experience's Enabled Locales This governs the locales that are available in the account experience. This governs the \"enabled_locales\" setting. | [optional]
@@ -17,6 +18,8 @@ Name | Type | Description | Notes
17
18
**AccountExperienceLocaleBehavior** | **string** | Holds the URL to the account experience's language behavior. Can be one of: `respect_accept_language`: Respect the `Accept-Language` header. `force_default`: Force the default language. This governs the \"locale_behavior\" setting. | [optional]
18
19
**AccountExperienceLogoDark** | **string** | Holds the URL to the account experience's dark theme logo (currently unused). This governs the \"logo_dark\" setting. | [optional]
19
20
**AccountExperienceLogoLight** | **string** | Holds the URL to the account experience's logo. This governs the \"logo_light\" setting. | [optional]
21
+
**AccountExperiencePrivacyPolicyUrl** | **string** | Holds the URL to the account experience's Privacy Policy page. This governs the \"privacy_policy_url\" setting. | [optional]
22
+
**AccountExperienceTermsOfServiceUrl** | **string** | Holds the URL to the account experience's Terms of Service page. This governs the \"terms_of_service_url\" setting. | [optional]
20
23
**AccountExperienceThemeVariablesDark** | **string** | Holds the URL to the account experience's dark theme variables. This governs the \"theme_variables_dark\" setting. | [optional]
21
24
**AccountExperienceThemeVariablesLight** | **string** | Holds the URL to the account experience's light theme variables. This governs the \"theme_variables_light\" setting. | [optional]
22
25
**CreatedAt** | **DateTime** | The Project's Revision Creation Date | [optional][readonly]
@@ -25,6 +28,8 @@ Name | Type | Description | Notes
25
28
**HomeRegion** | **string** | eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global | [optional]
26
29
**HydraOauth2AllowedTopLevelClaims** | **List<string>** | A list of custom claims which are allowed to be added top level to the Access Token. They cannot override reserved claims. This governs the \"oauth2.allowed_top_level_claims\" setting. | [optional]
27
30
**HydraOauth2ClientCredentialsDefaultGrantAllowedScope** | **bool** | Automatically grant authorized OAuth2 Scope in OAuth2 Client Credentials Flow. Each OAuth2 Client is allowed to request a predefined OAuth2 Scope (for example `read write`). If this option is enabled, the full scope is automatically granted when performing the OAuth2 Client Credentials flow. If disabled, the OAuth2 Client has to request the scope in the OAuth2 request by providing the `scope` query parameter. Setting this option to true is common if you need compatibility with MITREid. This governs the \"oauth2.client_credentials.default_grant_allowed_scope\" setting. | [optional]
31
+
**HydraOauth2DeviceAuthorizationTokenPollingInterval** | **string** | Configures how often a non-interactive device should poll the OAuth 2.0 Device Authorization Grant token endpoint. Purely informational — the value is reported to the device in the \"interval\" response field of the device authorization response. Hydra defaults to 5s when this is left empty. This is an Enterprise feature. This governs the \"oauth2.device_authorization.token_polling_interval\" setting. | [optional]
32
+
**HydraOauth2DeviceAuthorizationUserCodeEntropyPreset** | **string** | Picks a preset for the OAuth 2.0 Device Authorization Grant user_code length and character set. \"high\" produces the longest codes (most resistant to brute force); \"low\" the shortest (easiest for the end user to read and enter). Leave empty to keep Hydra's default preset. This is an Enterprise feature. This governs the \"oauth2.device_authorization.user_code.entropy_preset\" setting. | [optional]
28
33
**HydraOauth2ExcludeNotBeforeClaim** | **bool** | Set to true if you want to omit the `nbf` (not valid before) claim in the access token. This governs the \"oauth2.exclude_not_before_claim\" setting. | [optional]
29
34
**HydraOauth2GrantJwtIatOptional** | **bool** | Configures if the issued at (`iat`) claim is required in the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC7523). If set to `false`, the `iat` claim is required. Set this value to `true` only after careful consideration. This governs the \"oauth2.grant.jwt.iat_optional\" setting. | [optional]
30
35
**HydraOauth2GrantJwtJtiOptional** | **bool** | Configures if the JSON Web Token ID (`jti`) claim is required in the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC7523). If set to `false`, the `jti` claim is required. Set this value to `true` only after careful consideration. This governs the \"oauth2.grant.jwt.jti_optional\" setting. | [optional]
@@ -53,10 +58,13 @@ Name | Type | Description | Notes
53
58
**HydraStrategiesScope** | **string** | Defines how scopes are matched. For more details have a look at https://github.com/ory/fosite#scopes This governs the \"strategies.scope\" setting. exact Oauth2ScopeStrategyExact wildcard Oauth2ScopeStrategyWildcard | [optional][default to HydraStrategiesScopeEnum.Wildcard]
54
59
**HydraTtlAccessToken** | **string** | This governs the \"ttl.access_token\" setting. | [optional][default to "30m"]
55
60
**HydraTtlAuthCode** | **string** | Configures how long refresh tokens are valid. Set to -1 for refresh tokens to never expire. This is not recommended! This governs the \"ttl.auth_code\" setting. | [optional][default to "720h"]
61
+
**HydraTtlDeviceUserCode** | **string** | Configures how long the device_code and user_code in the OAuth 2.0 Device Authorization Grant remain valid. Larger values mean more database storage; shorter values mean users have less time to complete the second-device verification. Hydra defaults to 10m when this is left empty. This is an Enterprise feature. This governs the \"ttl.device_user_code\" setting. | [optional]
56
62
**HydraTtlIdToken** | **string** | This governs the \"ttl.id_token\" setting. | [optional][default to "30m"]
57
63
**HydraTtlLoginConsentRequest** | **string** | Configures how long a user login and consent flow may take. This governs the \"ttl.login_consent_request\" setting. | [optional][default to "30m"]
58
64
**HydraTtlRefreshToken** | **string** | Configures how long refresh tokens are valid. Set to -1 for refresh tokens to never expire. This is not recommended! This governs the \"ttl.refresh_token\" setting. | [optional][default to "720h"]
59
65
**HydraUrlsConsent** | **string** | Sets the OAuth2 Consent Endpoint URL of the OAuth2 User Login & Consent flow. Defaults to the Ory Account Experience if left empty. This governs the \"urls.consent\" setting. | [optional]
66
+
**HydraUrlsDeviceSuccess** | **string** | Sets the URL the user is redirected to after successfully completing the OAuth 2.0 Device Authorization Grant user verification step. Defaults to the Ory Account Experience fallback page if left empty. This is an Enterprise feature. This governs the \"urls.device.success\" setting. | [optional]
67
+
**HydraUrlsDeviceVerification** | **string** | Sets the URL of the user verification page for the OAuth 2.0 Device Authorization Grant (RFC 8628). End users are redirected to this URL to enter the user_code shown on their device. Defaults to the Ory Account Experience fallback page if left empty. This is an Enterprise feature. This governs the \"urls.device.verification\" setting. | [optional]
60
68
**HydraUrlsError** | **string** | Sets the OAuth2 Error URL of the OAuth2 User Login & Consent flow. Defaults to the Ory Account Experience if left empty. This governs the \"urls.error\" setting. | [optional]
61
69
**HydraUrlsLogin** | **string** | Sets the OAuth2 Login Endpoint URL of the OAuth2 User Login & Consent flow. Defaults to the Ory Account Experience if left empty. This governs the \"urls.login\" setting. | [optional]
62
70
**HydraUrlsLogout** | **string** | Sets the logout endpoint. Defaults to the Ory Account Experience if left empty. This governs the \"urls.logout\" setting. | [optional]
@@ -66,6 +74,7 @@ Name | Type | Description | Notes
66
74
**HydraWebfingerJwksBroadcastKeys** | **List<string>** | A list of JSON Web Keys that should be exposed at that endpoint. This is usually the public key for verifying OpenID Connect ID Tokens. However, you might want to add additional keys here as well. This governs the \"webfinger.jwks.broadcast_keys\" setting. | [optional]
67
75
**HydraWebfingerOidcDiscoveryAuthUrl** | **string** | Configures OpenID Connect Discovery and overwrites the OAuth2 Authorization URL. This governs the \"webfinger.oidc_discovery.auth_url\" setting. | [optional]
68
76
**HydraWebfingerOidcDiscoveryClientRegistrationUrl** | **string** | Configures OpenID Connect Discovery and overwrites the OpenID Connect Dynamic Client Registration Endpoint. This governs the \"webfinger.oidc_discovery.client_registration_url\" setting. | [optional]
77
+
**HydraWebfingerOidcDiscoveryDeviceAuthorizationUrl** | **string** | Override the OAuth 2.0 Device Authorization Endpoint URL that is advertised in the OpenID Connect discovery document (/.well-known/openid-configuration). Defaults to the project's public base URL + /oauth2/device/auth. This is an Enterprise feature. This governs the \"webfinger.oidc_discovery.device_authorization_url\" setting. | [optional]
69
78
**HydraWebfingerOidcDiscoveryJwksUrl** | **string** | Configures OpenID Connect Discovery and overwrites the JWKS URL. This governs the \"webfinger.oidc_discovery.jwks_url\" setting. | [optional]
70
79
**HydraWebfingerOidcDiscoverySupportedClaims** | **List<string>** | Configures OpenID Connect Discovery and overwrites a list of supported claims to be broadcasted. Claim \"sub\" is always included. This governs the \"webfinger.oidc_discovery.supported_claims\" setting. | [optional]
71
80
**HydraWebfingerOidcDiscoverySupportedScope** | **List<string>** | Configures OpenID Connect Discovery and overwrites the scope OAuth 2.0 Clients may request. Scope `offline`, `offline_access`, and `openid` are always included. This governs the \"webfinger.oidc_discovery.supported_scope\" setting. | [optional]
Copy file name to clipboardExpand all lines: docs/models/ClientElementsConfiguration.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,11 @@ Name | Type | Description | Notes
18
18
**SettingsUiUrl** | **string** | The URL for the settings UI. |
19
19
**VerificationEnabled** | **bool** | Whether verification is enabled. |
20
20
**VerificationUiUrl** | **string** | The URL for the verification UI. |
21
+
**ContactUrl** | **string** | The URL to the project's Contact page. | [optional]
21
22
**LogoDarkUrl** | **string** | The URL for the dark logo. | [optional]
22
23
**LogoLightUrl** | **string** | The URL for the light logo on the auth card. | [optional]
24
+
**PrivacyPolicyUrl** | **string** | The URL to the project's Privacy Policy page. | [optional]
25
+
**TermsOfServiceUrl** | **string** | The URL to the project's Terms of Service page. | [optional]
23
26
24
27
[[Back to Model list]](../../README.md#documentation-for-models)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to README]](../../README.md)
0 commit comments