Updates an existing saved search

Updates an existing saved search.

NOTE: You cannot update the owner of the saved search.

Path Parameters

• id string required

  ID of the requested document.

  Example: 2c91808568c529c60168cca6f90c1313

application/json

Request Body required

The saved search to persist.

• id string

  The saved search ID.

• owner object

  The owner of the saved search.

  type 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]

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

  id string required

  The id of the object.

• name string

  The name of the saved search.

• description string

  The description of the saved search.

• public boolean

  Default value: false

  Indicates if the saved search is public.

• created date-time

  The date the saved search was initially created.

• modified date-time

  The last date the saved search was modified.

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

  type

  items object

  field string required

  The name of the field.

  header string

  The value of the header.

• query string required

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

• fields string[]

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

• sort string[]

  The fields to be used to sort the search results.

• filters object

  The filters to be applied for each filtered field name.

  type 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 string required

  The value of the range's endpoint.

  inclusive boolean

  Default value: false

  Indicates if the endpoint is included in the range.

  upper object

  The upper bound of the range.

  value string required

  The value of the range's endpoint.

  inclusive boolean

  Default value: false

  Indicates if the endpoint is included in the range.

  terms string[]

  The terms to be filtered.

  exclude boolean

  Default value: false

  Indicates if the filter excludes results.

Responses

• 200
• 400
• 401
• 403
• 429
• 500

---

The persisted saved search.

application/json

• Schema
• Example (from schema)

---

Schema

• id string

  The saved search ID.

• owner object

  The owner of the saved search.

  type string

  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]

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

  id string

  The id of the object.

• name string

  The name of the saved search.

• description string

  The description of the saved search.

• public boolean

  Default value: false

  Indicates if the saved search is public.

• created date-time

  The date the saved search was initially created.

• modified date-time

  The last date the saved search was modified.

• indices string[]

  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.

  type

  items object

  field string

  The name of the field.

  header string

  The value of the header.

• query string

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

• fields string[]

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

• sort string[]

  The fields to be used to sort the search results.

• filters object

  The filters to be applied for each filtered field name.

  type 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 string

  The value of the range's endpoint.

  inclusive boolean

  Default value: false

  Indicates if the endpoint is included in the range.

  upper object

  The upper bound of the range.

  value string

  The value of the range's endpoint.

  inclusive boolean

  Default value: false

  Indicates if the endpoint is included in the range.

  terms string[]

  The terms to be filtered.

  exclude boolean

  Default value: false

  Indicates if the filter excludes results.

{
  "id": "0de46054-fe90-434a-b84e-c6b3359d0c64",
  "owner": {
    "type": "IDENTITY",
    "id": "2c91808568c529c60168cca6f90c1313"
  },
  "name": "Disabled accounts",
  "description": "Disabled accounts",
  "public": false,
  "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"
  ],
  "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"
      ]
    }
  }
}

Client Error - Returned if the request body is invalid.

application/json

• Schema
• Example (from 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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

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

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

application/json

• Schema
• Example (from schema)
• 403

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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."
    }
  ]
}

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
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

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

application/json

• Schema
• Example (from schema)
• 500

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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