Skip to main content

List SOD policies

GET 

/sod-policies

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

This gets list of all SOD policies. Requires role of ORG_ADMIN

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq

    name: eq

    state: eq

    Example: id eq "bc693f07e7b645539626c25954c58554"

Responses

List of all SOD policies.

Schema
  • Array [
  • id string

    Policy ID.

    name string

    Policy business name.

    created date-time

    The time when this SOD policy is created.

    modified date-time

    The time when this SOD policy is modified.

    description stringnullable

    Optional description of the SOD policy.

    ownerRef object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's display name.

    externalPolicyReference stringnullable

    Optional external policy reference.

    policyQuery string

    Search query of the SOD policy.

    compensatingControls stringnullable

    Optional compensating controls (Mitigating Controls).

    correctionAdvice stringnullable

    Optional correction advice.

    state string

    Possible values: [ENFORCED, NOT_ENFORCED]

    Whether the policy is enforced or not.

    tags string[]

    Tags for the policy object.

    creatorId string

    Policy's creator ID.

    modifierId stringnullable

    Policy's modifier ID.

    violationOwnerAssignmentConfig objectnullable
    assignmentRule stringnullable

    Possible values: [MANAGER, STATIC, null]

    Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity

    ownerRef object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's display name.

    scheduled boolean

    Default value: false

    Defines whether a policy has been scheduled or not.

    type string

    Possible values: [GENERAL, CONFLICTING_ACCESS_BASED]

    Default value: GENERAL

    Whether a policy is query based or conflicting access based.

    conflictingAccessCriteria object
    leftCriteria object
    name string

    Business name for the access construct list

    criteriaList object[]

    List of criteria. There is a min of 1 and max of 50 items in the list.

  • Array [
  • type string

    Possible values: [ENTITLEMENT]

    DTO type

    id string

    ID of the object to which this reference applies to

    name string

    Human-readable display name of the object to which this reference applies to

  • ]
  • rightCriteria object
    name string

    Business name for the access construct list

    criteriaList object[]

    List of criteria. There is a min of 1 and max of 50 items in the list.

  • Array [
  • type string

    Possible values: [ENTITLEMENT]

    DTO type

    id string

    ID of the object to which this reference applies to

    name string

    Human-readable display name of the object to which this reference applies to

  • ]
  • ]
Loading...