Passer au contenu principal

Référence des paramètres de l'application

Cette page décrit chaque champ de la page de modification de l'application dans la console d'administration Casdoor. La page comporte huit onglets, et les champs sont listés par onglet, dans l'ordre de la page.

Basique​

FieldDescription
NameInternal application name.
Display nameName shown to users.
CategoryDefault (web apps) or Agent (M2M, e.g. MCP servers, API clients).
TypeFor Default: All, OIDC, OAuth, SAML, CAS. For Agent: MCP, A2A.
Is sharedWhether the app is shared across organizations (global admin only).
LogoBranding image on the sign-in and sign-up pages (URL + preview).
Enable dark logoShows Logo dark. Turning it off clears Logo dark.
Logo darkLogo that the sign-in, sign-up, and other authentication pages show in the dark theme (URL + preview on a black background). Casdoor never takes it from the organization. Without it, the pages show Logo in the dark theme too. The organization has its own Logo dark for the sidebar of the admin console.
TitlePage title shown on the sign-in and sign-up pages.
FaviconBrowser tab icon (URL + preview).
HomeApplication homepage URL.
DescriptionShort description of the application.
OrganizationOwning organization.
TagsOnly users with one of these tags can sign in. See Application Tags.
OrderSort order in lists.
Menu modeLayout of the edit page navigation: Horizontal or Vertical.

Authentification​

FieldDescription
Cookie expireSession cookie lifetime in hours (default: 720). Without "Remember me", the session is capped at 24 h regardless.
Default groupGroup automatically assigned to new users signing up through this application, including both direct sign-up and OAuth-based registration. Providers and invitations can override this per-signup: the effective group follows the priority invitation SignupGroup > provider SignupGroup > application Default group.
Default tagTag automatically assigned to new users who sign up through this application.
Enable signupAllow new accounts: on the signup page, by magic link or verification code, and on the first sign-in with one of the application's providers (whose Can signup is on). When off, only admins can create accounts.
Disable self signupShown when Enable signup is on. Users can no longer sign themselves up on the signup page, by magic link or by verification code, and the sign-in page hides the sign-up link. The signup page still works with an invitation code from an admin, and the first sign-in with a provider still creates the account. Use it to close public signup while keeping just-in-time accounts for SSO, e.g. new employees signing in with Lark or DingTalk for the first time.
Disable signinDisable all sign-in for this application.
Enable guest signinAllow unauthenticated guest access by presenting code=guest-user to the token endpoint. Requires Enable signup to be on as well. Not available for the built-in organization. See Guest authentication.
Enable exclusive signinLimit the number of active sessions of each user in this application. A new sign-in ends the older sessions and expires their tokens. See Allow one session per user.
Max sessionsShown when Enable exclusive signin is on. The number of sessions a user may keep in the application, 1 by default.
Signin sessionEnable persistent sign-in session across browser restarts.
Auto signinAutomatically sign the user back in on revisit. Requires Signin session to be enabled first.
Enable Email linkingAllow linking OAuth accounts to existing accounts by matching email.
Signup URLExternal sign-up URL, replaces Casdoor's built-in sign-up page.
Signin URLExternal sign-in URL, replaces Casdoor's built-in sign-in page.
Forget URLCustom password recovery URL.
Affiliation URLAffiliation or invitation URL.

OIDC/OAuth​

FieldDescription
Client IDOAuth 2.0 client identifier.
Client secretOAuth 2.0 client secret.
Redirect URLsAllowed redirect URLs after sign-in. Casdoor checks them for the authorization code flow, the implicit flow, and the CAS service parameter. See Redirect URL matching.
Forced redirect originWhen set, Casdoor forces all redirects to this origin.
Grant typesEnabled OAuth grant types: Authorization Code, Password, Client Credentials, Token, ID Token, Refresh Token, Device Code, Token Exchange, JWT Bearer.
ScopesCustom scopes for Agent-category apps (name, display name, description); exposed in OIDC discovery.
Federated credentialsExternal OpenID Connect (OIDC) issuers whose tokens Casdoor accepts as a credential of this application, without a client secret. Each row has Issuer, JWKS URL, Subject, Audience, and User. See Federated credentials.
Token formatJWT, JWT-Empty, JWT-Custom, or JWT-Standard. A new application gets the Default token format of its organization. See Token overview.
Token signing methodSigning algorithm: RS256, RS512, ES256, ES384, or ES512.
Token group formatHow the groups claim of every token format and the groups of /api/userinfo name each group: ID (org/group) (the default), Path (org/parent/group), or Name (group). Path replaces the removed useGroupPathInToken setting of conf/app.conf.
Token fieldsUser fields included in the token payload (available when format is JWT-Custom). This list also acts as a whitelist for the /userinfo endpoint: when non-empty, only the listed fields are returned. Leave empty to include the full set. A new application gets the Default token fields of its organization. See Token overview.
Token attributesCustom claims added to the token (available when format is JWT-Custom). Each row has a Category, Value, and Type. See Token attributes
Token expireAccess token lifetime in hours.
Refresh token expireRefresh token lifetime in hours.

