Create a saved search
POST/saved-searches
Creates a new saved search.
Request
- application/json
Body
required
The saved search to persist.
Array [
]
Array [
]
The name of the saved search.
The description of the saved search.
The date the saved search was initially created.
The last date the saved search was modified.
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[]
The name of the field.
The value of the header.
The search query using Elasticsearch Query String Query syntax from the Query DSL.
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
string
The fields to be used to sort the search results.
filters
object
nullable
The filters to be applied for each filtered field name.
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.
The value of the range's endpoint.
Indicates if the endpoint is included in the range.
upper
object
The upper bound of the range.
The value of the range's endpoint.
Indicates if the endpoint is included in the range.
The terms to be filtered.
Indicates if the filter excludes results.
Responses
- 201
- 400
- 401
- 403
- 429
- 500
The persisted saved search.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
The saved search ID.
owner
object
The owner of the saved search.
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.
The id of the object.
The ID of the identity that owns this saved search.
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.
The name of the saved search.
The description of the saved search.
The date the saved search was initially created.
The last date the saved search was modified.
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[]
The name of the field.
The value of the header.
The search query using Elasticsearch Query String Query syntax from the Query DSL.
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
string
The fields to be used to sort the search results.
filters
object
nullable
The filters to be applied for each filtered field name.
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.
The value of the range's endpoint.
Indicates if the endpoint is included in the range.
upper
object
The upper bound of the range.
The value of the range's endpoint.
Indicates if the endpoint is included in the range.
The terms to be filtered.
Indicates if the filter excludes results.
{
"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"
]
}
}
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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
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
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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
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
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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."
}
]
}