跳到主内容

术语参考

Basic Information​

  • Name：创建的应用的名称。
  • CreatedTime：应用程序创建的时间。
  • DisplayName：应用程序向公众显示的名称。
  • Logo：应用程序的标志将会在登录和注册页面上显示。
  • Title: Custom title for the login page.
  • Favicon: The favicon URL for the application login page.
  • Order: Display order of the application.
  • HomepageUrl：应用程序主页的URL。
  • Description：描述应用程序。
  • Organization：应用所属的组织。
  • Tags：只有在应用标签中列出标签的用户才能登录。
  • IsShared: Whether the application is shared across multiple organizations.

Authentication & Sign-in​

  • EnablePassword: Enable password-based authentication.
  • EnableSignUp：如果用户可以注册。 If not, accounts must be created by administrators.
  • DisableSignin: Disable sign-in for this application.
  • EnableSigninSession: Enable session-based sign-in tracking.
  • EnableAutoSignin: Enable automatic sign-in for users.
  • EnableCodeSignin: Enable sign-in using verification codes sent via email or SMS.
  • EnableExclusiveSignin: Only allow one active session per user.
  • EnableWebAuthn: Enable WebAuthn for passwordless authentication.
  • EnableLinkWithEmail: Allow users to link accounts using email verification.
  • SigninMethods: Configuration of Sign-in Methods.
  • SigninItems: Customizable UI elements on the sign-in page.
  • SignupItems：用户注册时需要填写的字段。
  • OrgChoiceMode: How users choose their organization during sign-in.

OAuth & Token Configuration​

  • ClientId：OAuth 客户端 ID。
  • ClientSecret：OAuth客户端密钥。
  • RedirectUris：如果用户成功登录，Casdoor将导航到这些URI之一。
  • ForcedRedirectOrigin: Force redirect to a specific origin after authentication.
  • GrantTypes: Supported OAuth grant types.
  • TokenFormat：生成的令牌的格式。 它可以是以下格式：JWT（包含所有User字段），JWT-Empty（包含所有非空值）或JWT-Custom自定义访问令牌内的User字段。 When using JWT-Custom, each attribute includes a Type field (Array or String) to control how values are returned in the token.
  • TokenSigningMethod: Algorithm used to sign tokens (e.g., RS256, HS256).
  • TokenFields: Custom fields to include in the token.
  • TokenAttributes: Custom JWT attributes to include in tokens.
  • ExpireInHours：登录将在几小时后过期。
  • RefreshExpireInHours: Time in hours before refresh tokens expire.
  • CookieExpireInHours: Session timeout in hours (default: 720 hours / 30 days). Controls how long users stay logged in via session cookies. When users log in without selecting "Remember me", the session is capped at 24 hours for security. If set to 0, uses the default of 720 hours.

SAML Configuration​

  • Cert: Certificate used for SAML signing.
  • EnableSamlCompress: Enable compression for SAML requests and responses.
  • EnableSamlC14n10: Enable C14N 1.0 canonicalization for SAML.
  • EnableSamlPostBinding: Use POST binding instead of GET for SAML responses.
  • DisableSamlAttributes: Disable sending user attributes in SAML responses (only sends NameID).
  • EnableSamlAssertionSignature: Enable digital signatures for SAML assertions. When disabled, only the response envelope is signed while maintaining compatibility with service providers that don't support assertion signatures.
  • UseEmailAsSamlNameId: Use user's email as the SAML NameID instead of username.
  • SamlReplyUrl: The ACS (Assertion Consumer Service) URL for SAML responses.
  • SamlAttributes: Custom SAML attributes to include in the response.
  • SamlHashAlgorithm: Hash algorithm for SAML signatures (e.g., SHA256).

Providers & Services​

  • Providers：为应用程序提供各种服务（如OAuth，电子邮件，短信服务）。

UI Customization​

  • HeaderHtml: Custom HTML to display in the header of login/signup pages.
  • FooterHtml: Custom HTML to display in the footer of login/signup pages.
  • SignupHtml: Custom HTML for the signup page.
  • SigninHtml: Custom HTML for the signin page.
  • FormCss: Custom CSS for the login form.
  • FormCssMobile: Custom CSS for the login form on mobile devices.
  • FormOffset: Vertical offset for the login form position.
  • FormSideHtml: Custom HTML to display beside the login form.
  • FormBackgroundUrl: Background image URL for the login page.
  • FormBackgroundUrlMobile: Background image URL for the login page on mobile devices.
  • ThemeData: Theme configuration data for customizing colors and styles.

Security & Access Control​

  • DefaultGroup: Default group assigned to new users.
  • IpRestriction: IP-based access restrictions for the application.
  • IpWhitelist: List of allowed IP addresses.
  • FailedSigninLimit: Number of failed sign-in attempts before account is temporarily locked.
  • FailedSigninFrozenTime: Duration in seconds that an account remains locked after exceeding failed sign-in limit.

External URLs​

  • SigninUrl: Custom sign-in URL if using external authentication.
  • SignupUrl：如果您在Casdoor之外独立提供注册服务，请在此处填写URL。
  • ForgetUrl: Custom URL for password recovery page.
  • AffiliationUrl: URL for affiliation or invitation system.
  • TermsOfUse: URL or identifier for terms of use document.

Other​

  • CodeResendTimeout: Time in seconds before users can request another verification code (default: 60).