Attributs du jeton​

Chaque ligne de Token attributes ajoute une revendication personnalisée au jeton et possède une Category, une Value, et un Type :

CategoryValueResult
Static ValueA template string. It supports ${user.xxx} substitutionType sets whether the claim is a String or an Array
Existing FieldUn champ utilisateur de la liste : Owner, Name, Id, DisplayName, Avatar, Email, Phone, Tag, Roles, Permissions, permissionNames, ou Groups. Référencez une clé de la map properties comme Properties.<key>Casdoor lit le champ depuis l'utilisateur lors de l'émission du jeton

Correspondance des URL de redirection​

Casdoor accepte une URL de redirection lorsqu'elle est égale à une entrée de Redirect URLs, ou lorsqu'elle correspond à une entrée selon ces règles :

EntryMatches
A full URL, such as https://example.com/callbackThe same scheme, port, and path. The host is the same host or a subdomain of it, so the entry also allows https://api.example.com/callback.
A loopback URL, such as http://localhost/callback or http://127.0.0.1/callbackThe same URL on any port, as RFC 8252 requires for native applications.
A host without a scheme, such as example.com or example.com/callbackhttp and https URLs on the host or its subdomains, with the path of the entry, or with any path if the entry has none. .example.com matches only the subdomains.
Anything elseThe entry is a regular expression that must match the whole URL.

Casdoor rejette toujours les URL javascript:, data: et vbscript:. Les URL localhost, 127.0.0.1 et casdoor-authenticator nécessitent une entrée comme toute autre URL.

SAML​

FieldDescription
SAML reply URLAssertion Consumer Service (ACS) URL where Casdoor posts the SAML response.
Enable SAML compressionCompress SAML requests and responses.
Enable SAML C14N10Use C14N 1.0 canonicalization when signing SAML documents.
SAML C14N prefixNamespace prefix list used for the C14N 1.0 canonicalization (applies when Enable SAML C14N10 is on; default xs).
Use Email as NameIDUse the user's email address as the SAML NameID instead of username.
Enable SAML POST bindingUse HTTP POST binding instead of Redirect binding.
SAML hash algorithmSignature hash algorithm: SHA1, SHA256, or SHA512.
Disable SAML attributesSend only NameID in the assertion, omit all other user attributes.
Enable SAML assertion signatureSign the assertion element in addition to the response envelope.
SAML attributesCustom attribute statements included in the SAML assertion (available when Disable SAML attributes is off).
SAML metadataRead-only XML metadata for this application; includes a button to copy the metadata URL.

Fournisseurs​

FieldDescription
ProvidersFournisseurs OAuth, email, SMS, stockage et autres fournisseurs attachés à cette application. Contrôle quelles méthodes de connexion et intégrations sont disponibles.

Chaque fournisseur OAuth et SAML dans le tableau Providers possède les paramètres suivants :

ColumnDescription
Can sign upAllow new users to register via this provider.
Can sign inAllow existing users to sign in via this provider.
Peut annuler le lienAllow users to unlink this provider from their account.
Règle de liaisonFields used to link a new external identity to an existing Casdoor user of the organization, checked in order: the first match links the accounts. Email matches only an email address that the provider reports as verified, and only a user whose email is verified or who didn't sign up through an application. Phone matches only a verified phone number, with its country code. Name matches the username, case-insensitively. The default is Email, Phone. An empty list turns linking off. If no rule links the identity and its email or phone already belongs to another user, Casdoor refuses the sign-up. A linked user completes their multi-factor authentication (MFA) before the sign-in finishes. See How Casdoor links accounts.
Country codesRestrict phone-based providers to specific country calling codes.
InvitéShow a prompt asking users to bind this provider after sign-up if they haven't already.
Groupe d'inscriptionOverride the application's Default group for users who sign up via this provider.

Personnalisation de l'interface​

