REST Resource: projects.locations.instances.legacySoarIdpMappingGroups

Resource: LegacySoarIdpMappingGroup

Allows Google SecOps platform customers to map IdP groups in the IdP Mapping page to SOAR environments, SOC roles, and permission groups.

JSON representation 
{
  "name": string,
  "displayName": string,
  "permissionGroupIds": [
    integer
  ],
  "socRoleIds": [
    integer
  ],
  "environments": [
    string
  ],
  "groupMembers": [
    {
      object (GroupMember)
    }
  ],
  "externalProviderName": string,
  "platforms": [
    string
  ],
  "workforcePoolId": string,
  "defaultMapping": boolean,
  "additionalPermissions": {
    object (AdditionalPermissions)
  }
}
Fields
name

string

Identifier. The unique name(ID) of the LegacySoarIdpMappingGroup. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarIdpMappingGroups/{legacySoarIdpMappingGroup}
displayName

string

Required. LegacySoarIdpMappingGroup display name, limited to 4096 characters.
permissionGroupIds[]

integer

Optional. The permissions will be attached to users associated with the idp-group.
socRoleIds[]

integer

Optional. The SocRoles will be attached to users associated with the idp-group.
environments[]

string

Required. IdpMapping associated with logical environments.
groupMembers[]

object (GroupMember)

Optional. Group members associated with the idp-group.
externalProviderName

string

Optional. The external provider name. This is the name of the external provider that will be used to map the idp-group.
platforms[]

string (int64 format)

Optional. The platforms that will be used to map the idp-group. These are the platforms that will be mapped to the idp-group.
workforcePoolId

string

Optional. The workforce pool id that will be used to map the multiple IDPs. This is the workforce pool id that will be mapped to the idp-group.
defaultMapping

boolean

Optional. The default mapping flag that will be used to map the default access settings for IDP in workforce pool. This is the default mapping flag that will be mapped to the IDP in workforce pool.
additionalPermissions

object (AdditionalPermissions)

Optional. Additional permissions to be attached to users associated with the idp-group.

GroupMember

Define the Group member type.

JSON representation 
{
  "groupMemberId": string,
  "idpGroupId": string
}
Fields
groupMemberId

string

Required. The ID of the group member.
idpGroupId

string

Required. The ID of the IdP group associated with the group member.

AdditionalPermissions

Additional permissions to be attached to users associated with the idp-group.

JSON representation 
{
  "restrictedCaseWallActions": [
    enum (RestrictedCaseWallAction)
  ],
  "restrictedActionIds": [
    string
  ]
}
Fields
restrictedCaseWallActions[]

enum (RestrictedCaseWallAction)

Optional. The restricted case wall actions. These are the filter types that will be restricted to the users associated with the idp-group.
restrictedActionIds[]

string (int64 format)

Optional. The restricted action ids. These are the action ids that will be restricted to the users associated with the idp-group.

RestrictedCaseWallAction

The restricted case wall actions enum.

Enums
RESTRICTED_CASE_WALL_ACTION_UNSPECIFIED Unspecified restricted case wall actions.
ACTIONS Restricted case wall actions.
STATUS_CHANGES Restricted case wall status changes type.
TASKS Restricted case wall tasks type.
COMMENTS Restricted case wall comments type.
INSIGHTS Restricted case wall insights type.
PINNED_CHAT_MESSAGES Restricted case wall pinned chat messages type.
FAVORITE Restricted case wall favorite type.

Methods

batchUpdate

 Updates multiple IDP mapping groups in a single batch operation, allowing for efficient management of large numbers of mappings.

create

 Creates a new IDP mapping group to define how users from an external identity provider should be provisioned and restricted within the SecOps platform.

delete

 Deletes an IDP mapping group, removing the mapping between the external IdP group and SecOps resources.

get

 Retrieves a detailed configuration of a specific IDP mapping group identified by its resource name.

getExternalProviders

 Retrieves the external identity providers configured for the system.

list

 Returns a paginated list of all IDP mapping groups within a specific SecOps instance.

patch

 Updates an existing IDP mapping group.

updateDefaultAccessSettings

 Updates the default access settings for an external identity provider.