Update application level sign-in experience

PUT /api/applications/{applicationId}/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

application/json

Body Required

Responses

  • • 200 application/json

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

    Hide response attributes Show response attributes object
  • • 201

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

  • • 400

    Bad Request

  • • 401

    Unauthorized

  • • 403

    Forbidden

  • • 404

    The application does not exist.

  • • 422

    Unprocessable Content

PUT /api/applications/{applicationId}/sign-in-experience 
curl \
 -X PUT https://[tenant_id].logto.app/api/applications/{applicationId}/sign-in-experience \
 -H "Content-Type: application/json" \
 -d '{"branding":{"logoUrl":"string","darkLogoUrl":"string","favicon":"string"},"displayName":"string","termsOfUseUrl":"string","privacyPolicyUrl":"string"}'
Request example 
{
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string"
  },
  "displayName": "string",
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string"
}
Response examples (200) 
{
  "applicationId": "string",
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string"
  },
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string",
  "displayName": "string"
}