Skip to main content

Update SOD Policy schedule

This updates schedule for a specified SOD policy.

Path Parameters
    id string required

    The ID of the SOD policy to update its schedule.

    Example: ef38f943-47e9-4562-b5bb-8424a56397d8
Request Body required
    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

Responses

Created or updated SOD policy schedule.


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

Loading...