Use the PUT /session/authenticationSessionPolicies/{{policyId}} endpoint to update the session policy with the matching ID. If the policy is not properly configured, a 422 status code is returned along with a list of validation errors that must be corrected.

Path parameters

Parameter Value Description
policyId string(required) ID of the session policy to update.

Status codes

Code Reason
200 Authentication session policy updated.
400 The request was improperly formatted or contained invalid fields.
403 PingFederate does not have the appropriate IdP/SP role enabled. Operation not available.
404 Resource not found.
422 Validation error(s) occurred.

AuthenticationSessionPolicy - The session policy for a specified authentication source.

Property Type Description
authenticationSource * AuthenticationSource The authentication source this session policy applies to. This property cannot be changed after the policy is created.
authnContextSensitive boolean Determines whether the requested authentication context is considered when deciding whether an existing session is valid for a given request. The default is false.
enableSessions * boolean Determines whether sessions are enabled for the authentication source. This value overrides the enableSessions value from the global authentication session policy.
id string The persistent, unique ID for the session policy. It can be any combination of [a-z0-9._-]. This property is system-assigned if not specified.
idleTimeoutMins integer The idle timeout period, in minutes. If omitted, the value from the global authentication session policy will be used. If set to -1, the idle timeout will be set to the maximum timeout. If a value is provided for this property, a value must also be provided for maxTimeoutMins.
maxTimeoutMins integer The maximum timeout period, in minutes. If omitted, the value from the global authentication session policy will be used. If set to -1, sessions do not expire. If a value is provided for this property, a value must also be provided for idleTimeoutMins.
persistent boolean Determines whether sessions for the authentication source are persistent. This value overrides the persistentSessions value from the global authentication session policy. This field is ignored if enableSessions is false.
timeoutDisplayUnit SessionTimeUnit The display unit for session timeout periods in the PingFederate administrative console. When the display unit is HOURS or DAYS, the timeout values in minutes must correspond to a whole number value for the specified unit.

AuthenticationSource - An authentication source (IdP adapter or IdP connection).

Property Type Description
sourceRef * ResourceLink A reference to the authentication source.
type * AuthenticationSourceType The type of this authentication source.

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.