Retrieve security settings

Prev Next
Get
/v1alpha/security-config

Retrieves the current security settings for the workspace, including session expiration, inactivity timeout, and SSO-only mode.

Security
HTTP
Type bearer
Responses
200

Security settings retrieved successfully.

Expand All
object
settings
object (v1alphaSecuritySettings)

Security Settings represents the security settings for a workspace. You must be a workspace owner to modify the settings.

session_expiration
string

The sesssion expiration defines how long a session remains valid before requiring the user to reauthenticate their login. Any unsaved work will be saved. Options include: Never, 8 hours, 12 hours, 24 hours, 7 days, and 30 days. The default session expiration is 'Never'.

inactivity_timeout
string

The period of inactivity after which the user will be logged out. If no activity is detected within this time frame, any unsaved work will be saved and the user will be automatically logged out. Options include: 30 minutes, 1 hour, 4 hours, 8 hours, 12 hours, and 24 hours. The default inactivity timeout is '12 hours'.

sso_only
boolean

Defines the SSO mode for the workspace. Set to 'true' to prevent invitation of new local users to the workspace.

updated_by
string

The email address of the user who last modified the settings.

created_at
string (date-time)

The timestamp when the configuration was created.

updated_at
string (date-time)

The timestamp when the configuration was last modified.

401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object