Create a saved search

POST 
/saved-searches

Creates a new saved search.

Request

application/json

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

201

The persisted saved search.

application/json

Schema

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, MACHINE_IDENTITY, 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.

Example (from schema)

{
  "id": "0de46054-fe90-434a-b84e-c6b3359d0c64",
  "owner": {
    "type": "IDENTITY",
    "id": "2c91808568c529c60168cca6f90c1313"
  },
  "ownerId": "2c91808568c529c60168cca6f90c1313",
  "public": false,
  "name": "Disabled accounts",
  "description": "Disabled accounts",
  "created": "2018-06-25T20:22:28.104Z",
  "modified": "2018-06-25T20:22:28.104Z",
  "indices": [
    "identities"
  ],
  "columns": {
    "identity": [
      {
        "field": "displayName",
        "header": "Display Name"
      },
      {
        "field": "e-mail",
        "header": "Work Email"
      }
    ]
  },
  "query": "@accounts(disabled:true)",
  "fields": [
    "disabled"
  ],
  "orderBy": {
    "identity": [
      "lastName",
      "firstName"
    ],
    "role": [
      "name"
    ]
  },
  "sort": [
    "displayName"
  ],
  "filters": {
    "attributes.cloudAuthoritativeSource": {
      "type": "EXISTS",
      "exclude": true
    },
    "accessCount": {
      "type": "RANGE",
      "range": {
        "lower": {
          "value": "3"
        }
      }
    },
    "created": {
      "type": "RANGE",
      "range": {
        "lower": {
          "value": "2019-12-01",
          "inclusive": true
        },
        "upper": {
          "value": "2020-01-01"
        }
      }
    },
    "source.name": {
      "type": "TERMS",
      "terms": [
        "HR Employees",
        "Corporate Active Directory"
      ],
      "exclude": true
    },
    "protected": {
      "type": "TERMS",
      "terms": [
        "true"
      ]
    }
  }
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...