FieldDescription
Org choice modeHow users select their organization at sign-in: None, Select (dropdown), or Input (text field).
Signin methodsOrdered list of sign-in methods shown on the sign-in page (e.g. Password, Verification code, WebAuthn).
Signup HTMLCustom HTML injected into the sign-up page. See Custom HTML and scripts.
Signin HTMLCustom HTML injected into the sign-in page. See Custom HTML and scripts.
Page HTMLCode HTML personnalisé injecté dans la balise <head> de la page (par ex. meta tags, extraits d'analyse ou styles personnalisés) pour toutes les pages de l'application. Un élément <script>, comme en utilisent la plupart des extraits d'analyse, n'est exécuté que dans les applications de l'organisation built-in et dans les applications où Enable custom scripts est activé. Casdoor refuse les scripts enregistrés par un administrateur d'organisation. Pour utiliser un script dans une autre organisation, un administrateur global active Enable custom scripts et saisit le code HTML. Voir Custom HTML and scripts.
Signin itemsConfigure which fields and controls appear on the sign-in form.
Signup itemsConfigure the registration form fields (visible only when Enable signup is on).
Background URLDesktop sign-in page background image (URL + preview).
Background URL MobileMobile sign-in page background image (URL + preview).
Custom CSSCSS applied to the sign-in form (desktop).
Custom CSS MobileCSS applied to the sign-in form (mobile).
Form positionHorizontal alignment of the sign-in form: Left, Center, Right, or Enable side panel.
Side panel HTMLHTML shown in the panel beside the sign-in form (visible when Form position is set to Enable side panel).
ThemeUtiliser le thème de l'organisation ou définir un thème personnalisé pour cette application : le style (Default, Dark, Document ou Blossom), la couleur principale, le rayon des bordures et Is compact. Voir Customize the theme.
Enable custom scriptsRendu du code HTML personnalisé de cette application tel quel, afin que les éléments <script> soient exécutés. Seul un administrateur global peut l'activer. Voir Custom HTML and scripts.
Header HTMLCustom HTML injected into the page <head> of the sign-in and sign-up pages.
Footer HTMLCustom HTML rendered below the sign-in and sign-up forms. The footer of the Casdoor admin console shows the Footer HTML of the default application of the signed-in user's organization, in place of "Powered by Casdoor".

HTML et scripts personnalisés​

Casdoor treats the custom HTML of an application differently depending on its organization and on Enable custom scripts:

  • Applications de l'organisation built-in : Casdoor rend le HTML tel quel, et les éléments <script> s'exécutent.
  • Applications of other organizations, unless Enable custom scripts is on: Casdoor removes scripts, event handlers, and other active content before it renders the HTML. Links that open in another window get rel="noopener noreferrer".

Un administrateur global peut activer Enable custom scripts pour une application de n'importe quelle organisation. Casdoor rend alors le code HTML personnalisé de cette application tel quel, comme pour built-in, et les éléments <script> sont exécutés. Les administrateurs d'organisation ne peuvent pas activer ce paramètre et, lorsqu'il est activé, ils ne peuvent pas modifier le code HTML personnalisé de l'application. Seul un administrateur global le peut.

Cela s'applique aux champs Header HTML, Page HTML, Footer HTML, Side panel HTML, Signin HTML, Signup HTML, aux éléments de connexion personnalisés et aux éléments d'inscription Text. Le pied de page de la console d'administration est toujours assaini, même pour built-in. Ce que les administrateurs d'organisation peuvent enregistrer dans ces champs est également limité. Voir Ce que les administrateurs d'organisation peuvent mettre dans le HTML et le CSS personnalisés.

Sécurité​

FieldDescription
Token certCertificate used to sign tokens issued by this application.
Client certCertificate used to verify client identity. For mutual TLS it authenticates the client connection; for the JWT Bearer grant (RFC 7523), the public key in this certificate is used to verify the client's JWT assertion signature.
Failed signin limitNumber of consecutive failed sign-in attempts before the account is locked. This limit also applies to the /api/verify-code OTP endpoint: too many wrong verification codes will temporarily block that user+destination combination using the same counter and freeze time.
Failed signin frozen timeLock duration in minutes after hitting the failed sign-in limit.
Code resend timeoutSeconds a user must wait before requesting another verification code (default: 60; set to 0 for the global default).
IP whitelistComma-separated list of allowed IP addresses or CIDR ranges. Overrides the organization-level whitelist. See IP allowlist.
Terms of UseURL or path to the terms-of-use page (up to 200 characters). An HTML file can be uploaded directly and the resulting URL is filled in automatically.

Proxy inverse​

FieldDescription
DomainPrimary domain this application is served on (e.g. blog.example.com).
Other domainsAdditional domains that should route to this application.
Upstream hostL'adresse du service backend vers laquelle Casdoor proxy les requêtes (par ex. localhost:8080).
SSL modeTLS handling: None, HTTP, HTTPS and HTTP, or HTTPS Only.
SSL certCertificate used for HTTPS when acting as a reverse proxy.

Voir aussi​