External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

Make intra-document links work in downstream

Browse Source 
Closes #43544

Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>
This commit is contained in:
Alexander Schwartz 2025-10-21 13:16:40 +02:00 committed by GitHub
parent add43bd394
commit 7c50d94f14
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/documentation/server_admin/topics/admin-console-permissions/fine-grain-v2.adoc
View File

@ -167,7 +167,7 @@ From this section, you can manage the permissions for realm resources.
The *Permissions* tab provides an overview of all active permissions within a realm. From here, administrators can create,
update, delete, or search for permissions. You can also pre-evaluate the permissions you have created to check
if they are enforcing access to realm resources as expected.
For more details, see link:#_managing-permissions[Evaluating Permissions].
For more details, see <<_evaluating-permissions,Evaluating Permissions>>.
To create a permission, click on the `Create permission` button and select the resource type you want to protect.
@ -328,7 +328,7 @@ multiple resource types (such as both users and groups), they must have all the
These roles enable basic access to query resources but do not grant permission to view or modify them. To grant or deny access
to realm resources you need to set up the permissions for any of the operations available from each resource type.
For more details, see link:#_managing-permissions[Managing Permissions].
For more details, see <<_managing-permissions,Managing Permissions>>.
===== Roles and Permission relationship

2
docs/documentation/server_admin/topics/authentication/conditions.adoc
View File

@ -27,7 +27,7 @@ The Execution requirements section includes an example of the OTP form.
`Condition - User Attribute`::
This checks if the user has set up the required attribute: optionally, the check can also evaluate the group attributes.
There is a possibility to negate output, which means the user should not have the attribute.
The link:#user-profile[User Attributes] section shows how to add a custom attribute.
The <<user-profile,User Attributes>> section shows how to add a custom attribute.
You can provide these fields:
Alias:::

4
docs/documentation/server_admin/topics/user-federation/ldap.adoc
View File

@ -179,7 +179,7 @@ The LDAP connection pool configuration is configured using the following system
|Description
| `com.sun.jndi.ldap.connect.pool.authentication` | A list of space-separated authentication types of connections that may be pooled. Valid types are "none", "simple", and "DIGEST-MD5"
| `com.sun.jndi.ldap.connect.pool.initsize` | The string representation of an integer that represents the number of connections per connection identity to create when initially creating a connection for the identity
| `com.sun.jndi.ldap.connect.pool.maxsize` | The string representation of an integer that represents the maximum number of connections per connection identity that can be maintained concurrently. Note setting this value too low may cause contention in obtaining LDAP connections. See also `com.sun.jndi.ldap.connect.timeout`.
| `com.sun.jndi.ldap.connect.pool.maxsize` | The string representation of an integer that represents the maximum number of connections per connection identity that can be maintained concurrently. Note setting this value too low may cause contention in obtaining LDAP connections. See also `com.sun.jndi.ldap.connect.timeout`.
| `com.sun.jndi.ldap.connect.pool.prefsize` | The string representation of an integer that represents the preferred number of connections per connection identity that should be maintained concurrently
| `com.sun.jndi.ldap.connect.pool.timeout` | The string representation of an integer that represents the number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool
| `com.sun.jndi.ldap.connect.pool.protocol` | A list of space-separated protocol types of connections that may be pooled. Valid types are "plain" and "ssl"
@ -225,7 +225,7 @@ Mapper for provider: XXX, Mapper name: YYY, Provider: ZZZ ...
Note those messages are displayed just with the enabled DEBUG logging.
- For tracking the performance or connection pooling issues, consider setting the value of property `com.sun.jndi.ldap.connect.pool.debug` to `all`. This change adds many additional messages to the server log with the included logging for the LDAP connection
pooling. As a result, you can track the issues related to connection pooling or performance. For more details, see link:#_ldap_connection_pool[Configuring the connection pool].
pooling. As a result, you can track the issues related to connection pooling or performance. For more details, see <<_ldap_connection_pool,Configuring the connection pool>>.
NOTE: After changing the configuration of connection pooling, you may need to restart the {project_name} server to enforce re-initialization
of the LDAP provider connection.

