Logto Management API

Update application level sign-in experience

PUT /api/applications/{applicationId}/sign-in-experience
OAuth2

Update application level sign-in experience for the specified application. Create a new sign-in experience if it does not exist.

  • Only branding properties and terms links customization is supported for now.

  • Only third-party applications can be customized for now.

  • Application level sign-in experience customization is optional, if provided, it will override the default branding and terms links.

Path parameters

  • applicationId string Required

    The unique identifier of the application.

application/json

Body Required

  • color object
    Hide color attributes Show color attributes object
    • primaryColor string(regex)

      Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

    • isDarkModeEnabled boolean
    • darkPrimaryColor string(regex)

      Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

  • branding object
    Hide branding attributes Show branding attributes object
    • logoUrl string(url)
    • darkLogoUrl string(url)
    • favicon string(url)
    • darkFavicon string(url)
  • displayName string | null

    Maximum length is 256.

  • termsOfUseUrl string(url) | null | string(empty) Required

    One of:
    string-1 string(url) | null string-2 string(empty)

    Maximum length is 2048.

  • privacyPolicyUrl string(url) | null | string(empty) Required

    One of:
    string-1 string(url) | null string-2 string(empty)

    Maximum length is 2048.

Responses

  • 200 application/json

    The application's sign-in experience was successfully updated.

    Hide response attributes Show response attributes object
    • tenantId string Required

      Maximum length is 21.

    • applicationId string Required

      Minimum length is 1, maximum length is 21.

    • color object Required
      Hide color attributes Show color attributes object
      • primaryColor string(regex)

        Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

      • isDarkModeEnabled boolean
      • darkPrimaryColor string(regex)

        Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

    • branding object Required
      Hide branding attributes Show branding attributes object
      • logoUrl string(url)
      • darkLogoUrl string(url)
      • favicon string(url)
      • darkFavicon string(url)
    • termsOfUseUrl string | null Required

      Maximum length is 2048.

    • privacyPolicyUrl string | null Required

      Maximum length is 2048.

    • displayName string | null Required

      Maximum length is 256.
  • 201 application/json

    A new application level sign-in experience settings was successfully created.

    Hide response attributes Show response attributes object
    • tenantId string Required

      Maximum length is 21.

    • applicationId string Required

      Minimum length is 1, maximum length is 21.

    • color object Required
      Hide color attributes Show color attributes object
      • primaryColor string(regex)

        Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

      • isDarkModeEnabled boolean
      • darkPrimaryColor string(regex)

        Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

    • branding object Required
      Hide branding attributes Show branding attributes object
      • logoUrl string(url)
      • darkLogoUrl string(url)
      • favicon string(url)
      • darkFavicon string(url)
    • termsOfUseUrl string | null Required

      Maximum length is 2048.

    • privacyPolicyUrl string | null Required

      Maximum length is 2048.

    • displayName string | null Required

      Maximum length is 256.
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    The application does not exist.

  • 422

    Unprocessable Content

PUT /api/applications/{applicationId}/sign-in-experience 
curl \
 --request PUT 'https://[tenant_id].logto.app/api/applications/{applicationId}/sign-in-experience' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"color":{"primaryColor":"string","isDarkModeEnabled":true,"darkPrimaryColor":"string"},"branding":{"logoUrl":"string","darkLogoUrl":"string","favicon":"string","darkFavicon":"string"},"displayName":"string","termsOfUseUrl":"string","privacyPolicyUrl":"string"}'
Request examples 
{
  "color": {
    "primaryColor": "string",
    "isDarkModeEnabled": true,
    "darkPrimaryColor": "string"
  },
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "displayName": "string",
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string"
}
Response examples (200) 
{
  "tenantId": "string",
  "applicationId": "string",
  "color": {
    "primaryColor": "string",
    "isDarkModeEnabled": true,
    "darkPrimaryColor": "string"
  },
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string",
  "displayName": "string"
}
Response examples (201) 
{
  "tenantId": "string",
  "applicationId": "string",
  "color": {
    "primaryColor": "string",
    "isDarkModeEnabled": true,
    "darkPrimaryColor": "string"
  },
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string",
  "displayName": "string"
}