Search entitlement bundles

List all or a subset of entitlement bundles defined 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 bundles:

  • 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.

  • Greater Than: Filter the output based on whether the object name is greater than the specified string. Uses case-sensitive pattern matching.

  • Greater than or Equal to: Filter the output based on whether the object name is greater than or equal to the specified string. Uses case-sensitive pattern matching.

  • Less Than: Filter the output based on whether the object name is less than the specified string. Uses case-sensitive pattern matching.

  • Less than or Equal to: Filter the output based on whether the object name is less than or equal to the specified string. Uses case-sensitive pattern matching.

Dropdown TRUE

Input

Field Definition Type Required

Search

Name

The name of the entitlement bundle.

Text FALSE

Target Resource ORN

The target resource ORN of the entitlement bundle.

Text FALSE

Target External ID

The external unique identifier of the target of the entitlement bundle.

Text FALSE

Target Type

The target type of the entitlement bundle.

Text FALSE

Status

The status of the entitlement bundle.

Text FALSE

Last Updated

The date that the entitlement bundle was last updated.

Date & Time 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

Bundles

List of Objects

Raw Output

The raw JSON response from the API.

Object

ID

The unique identifier of the object.

Text

Name

The name of the entitlement bundle.

Text

Description

A description of the entitlement bundle.

Text

Created

The date and time when the resource was created.

Date & Time

Created By

The unique identifier of the Okta user who created the resource.

Text

Last Updated

The date and time when the object was last updated.

Date & Time

Last Updated By

The unique identifier of the Okta user who last updated the object.

Text

Status

The lifecycle status of the entitlement bundle:

  • An entitlement bundle has a status of ACTIVE after creation.
  • When the bundle is deleted, it has a status of DELETED.

When the entitlement bundle is purged, it isn't returned in a GET operation.

Text

Links

The links that are available in the list response.

Object

Self

A link to a related RESTful resource.

Object

Target Resource ORN

The Okta resource in ORN format.

Text

Target

Object

External ID

The Okta app ID of the resource.

Text

Type

The type of resource.

List of Objects

Entitlements

List of Objects

ID

The unique identifier of the entitlement.

Text

Values

A collection of entitlement value identifiers.

List of Objects

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