Optional User Parameters

photos

The photo parameter may be added directly to the user schema:

Parameter	Description	Allowed Values
photos	Gets the user's user-profile photo from the link provided.	You must provide both a value and type. "value": "`<Photo URL">`" "type": "photo" Note The photo server must be allowlisted or an error will be returned. To allowlist a server, log on to SAP Analytics Cloud, go to System Administration System Configuration and add one or more links to Profile Picture URLs.

Parameter

Description

Allowed Values

photos

Gets the user's user-profile photo from the link provided.

You must provide both a value and type.

"value": "<Photo URL">"
"type": "photo"

Example:

"photos": [
  {
    "value": "https://myphotos.com/profile.png",
    "type": "photo"
  }
],

preferredLanguage

The preferredLanguage parameter may be added directly to the user schema:

Parameter	Description	Allowed Values	Default Value
preferredLanguage	The language to view SAP Analytics Cloud in.	ISO 639-1 two-letter language code. For example, `en`. Concatenation of an ISO 639-1 two-letter language code, a dash, and ISO 3166-1 two-letter country code. For example, `en-us`.	`en`

Example:

"preferredLanguage": "en",

user-custom-parameters

The following parameters must be included in an urn:ietf:params:scim:schemas:extension:sap:user-custom-parameters:1.0 block within the user schema.

Parameter	Description	Allowed Values	Default Value
cleanUpNotificationsNumberOfDays	The date after which you want the system to delete notifications. Otherwise, the system keeps the most recent 500 notifications.	0,1,3,7, or 14 Note When set to 0, notifications are never deleted.	0
dataAccessLanguage	The default language for displaying stories created from live data connections.	ISO 639-1 two-letter language code. For example, `en`. Concatenation of an ISO 639-1 two-letter language code, a dash, and ISO 3166-1 two-letter country code. For example, `en-us`.	`en`
dateFormatting	The date display format.	`MMM d, yyyy` `MMM dd, yyyy` `yyyy.MM.dd` `dd.MM.yyyy` `MM.dd.yyyy` `yyyy/MM/dd` `dd/MM/yyyy` `MM/dd/yyyy`	`MMM d, yyyy`
isConcurrent	Set whether or not the user has a concurrent license.	`true` or `false` Note This parameter will only take effect if the user is assigned one or more BI roles, or a combination of BI and Analytics Hub roles. It is ignored for any user assigned a Planning role. For more information, see Standard Application Roles.	`false`
marketingEmailOptIn	To email the user information about product updates and learning opportunities, enable this feature.	`true` or `false`	`false`
numberFormatting	The number format.	`1,234.56`, `1.234,56` or `1 234,56`	`1,234.56`
preferredLanguage	The language to view SAP Analytics Cloud in.	ISO 639-1 two-letter language code. For example, `en`. Concatenation of an ISO 639-1 two-letter language code, a dash, and ISO 3166-1 two-letter country code. For example, `en-us`.	`en`
systemNotificationsEmailOptIn	To email the user information on system activities, for example when a new password is set, enable this feature.	`true` or `false`	`true`
timeFormatting	The time display format.	`H:mm:ss`, `h:mm:ss a` or `h:mm:ss A` Note `H:mm:ss` corresponds to 24-Hour Format. For example, 16:05:10. `h:mm:ss a` corresponds to 12-Hour Format. For example, 4:05:10 p.m. `h:mm:ss A` corresponds to 12-Hour Format. For example, 4:05:10 PM.	`H:mm:ss`

Example:

"urn:ietf:params:scim:schemas:extension:sap:user-custom-parameters:1.0": {
  "dataAccessLanguage": "en",
  "dateFormatting": "MMM d, yyyy",
  "timeFormatting": "H:mm:ss",
  "numberFormatting": "1,234.56",
  "cleanUpNotificationsNumberOfDays": 0,
  "systemNotificationsEmailOptIn": true,
  "marketingEmailOptIn": false,
  "isConcurrent": true
},

For more information, see the example response in /scim/Users.