Skip to main content
GET
/
.well-known
/
meta
Get Deployment Metadata
curl --request GET \
  --url https://{deploymentHost}/.well-known/meta
{
  "status": 200,
  "message": "",
  "data": {
    "deployment_id": 123,
    "app_name": "Acme Corp Authentication",
    "privacy_policy_url": "https://acme.com/privacy",
    "tos_page_url": "https://acme.com/terms",
    "sign_in_page_url": "/auth/signin",
    "sign_up_page_url": "/auth/signup",
    "waitlist_page_url": "/waitlist",
    "support_page_url": "https://acme.com/support",
    "after_logo_click_url": "https://acme.com",
    "user_profile_url": "/profile",
    "organization_profile_url": "/organization/settings",
    "create_organization_url": "/organization/create",
    "after_sign_out_one_page_url": "/",
    "after_sign_out_all_page_url": "/",
    "after_signup_redirect_url": "/dashboard",
    "after_signin_redirect_url": "/dashboard",
    "after_create_organization_redirect_url": "/organization/setup",
    "favicon_image_url": "https://cdn.acme.com/favicon.ico",
    "default_user_profile_image_url": "https://cdn.acme.com/default-avatar.png",
    "default_organization_profile_image_url": "https://cdn.acme.com/default-org.png",
    "default_workspace_profile_image_url": "https://cdn.acme.com/default-workspace.png",
    "use_initials_for_user_profile_image": true,
    "use_initials_for_organization_profile_image": true,
    "logo_image_url": "https://cdn.acme.com/logo.svg",
    "signup_terms_statement": "By signing up, you agree to our Terms of Service and Privacy Policy.",
    "signup_terms_statement_shown": true,
    "light_mode_settings": {
      "primary_color": "#2563eb",
      "background_color": "#ffffff",
      "text_color": "#1f2937"
    },
    "dark_mode_settings": {
      "primary_color": "#3b82f6",
      "background_color": "#111827",
      "text_color": "#f9fafb"
    },
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  "session": {
    "signin_attempts": [],
    "signins": [],
    "signup_attempts": [],
    "active_signin": null
  },
  "errors": []
}

Response

Deployment UI settings retrieved successfully

status
integer
required

HTTP status code

message
string
required

Response message (empty for success)

data
any
required

Response data (can be any type)

session
object
required
errors
object[]
required

Array of error objects (empty for success)