ConnectCloud Developers

Save display and login settings (hr:admin)

PUT /api/hr/v1/settings

Module: HR · operationId: setSettings · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

Request body

application/json (required)

  • displayFields (array of string): Field keys whose values make up the display name of employees
  • loginDomains (array of string): Lowercase FQDNs of the tenant. Omitted on save keeps the stored list. A domain belongs to one customer only (409 domain_taken).
  • loginPolicy (string): Omitted on save keeps the stored value. Default create_user. (one of create_user, existing_only)
  • subdomain (string): The tenant's label on the platform domain (<subdomain>.on.<domain>); its mail addresses hang below it. Unique on the platform, platform names (www, portal, mail, …) are reserved. Omitted or empty on save keeps the stored value; once set it cannot be changed (400, field subdomain). A subdomain another tenant has is 400 as well.

Example:

{
  "displayFields": [
    "first_name",
    "last_name"
  ],
  "loginDomains": [
    "muster-it.example"
  ],
  "loginPolicy": "existing_only",
  "subdomain": "demo"
}

Responses

  • 200 Saved (application/json)
  • 400 Error (application/json)
  • 409 Error (application/json)

Fields of the 200 answer:

  • displayFields (array of string): Field keys whose values make up the display name of employees
  • loginDomains (array of string): Lowercase FQDNs of the tenant. Omitted on save keeps the stored list. A domain belongs to one customer only (409 domain_taken).
  • loginPolicy (string): Omitted on save keeps the stored value. Default create_user. (one of create_user, existing_only)
  • subdomain (string): The tenant's label on the platform domain (<subdomain>.on.<domain>); its mail addresses hang below it. Unique on the platform, platform names (www, portal, mail, …) are reserved. Omitted or empty on save keeps the stored value; once set it cannot be changed (400, field subdomain). A subdomain another tenant has is 400 as well.

Example 200 answer:

{
  "displayFields": [
    "first_name",
    "last_name"
  ],
  "loginDomains": [
    "muster-it.example"
  ],
  "loginPolicy": "existing_only",
  "subdomain": "demo"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/hr/v1/settings' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"displayFields":["first_name","last_name"],"loginDomains":["muster-it.example"],"loginPolicy":"existing_only","subdomain":"demo"}'

View as Markdown · Interactive reference · OpenAPI