SnykGroupSettings

Model for Snyk Group Settings (v1 API).

  1. Overview

Overview

This model represents settings for a Snyk group, including session length and request access configuration.

Uses the Snyk v1 API endpoint: /group/{groupId}/settings

Usage

import clearskies
from clearskies_snyk.models.v1 import SnykGroupSettings


def my_handler(snyk_group_settings: SnykGroupSettings):
    # Get settings for a group
    settings = snyk_group_settings.find("group-id-123")
    print(f"Session length: {settings.session_length} minutes")
    print(f"Request access enabled: {settings.request_access_enabled}")

    # Update settings
    settings.session_length = 60
    settings.save()

Settings

  • session_length: Session timeout in minutes (1-43200, default 43200 = 30 days)
  • request_access: Whether users can request access to orgs in the group

Required Permissions

  • Admin access to the group
  • Edit access to request access settings (for updating request_access)