Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /siem/offenses/{offense_id}/assignable_actors

SUMMARY Retrieve assignable actors.

Retrieves the list of actors which can be assigned to the current offense.

Table 1: GET /siem/offenses/{offense_id}/assignable_actors resource details:

GET /siem/offenses/{offense_id}/assignable_actors resource details
MIME Type

application/json

Table 2: GET /siem/offenses/{offense_id}/assignable_actors request parameter details:

GET /siem/offenses/{offense_id}/assignable_actors request parameter details
Parameter Type Optionality Data Type MIME Type Description

offense_id

path

Required

Number (Integer)

text/plain

Required - The offense for the provided offense ID.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.
Table 3: GET /siem/offenses/{offense_id}/assignable_actors response codes:

GET /siem/offenses/{offense_id}/assignable_actors response codes
HTTP Response Code Unique Code Description

200

The assignable actors for this offense were retrieved.

404

85101001

No offense was found for the provided offense_id.

422

85101030

The sort field or order is not valid.

Response Description

A collection of Assignable Actor objects. An Assignable Actor object contains the following fields:
  • user_id - the user ID of the actor.
  • username - the username of the actor.
  • description - the description of the actor.

Response Sample