Update application level sign-in experience
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
-
The unique identifier of the application.
Body Required
-
color object
Additional properties are allowed.
-
branding object
Additional properties are allowed.
-
displayName string | null
Maximum length is
256
. termsOfUseUrl string(url) | null | string(empty) Required
One of: Maximum length is
2048
.privacyPolicyUrl string(url) | null | string(empty) Required
One of: Maximum length is
2048
.
PUT /api/applications/{applicationId}/sign-in-experience
curl \
-X PUT https://[tenant_id].logto.app/api/applications/{applicationId}/sign-in-experience \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"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"
}