Method: instances.legacySystemMetadata

Full name: projects.locations.instances.legacySystemMetadata

Legacy Get System Metadata.

HTTP request


Path parameters

Parameters
instance

string

Required. The name of the parent resource, which is the SecOps instance to get LegacySystemMetadata for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

LegacyGetSystemMetadataResponse returns the system metadata.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "emptySystem": boolean,
  "landingPage": enum (LandingPageEnum),
  "highCompliance": boolean,
  "federationEnabled": boolean,
  "caseAssignmentPolicy": enum (CaseAssignmentPolicy),
  "moveCaseBetweenEnvironmentsPolicy": enum (MoveCaseBetweenEnvironmentsPolicy),
  "serverVersion": string
}
Fields
emptySystem

boolean

Output only. Indicates whether the system has no cases.
landingPage

enum (LandingPageEnum)

Output only. The main page after user login.
highCompliance

boolean

Output only. Indicates whether high-compliance settings are enabled for the user.
federationEnabled

boolean

Output only. Specifies if federation is enabled for the user's account.
caseAssignmentPolicy

enum (CaseAssignmentPolicy)

Output only. Specifies the case assignment policy.
moveCaseBetweenEnvironmentsPolicy

enum (MoveCaseBetweenEnvironmentsPolicy)

Output only. Specifies the policy for moving cases between environments.
serverVersion

string

Output only. Specifies the server version

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

LandingPageEnum

Indicates the user's landing page upon login.

Enums
LANDING_PAGE_ENUM_UNSPECIFIED Landing page is unspecified.
CASES_OVERVIEW Cases Overview as landing page.
CASES_WALL Cases Wall as landing page.
HOMEPAGE_MY_CASES Home Page My Cases as landing page.
HOMEPAGE_PENDING_ACTIONS Home Page Pending Actions as landing page.
HOMEPAGE_REQUESTS Home Page Requests as landing page.
DASHBOARDS Dashboards as landing page.
REPORTS Reports as landing page.
PLAYBOOKS Playbooks as landing page.
SEARCH Search as landing page.
COMMAND_CENTER Command Center as landing page.
SIEM_HOMEPAGE SIEM Home Page as landing page.
SIEM_SEARCH_LEGACY SIEM Search Legacy as landing page.

CaseAssignmentPolicy

Determines the environments from which users can be assigned to cases.

Enums
CASE_ASSIGNMENT_POLICY_UNSPECIFIED Case assignment policy is unspecified.
ALLOW_USERS_ONLY_FROM_PERMITTED_ENVIRONMENTS Users can be assigned to cases only from permitted environments.
ALLOW_USERS_FROM_ALL_ENVIRONMENTS Users can be assigned to cases from all environments.

MoveCaseBetweenEnvironmentsPolicy

Controls whether cases can be moved between environments.

Enums
MOVE_CASE_BETWEEN_ENVIRONMENTS_POLICY_UNSPECIFIED Move case between environments policy is unspecified.
DENY Cases cannot be moved between environments.
ALLOW Cases can be moved between environments.