Search entitlements

Search and retrieve entitlements for a given resource in Okta Identity Governance.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First Matching Record: Returns the first record that matches.

  • First 200 Matching Records: Returns the first 200 matching records.

  • Stream Matching Records: Passes all matching 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

Search By

Choose one of the following options to search for entitlement:

  • Equals: Filter the output based on whether the object name is equal to the specified string. Uses case-sensitive pattern matching.

  • Contain: Filter the output based on whether the object name contains the specified string. Uses case-sensitive pattern matching.

  • Starts With: Filter the output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.

 Dropdown FALSE

Input

Field Definition Type Required

Parent

External ID

The Okta app ID of the resource.

Text TRUE

Resource ORN

The Okta resource in ORN format.

Text FALSE

Search

Name

The display name of the entitlement property.

Text FALSE

Streaming

Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

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

Flow

 TRUE

Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, the stream returns no records.

  • When the Limit field is set to greater than 0, the stream returns up to the maximum number specified.

  • When the 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 0 to 1000000.

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

 Number FALSE

Output

Field Definition Type

Result

Entitlements

List of Objects

Raw Output

The raw JSON response from the API.

Object

ID

The unique identifier of the entitlement property.

Text

Name

The display name of the entitlement property.

Text

External Value

The value of the entitlement property.

Text

Parent

Object

Parent Resource ORN

The Okta app instance in ORN format.

Text

Data Type

The data type of the entitlement property.

If the entitlement property is multi-valued, the data type is replaced with an array.

 Text

Multi Value

If true, the property can hold multiple values.

If true, the data type is replaced with an array.

 True/False

Required

If true, the entitlement property is a required attribute.

True/False

Description

A description of the entitlement value.

Text

Links

The links that are available in the list response.

 Object

Metadata

The metadata of the list response.

Object

Records Streamed

Number of records streamed in a streaming flow.

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

 Number