Skip to main content

List Segments​

This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API.

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.

  • 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
Responses

List of all Segments


Schema array
  • id string
  • name string

    Segment Business Name

  • created date-time

    The time when this Segment is created

  • modified date-time

    The time when this Segment is modified

  • description string

    Optional description of the Segment

  • owner object

    The owner of this object.

  • 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_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

  • id string

    Identity id

  • name string

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

  • visibilityCriteria object
  • expression object
  • operator string

    Possible values: [AND, EQUALS]

    Operator for the expression

  • attribute string

    Name for the attribute

  • value object
  • type string

    The type of attribute value

  • value string

    The attribute value

  • children object[]

    List of expressions

  • type string

    The type of attribute value

  • value string

    The attribute value

  • active boolean

    Whether the Segment is currently active. Inactive segments have no effect.

Loading...