Method: legacySoarPermissionGroups.list

Full name: projects.locations.instances.legacySoarPermissionGroups.list

Lists LegacySoarPermissionGroups.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/legacySoarPermissionGroups

Path parameters

Parameters
parent

string

Required. The instance to list LegacySoarPermissionGroups for. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarPermissionGroups

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of LegacySoarPermissionGroups to return. The service may return fewer than this value. If unspecified, at most 50 LegacySoarPermissionGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous legacySoarPermissionGroups.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of LegacySoarPermissionGroups. Supported filter fields: * displayName: Filter by the display label. * permissionGroupIds: Filter by the permission group ids. * socRoleIds: Filter by the soc role ids. * environments: Filter by the environments. * groupMembers: Filter by the group members. Example: filter="displayName='displayName'"
orderBy

string

Optional. Configures ordering of LegacySoarPermissionGroups in the response. If not specified, LegacySoarPermissionGroups are returned in descending order of their display label. The default ordering is by display label in descending order. The orderBy string is a comma separated list of fields. Supported fields: * displayName example: "displayName desc"

Request body

The request body must be empty.

Response body

Response message for legacySoarPermissionGroups.list.

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

JSON representation 
{
  "legacySoarPermissionGroups": [
    {
      object (LegacySoarPermissionGroup)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
legacySoarPermissionGroups[]

object (LegacySoarPermissionGroup)

The list of LegacySoarPermissionGroups.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

Total number of LegacySoarPermissionGroups.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.legacySoarPermissionGroups.get

For more information, see the IAM documentation.

LegacySoarPermissionGroup

Represents a Legacy SOAR Permission Group.

JSON representation 
{
  "id": string,
  "permissions": [
    {
      object (LegacySoarPermission)
    }
  ],
  "restrictedActions": [
    string
  ]
}
Fields
id

string (int64 format)

The id of the LegacySoarPermissionGroup.
permissions[]

object (LegacySoarPermission)

Optional. The permissions of the LegacySoarPermissionGroup.
restrictedActions[]

string (int64 format)

Optional. The restricted actions ids of the LegacySoarPermissionGroup.

LegacySoarPermission

Represents a single SoarPermission within a LegacySoarPermissionGroup.

JSON representation 
{
  "permissionIdentifier": string,
  "isEnabled": boolean
}
Fields
permissionIdentifier

string

The identifier of the SoarPermission.
isEnabled

boolean

Optional. Whether the SoarPermission is enabled in the LegacySoarPermissionGroup.