Config

Public instance settings: which sign-in methods, registration paths, and features are enabled.

get/config

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/config
  • Auth
    none required

Response

Application settings

isCloudboolean required
disableRegistrationboolean required
disablePasswordRegistrationboolean required
disableEmailOtpSignInboolean required
disableWorkspaceCreationboolean required
isDemoModeboolean required
hasSmtpboolean required
hasImageUploadsboolean required

Whether S3-compatible storage is configured, so task images and board backgrounds can be uploaded.

hasGithubSignInboolean required
hasGoogleSignInboolean required
hasDiscordSignInboolean required
hasCustomOAuthboolean required
hasGuestAccessboolean required
disableLoginFormboolean required
customOAuthNamestring nullable required

Label for the custom OAuth provider on the sign-in page. Null means the generic SSO label.

customOAuthAutoLoginboolean required
customOAuthLogoutUrlstring nullable required
customOAuthManagedProfileFieldsstring[] required

Profile fields the custom OAuth/OIDC provider manages for people with a linked provider account.

customOAuthAccountUrlstring nullable required

Account page of the custom OAuth/OIDC provider, where people change managed profile fields. Null when not configured.

billingEnabledboolean required

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status