Skip to main content

Get a Segment by its ID

This API returns the segment specified by the given ID.

A token with ORG_ADMIN or API authority is required to call this API.

Path Parameters
  • id string required

    The ID of the Segment to retrieve.

    Example: ef38f94347e94562b5bb8424a56397d8
Responses

Segment


Schema
  • 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...