List roles

List roles in Trend Micro.

Options

Field Definition Type Required
Result Set

Choose one of the following options to display your results:

  • First 200 Records: Returns the first 200 records.

  • Stream Records: Passes all records from your parent flow to a helper flow.

Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

 Dropdown TRUE

To learn how to use the Stream Records option and set up a helper flow to return a large number of records, see Stream matching records with a helper flow.

Input

Field Definition Type Required
Streaming
Flow

Click Choose Flow to browse and select a helper flow as the destination for the records. Click Choose to confirm.

Each record triggers one execution of the flow. User data is referenced through the Record input object in the helper flow.

Optionally, you can click the empty field under Click or drop here to create to add custom extensible fields that pass data to the helper flow. These fields are added as key and value pairs under the State input object in the helper flow.

Flow

 TRUE
Record Limit

Specify the number of records to stream.

  • The Record Limit field can't be set to 0. When it's set to greater than 1, the stream returns up to the maximum number specified.

  • When the Record Limit field is empty, null, or not selected, the stream returns all records.

  • The default value is 1000000 (1 million).

  • The valid range is from 1 to 1000000.

 Number FALSE

Output

Field Definition Type
Result
Roles

A list of up to 200 roles are returned. This list contains the output fields for each role as individual objects.

This field appears when you select the First 200 Records from the Result Set option.

 List of Objects
ID

The unique identifier of the role.

 Text
Name

The name of the role.

 Text
Type

The type of role.

  • Predefined Role

  • Custom Role.

 Text
Description

The description of the role.

 Text
Last Updated Date Time

The last time the role was updated.

 Date & Time
Allow Api Key Assignment

If True, the role can be assigned to an API key.

True/False
Allow User Account Assignment

If True the role can be assigned to an account.

True/False
Raw Output

The raw response object of a role returned by the API.

 Object
Records Streamed

The number of records streamed in a streaming flow.

This field appears when you select Stream Records from the Result Set option.

 Number