System Configuration

Save company authentication type

Updates the authentication method used for user login. Accepts 'emailAddress' or 'userId'.

put/api/v1/configuration/authentication

Request body

authType'emailAddress' | 'userId' | 'emailAddress' | 'userId' required

Authentication type: 'emailAddress' or 'userId'

Example request

{
  "authType": "emailAddress"
}

Response

Authentication type updated successfully

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "companyId": "dotcms.org",
    "companyName": "dotcms.org",
    "portalURL": "http://localhost:8080",
    "emailAddress": "admin@dotcms.com",
    "mx": "dotcms.com",
    "primaryColor": "#C336E5",
    "secondaryColor": "#54428E",
    "backgroundColor": "#3C1361",
    "backgroundImage": "/dA/abc123/background.png",
    "loginScreenLogo": "/dA/abc123/logo.png",
    "navBarLogo": "/dA/abc123/nav-logo.png",
    "authType": "emailAddress",
    "languageId": "en_US",
    "timeZoneId": "America/New_York"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.