ProfileSessionSetting

Represents a profile’s session settings. Use ProfileSessionSetting to retrieve the session settings for a given profile.

This type extends Metadata and inherits its fields.

ProfileSessionSetting components have the suffix .profileSessionSetting and are stored in the profileSessionSettings folder.

Introduced in API version 40.0.

• Type: boolean
• Required: Yes

• Type: boolean
• Required: Yes

• Type: string
• Required: Yes
• Description: Required. Name of the user profile.

• Type: SessionSecurityLevel (enumeration of type string)
• Required: No
• Description: Session security level.

• Type: boolean
• Required: Yes
• Description: Beta. If true, keep users logged in to their Experience Cloud site until the session times out—even if they close their browser. Use sessionPersistence to reduce how often users must log in to their site. Applies only to the External Identity profile.

• Type: int (enumeration of type string)
• Required: Yes
• Description: Required. Specifies how many minutes of inactivity elapse before a user’s authenticated session times out. At the end of the session, the user must log in again. This session timeout value applies to users of the profile and overrides the org-wide timeout value. Changes to the org-wide timeout value don’t apply to users of this profile.
• Possible values:
  • 0 — 2 Hours
  • 15 — 15 Minutes
  • 30 — 30 Minutes
  • 60 — 1 Hour
  • 90 — 90 Minutes
  • 120 — 2 Hours
  • 240 — 4 Hours
  • 480 — 8 Hours
  • 720 — 12 Hours
  • 1440 — 24 Hours

• Type: boolean
• Required: Yes

Session security levels control access to certain types of resources based on the type of authentication used for logging in to the current session. For example, username and password authentication requires the standard session security level. Multi-factor authentication (MFA) requires HIGH_ASSURANCE.

The following is an example of a ProfileSessionSetting component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ProfileSessionSetting xmlns="http://soap.sforce.com/2006/04/metadata">
3    <profile>platformportal</profile>
4    <requiredSessionLevel>HIGH_ASSURANCE</requiredSessionLevel>
5    <sessionTimeout>1440</sessionTimeout>
6</ProfileSessionSetting>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.