Get the application level sign-in experience

GET /api/applications/{applicationId}/sign-in-experience

OAuth2

Get application level sign-in experience for a given application.

Only branding properties and terms links customization is supported for now.
Only third-party applications can have the sign-in experience customization for now.

Path parameters

applicationId string Required

The unique identifier of the application.

Responses

200 application/json

Returns the application's application level sign-in experience.
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
  
  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
  
  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 or the application level sign-in experience does not exist.

GET /api/applications/{applicationId}/sign-in-experience

curl \
 -X GET https://[tenant_id].logto.app/api/applications/{applicationId}/sign-in-experience \
 -H "Authorization: Bearer $ACCESS_TOKEN"

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"
}