28
docs/documentation/server_admin/topics/users/user-profile.adoc
View File

@ -154,7 +154,7 @@ Name::
The name of the attribute, used to uniquely identify an attribute.
Display name::
A user-friendly name for the attribute, mainly used when rendering user-facing forms. It also supports link:#_using-internationalized-messages[Using Internationalized Messages]
A user-friendly name for the attribute, mainly used when rendering user-facing forms. It also supports <<_using-internationalized-messages,Using Internationalized Messages>>.
Multivalued::
If enabled, the attribute supports multiple values and UIs are rendered accordingly to allow setting many values. When enabling this
@ -192,11 +192,11 @@ The `Who can view` setting mark an attribute as read-only by `User` and/or `Admi
Validation::
In this section, you can define the validations that will be performed when managing the attribute value.
{project_name} provides a set of built-in validators you can choose from with the possibility to add your own. For more details, look at
the link:#_validating-attributes[Validating Attributes] section.
the <<_validating-attributes,Validating Attributes>> section.
Annotation::
In this section, you can associate annotations to the attribute. Annotations are mainly useful to pass over additional metadata to frontends for rendering purposes.
For more details, look at the link:#_defining-ui-annotations[Defining UI Annotations] section.
For more details, look at the <<_defining-ui-annotations,Defining UI Annotations>> section.
When you create an attribute, the attribute is only available from administrative contexts to avoid unexpectedly exposing attributes to end-users.
Effectively, the attribute won't be accessible to end-users when they are managing their profile through the end-user contexts. You can change the `Permissions` settings anytime accordingly
@ -324,7 +324,7 @@ In order to pass additional information to frontends, attributes can be decorate
annotations to dictate how attributes are rendered. This capability is mainly useful when extending {project_name} themes
to render pages dynamically based on the annotations associated with attributes.
Annotations are used, for example, for link:#_changing-the-html-type-for-an-attribute[Changing the HTML `type` for an Attribute] and link:#_changing-the-dom-representation-of-an-attribute[Changing the DOM representation of an Attribute], as you will
Annotations are used, for example, for <<_changing-the-html-type-for-an-attribute,Changing the HTML `type` for an Attribute>> and <<_changing-the-dom-representation-of-an-attribute,Changing the DOM representation of an Attribute>>, as you will
see in the following sections.
.Attribute Annotation
@ -360,13 +360,13 @@ Text is NOT html escaped when rendered into the page, so you can use html tags h
Text is NOT html escaped when rendered into the page, so you can use html tags here to format the text, but you also have to correctly escape html control characters.
|inputOptionsFromValidation
|Annotation for select and multiselect types. Optional name of custom attribute validation to get input options from. See link:#_managing_options_for_select_fields[detailed description] below.
|Annotation for select and multiselect types. Optional name of custom attribute validation to get input options from. See the <<_managing_options_for_select_fields,detailed description>> below.
|inputOptionLabelsI18nPrefix
|Annotation for select and multiselect types. Internationalization key prefix to render options in UI. See link:#_managing_options_for_select_fields[detailed description] below.
|Annotation for select and multiselect types. Internationalization key prefix to render options in UI. See the <<_managing_options_for_select_fields,detailed description>> below.
|inputOptionLabels
|Annotation for select and multiselect types. Optional map to define UI labels for options (directly or using internationalization). See link:#_managing_options_for_select_fields[detailed description] below.
|Annotation for select and multiselect types. Optional map to define UI labels for options (directly or using internationalization). See the <<_managing_options_for_select_fields,detailed description>> below.
|inputTypePlaceholder
|HTML input `placeholder` attribute applied to the field - specifies a short hint that describes the expected value of an input field (e.g. a sample value
@ -445,19 +445,19 @@ You can change the `type` of a HTML5 input element by setting the `inputType` an
|textarea
|select
|Common single select input. See link:#_managing_options_for_select_fields[description how to configure options] below.
|Common single select input. See the <<_managing_options_for_select_fields,description of how to configure options>> below.
|select
|select-radiobuttons
|Single select input through group of radio buttons. See link:#_managing_options_for_select_fields[description how to configure options] below.
|Single select input through group of radio buttons. See the <<_managing_options_for_select_fields,description of how to configure options>> below.
|group of input
|multiselect
|Common multiselect input. See link:#_managing_options_for_select_fields[description how to configure options] below.
|Common multiselect input. See the <<_managing_options_for_select_fields,description of how to configure options>> below.
|select
|multiselect-checkboxes
|Multiselect input through group of checkboxes. See link:#_managing_options_for_select_fields[description how to configure options] below.
|Multiselect input through group of checkboxes. See the <<_managing_options_for_select_fields,description of how to configure options>> below.
|group of input
|html5-email
@ -672,10 +672,10 @@ Name::
The name of the attribute, used to uniquely identify an attribute.
Display name::
A user-friendly name for the attribute, mainly used when rendering user-facing forms. It also supports link:#_using-internationalized-messages[Using Internationalized Messages]
A user-friendly name for the attribute, mainly used when rendering user-facing forms. It also supports <<_using-internationalized-messages,Using Internationalized Messages>>.
Display description::
A user-friendly text that will be displayed as a tooltip when rendering user-facing forms. It also supports link:#_using-internationalized-messages[Using Internationalized Messages]
A user-friendly text that will be displayed as a tooltip when rendering user-facing forms. It also supports <<_using-internationalized-messages,Using Internationalized Messages>>.
Annotation::
In this section, you can associate annotations to the attribute. Annotations are mainly useful to pass over additional metadata to frontends for rendering purposes.
@ -737,7 +737,7 @@ The JSON schema is defined as follows:
The schema supports as many attributes and groups as you need.
The `unmanagedAttributePolicy` property defines the unmanaged attribute policy by setting one of following values. For more details,
look at the link:#_understanding-managed-and-unmanaged-attributes[Understanding Managed and Unmanaged Attributes].
look at the <<_understanding-managed-and-unmanaged-attributes,Understanding Managed and Unmanaged Attributes>>.
* `DISABLED`
* `ENABLED`

4
docs/guides/ui-customization/themes.adoc
View File

@ -311,7 +311,7 @@ Although it is possible to create custom templates to change completely how page
templates as much as possible. The reasons are:
* During upgrades, you might be forced to update your custom templates to get the latest updates from newer versions
* link:#_theme_stylesheet[Configuring CSS styles] to your themes allows you to adapt the UI to match your UI design standards and guidelines.
* <<_theme_stylesheet,Configuring CSS styles>> to your themes allows you to adapt the UI to match your UI design standards and guidelines.
* link:{adminguide_link}#user-profile[User Profile] allows you to support custom user attributes and configure how they are rendered.
In most cases, you won't need to change templates to adapt {project_name} to your needs, but you can override individual
@ -460,4 +460,4 @@ The `LocaleSelectorProvider` interface has a single method, `resolveLocale`, whi
Custom implementations can extend the `DefaultLocaleSelectorProvider` in order to reuse parts of the default behavior. For example to ignore the `Accept-Language` request header, a custom implementation could extend the default provider, override it's `getAcceptLanguageHeaderLocale`, and return a null value. As a result the locale selection will fall back on the realm's default language.
=== Additional resources for Locale selector
* For more details on creating and deploying a custom provider, see https://www.keycloak.org/docs/latest/server_development/index.html#_providers[Service Provider Interfaces].
* For more details on creating and deploying a custom provider, see https://www.keycloak.org/docs/latest/server_development/index.html#_providers[Service Provider Interfaces].