Get SOD policy schedule

This endpoint gets a specified SOD policy's schedule.

Path Parameters

id string required
The ID of the SOD policy schedule to retrieve.
Example: ef38f943-47e9-4562-b5bb-8424a56397d8

Responses

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

---

SOD policy schedule.

application/json

Schema

Example (from schema)

---

Schema

name string

SOD Policy schedule name

description string

SOD Policy schedule description

schedule object

The schedule information.

type ScheduleType required

Possible values: [DAILY, WEEKLY, MONTHLY, CALENDAR]

Enum representing the currently supported schedule types.

Additional values may be added in the future without notice.

days object nullable

The days to execute the search.

If type is WEEKLY, the values will be MON, TUE, WED, THU, FRI, SAT, and SUN.

If type is MONTHLY, the values will be a number in double quotes, like "1", "10", or "28". Optionally, the value "L" can be used to refer to the last day of the month.

type SelectorType required

Possible values: [LIST, RANGE]

Enum representing the currently supported selector types.

LIST - the values array contains one or more distinct values.

RANGE - the values array contains two values: the start and end of the range, inclusive.

Additional values may be added in the future without notice.

values string[] required

The selected values.

interval int32 nullable

The selected interval for RANGE selectors.

hours object

The hours selected.

type SelectorType required

Possible values: [LIST, RANGE]

Enum representing the currently supported selector types.

LIST - the values array contains one or more distinct values.

RANGE - the values array contains two values: the start and end of the range, inclusive.

Additional values may be added in the future without notice.

values string[] required

The selected values.

interval int32 nullable

The selected interval for RANGE selectors.

expiration date-time nullable

A date-time in ISO-8601 format

timeZoneId string nullable

The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.

recipients object[]
Array [
type DtoType
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]
DTO type
id string
ID of the object to which this reference applies
name string
Human-readable display name of the object to which this reference applies
]
emailEmptyResults boolean

Default value: false

Indicates if empty results need to be emailed

{
  "name": "SCH-1584312283015",
  "created": "2020-01-01T00:00:00.000000Z",
  "modified": "2020-01-01T00:00:00.000000Z",
  "description": "Schedule for policy xyz",
  "schedule": {
    "type": "WEEKLY",
    "days": {
      "type": "LIST",
      "values": [
        "MON",
        "WED",
        "FRI"
      ]
    },
    "hours": {
      "type": "RANGE",
      "values": [
        "9",
        "18"
      ],
      "interval": 3
    },
    "expiration": "2018-06-25T20:22:28.104Z",
    "timeZoneId": "GMT-06:00"
  },
  "recipients": [
    {
      "type": "IDENTITY",
      "id": "2c91808568c529c60168cca6f90c1313",
      "name": "William Wilson"
    }
  ],
  "emailEmptyResults": false,
  "creatorId": "0f11f2a47c944bf3a2bd742580fe3bde",
  "modifierId": "0f11f2a47c944bf3a2bd742580fe3bde"
}

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
Array [
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOrigin
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
Array [
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOrigin
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
Array [
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOrigin
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
Array [
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOrigin
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
Array [
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOrigin
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
Array [
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOrigin
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...