Method: legacyPlaybooks.legacyPermissionsOptions

Full name: projects.locations.instances.legacyPlaybooks.legacyPermissionsOptions

legacyPlaybooks.legacyPermissionsOptions return playbook access permission options. This should be used to fetch information when creating a new playbook, where we do not have yet workflow guid.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the permissions options for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "legacyPayload": [
    string
  ]
}
Fields
legacyPayload[]

string

Required. The playbook environments.

Response body

LegacyPlaybookPermissionsOptionsResponse is a response for getting the permissions options.

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

JSON representation 
{
  "userOptions": [
    {
      object (AccessPermissionProfileInfoOption)
    }
  ],
  "socRolesOptions": [
    {
      object (LegacyPlaybookSocRole)
    }
  ]
}
Fields
userOptions[]

object (AccessPermissionProfileInfoOption)

Optional. UserOptions is a list of user options.
socRolesOptions[]

object (LegacyPlaybookSocRole)

Optional. LegacyPlaybookSocRolesOptions is a list of soc roles options.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AccessPermissionProfileInfoOption

AccessPermissionProfileInfoOption represents a user option for access permissions.

JSON representation 
{
  "firstName": string,
  "lastName": string,
  "fullName": string,
  "role": enum (UserProfileRole),
  "socRoleId": string,
  "socRoleIds": [
    string
  ],
  "email": string,
  "userName": string,
  "imageBase64": string,
  "userType": enum (UserProfileType),
  "allowEditOption": boolean,
  "hasModuleEditPermissions": boolean,
  "hasAllEnvsPermissions": boolean,
  "hasAllEnvsModulePermissions": boolean
}
Fields
firstName

string

Required. FirstName is the first name of the user.
lastName

string

Required. LastName is the last name of the user.
fullName

string

Required. FullName is the full name of the user.
role

enum (UserProfileRole)

Required. Role is the role of the user.
socRoleId

string (int64 format)

Optional. SocRoleId is the identifier of the soc role.
socRoleIds[]

string (int64 format)

Optional. SocRoleIds is a list of identifiers of the soc roles.
email

string

Required. Email is the email of the user.
userName

string

Required. UserName is the user name of the user.
imageBase64

string

Optional. ImageBase64 is the base64 image of the user.
userType

enum (UserProfileType)

Required. UserType is the type of the user.
allowEditOption

boolean

Optional. AllowEditOption indicates if the user is allowed to edit.
hasModuleEditPermissions

boolean

Optional. HasModuleEditPermissions indicates if the user has module edit permissions.
hasAllEnvsPermissions

boolean

Optional. HasAllEnvsPermissions indicates if the user has all environments permissions.
hasAllEnvsModulePermissions

boolean

Optional. HasAllEnvsModulePermissions indicates if the user has all environments module permissions.

UserProfileRole

UserProfileRole represents the role of a user.

Enums
USER_PROFILE_ROLE_UNSPECIFIED The role is unspecified.
ANALYST The role is analyst.
ADMIN The role is admin.

UserProfileType

UserProfileType represents the type of a user profile.

Enums
USER_PROFILE_TYPE_UNSPECIFIED The user profile type is unspecified.
WINDOWS The user profile type is windows.
INTERNAL The user profile type is internal.
EXTERNAL The user profile type is external.
SUPPORT The user profile type is support.
INCIDENT_MANAGER The user profile type is incident manager.

LegacyPlaybookSocRole

LegacyPlaybookSocRole represents a soc role.

JSON representation 
{
  "name": string,
  "displayName": string,
  "additionalRolesAccess": [
    {
      object (LegacyPlaybookSocRoleAccess)
    }
  ],
  "id": integer,
  "tenantId": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "isDefault": boolean
}
Fields
name

string

Required. Name is the name of the soc role.
displayName

string

Optional. DisplayName is the display name of the soc role.
additionalRolesAccess[]

object (LegacyPlaybookSocRoleAccess)

Optional. AdditionalRolesAccess is a list of additional roles access.
id

integer

Optional. Id is the unique identifier of the soc role.
tenantId

string

Optional. TenantId is the tenant id of the soc role.
creationTimeUnixTimeInMs

string (int64 format)

Optional. CreationTimeUnixTimeInMs is the creation time of the soc role in milliseconds.
modificationTimeUnixTimeInMs

string (int64 format)

Optional. ModificationTimeUnixTimeInMs is the modification time of the soc role in milliseconds.
isDefault

boolean

Optional. IsDefault indicates if the soc role is default.

LegacyPlaybookSocRoleAccess

LegacyPlaybookSocRoleAccess represents a soc role access.

JSON representation 
{
  "id": string,
  "name": string
}
Fields
id

string (int64 format)

Required. Id is the unique identifier of the soc role access.
name

string

Required. Name is the name of the soc role access.