Skip to main content

Create a saved search

POST 

/saved-searches

Creates a new saved search.

Request

Body

required

The saved search to persist.

    name string

    The name of the saved search.

    description stringnullable

    The description of the saved search.

    created date-timenullable

    The date the saved search was initially created.

    modified date-timenullable

    The last date the saved search was modified.

    indices Index (string)[]required

    Possible values: [accessprofiles, accountactivities, entitlements, events, identities, roles, *]

    The names of the Elasticsearch indices in which to search.

    columns

    object

    The columns to be returned (specifies the order in which they will be presented) for each document type.

    The currently supported document types are: accessprofile, accountactivity, account, aggregation, entitlement, event, identity, and role.

    property name*

    object[]

  • Array [

  • field stringrequired

    The name of the field.

    header string

    The value of the header.

  • ]

  • query stringrequired

    The search query using Elasticsearch Query String Query syntax from the Query DSL.

    fields string[]nullable

    The fields to be searched against in a multi-field query.

    orderBy

    object

    nullable

    Sort by index. This takes precedence over the sort property.

    property name*

    string[]

    nullable

  • Array [

  • string

  • ]

  • sort string[]nullable

    The fields to be used to sort the search results.

    filters

    object

    nullable

    The filters to be applied for each filtered field name.

    type FilterType (string)

    Possible values: [EXISTS, RANGE, TERMS]

    Enum representing the currently supported filter types. Additional values may be added in the future without notice.

    range

    object

    The range of values to be filtered.

    lower

    object

    The lower bound of the range.

    value stringrequired

    The value of the range's endpoint.

    inclusive boolean

    Indicates if the endpoint is included in the range.

    upper

    object

    The upper bound of the range.

    value stringrequired

    The value of the range's endpoint.

    inclusive boolean

    Indicates if the endpoint is included in the range.

    terms string[]

    The terms to be filtered.

    exclude boolean

    Indicates if the filter excludes results.

Responses

The persisted saved search.

Schema

    id string

    The saved search ID.

    owner

    object

    The owner of the saved search.

    type DtoType (string)required

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

    An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

    id stringrequired

    The id of the object.

    ownerId string

    The ID of the identity that owns this saved search.

    public boolean

    Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time.

    name string

    The name of the saved search.

    description stringnullable

    The description of the saved search.

    created date-timenullable

    The date the saved search was initially created.

    modified date-timenullable

    The last date the saved search was modified.

    indices Index (string)[]required

    Possible values: [accessprofiles, accountactivities, entitlements, events, identities, roles, *]

    The names of the Elasticsearch indices in which to search.

    columns

    object

    The columns to be returned (specifies the order in which they will be presented) for each document type.

    The currently supported document types are: accessprofile, accountactivity, account, aggregation, entitlement, event, identity, and role.

    property name*

    object[]

  • Array [

  • field stringrequired

    The name of the field.

    header string

    The value of the header.

  • ]

  • query stringrequired

    The search query using Elasticsearch Query String Query syntax from the Query DSL.

    fields string[]nullable

    The fields to be searched against in a multi-field query.

    orderBy

    object

    nullable

    Sort by index. This takes precedence over the sort property.

    property name*

    string[]

    nullable

  • Array [

  • string

  • ]

  • sort string[]nullable

    The fields to be used to sort the search results.

    filters

    object

    nullable

    The filters to be applied for each filtered field name.

    type FilterType (string)

    Possible values: [EXISTS, RANGE, TERMS]

    Enum representing the currently supported filter types. Additional values may be added in the future without notice.

    range

    object

    The range of values to be filtered.

    lower

    object

    The lower bound of the range.

    value stringrequired

    The value of the range's endpoint.

    inclusive boolean

    Indicates if the endpoint is included in the range.

    upper

    object

    The upper bound of the range.

    value stringrequired

    The value of the range's endpoint.

    inclusive boolean

    Indicates if the endpoint is included in the range.

    terms string[]

    The terms to be filtered.

    exclude boolean

    Indicates if the filter excludes results.

Loading...