REST Resource: projects.locations.instances.legacySoarUsers

Resource: LegacySoarUser

Legacy SOAR users management.

JSON representation 
{
  "name": string,
  "firstName": string,
  "lastName": string,
  "socRoles": [
    integer
  ],
  "email": string,
  "avatar": string,
  "userType": enum (UserType),
  "environmentsJson": string,
  "permissionGroups": [
    {
      object (PermissionGroup)
    }
  ],
  "permissionGroupNames": [
    string
  ],
  "accountState": enum (AccountState),
  "loginIdentifier": string,
  "providerName": string,
  "allowedPlatforms": [
    string
  ],
  "displayName": string,
  "userFullName": string,
  "lastLoginTime": string
}
Fields
name

string

Identifier. The unique name(ID) of the LegacySoarUser. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarUsers/{legacySoarUser}
firstName

string

Required. User first name.
lastName

string

Required. User last name.
socRoles[]

integer (uint32 format)

Required. User's role in the SOC team.
email

string

Required. User email.
avatar

string

Optional. Avatar of the user in base 64 format.
userType

enum (UserType)

Required. User type.
environmentsJson

string

Required. User logical environments (json).
permissionGroups[]

object (PermissionGroup)

Output only. User permission groups (for GET/LIST).
permissionGroupNames[]

string

Required. User permission group names (for POST/PATCH).
accountState

enum (AccountState)

Output only. User account state.
loginIdentifier

string

Required. User unique login identifier. Relevant for IDP
providerName

string

Required. User identity provider provider name.
allowedPlatforms[]

string (int64 format)

Required. User allowed federated platforms.
displayName

string

Required. User display name.
userFullName

string

Required. User full name.
lastLoginTime

string (int64 format)

Output only. User last login time.

UserType

User type.

Enums
USER_TYPE_UNSPECIFIED Unspecified user type.
INTERNAL System managed user.
EXTERNAL Identity provider managed user.
SUPPORT Customer managed user.

PermissionGroup

Permission group dto (for GET/LIST).

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

string

Required. Permission group description.
id

string (int64 format)

Required. Permission group name.

AccountState

User account state.

Enums
ACCOUNT_STATE_UNSPECIFIED Unspecified account state.
DISABLED Disabled users cannot login into the system.
PENDING A state where users are invited into the system before their first login.
ACTIVE A state where users are actively using the system.

Methods

delete

 Delete a LegacySoarUser.

get

 Get a LegacySoarUser.

getLocalization

 Get a user Localization.

getNotificationSettings

 Gets the notification settings for a user.

list

 Lists LegacySoarUsers.

updateLocalization

 Update a user localization.

updateNotificationSettings

 Updates the notification settings for a user.