Class: Google::Apis::AccesscontextmanagerV1::SessionSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/accesscontextmanager_v1/classes.rb,
lib/google/apis/accesscontextmanager_v1/representations.rb,
lib/google/apis/accesscontextmanager_v1/representations.rb

Overview

Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SessionSettings

Returns a new instance of SessionSettings.



2057
2058
2059
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2057

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#max_inactivity ⇒ String

Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. Corresponds to the JSON property maxInactivity

Returns:

  • (String) 


2026
2027
2028
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2026

def max_inactivity
  @max_inactivity
end

#session_length ⇒ String

Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. Corresponds to the JSON property sessionLength

Returns:

  • (String) 


2034
2035
2036
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2034

def session_length
  @session_length
end

#session_length_enabled ⇒ Boolean Also known as: session_length_enabled?

Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. Corresponds to the JSON property sessionLengthEnabled

Returns:

  • (Boolean) 


2040
2041
2042
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2040

def session_length_enabled
  @session_length_enabled
end

#session_reauth_method ⇒ String

Optional. Session method when users GCP session is up. Corresponds to the JSON property sessionReauthMethod

Returns:

  • (String) 


2046
2047
2048
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2046

def session_reauth_method
  @session_reauth_method
end

#use_oidc_max_age ⇒ Boolean Also known as: use_oidc_max_age?

Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. Corresponds to the JSON property useOidcMaxAge

Returns:

  • (Boolean) 


2054
2055
2056
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2054

def use_oidc_max_age
  @use_oidc_max_age
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/google/apis/accesscontextmanager_v1/classes.rb', line 2062

def update!(**args)
  @max_inactivity = args[:max_inactivity] if args.key?(:max_inactivity)
  @session_length = args[:session_length] if args.key?(:session_length)
  @session_length_enabled = args[:session_length_enabled] if args.key?(:session_length_enabled)
  @session_reauth_method = args[:session_reauth_method] if args.key?(:session_reauth_method)
  @use_oidc_max_age = args[:use_oidc_max_age] if args.key?(:use_oidc_max_age)
end