Skip to main content

List of entitlements children

This API returns a list of all child entitlements of a given entitlement.

Path Parameters
  • id string required

    Entitlement Id

    Example: 2c91808874ff91550175097daaec161c
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 entitlements children from an entitlement


Schema array
  • id string

    The entitlement id

  • name string

    The entitlement name

  • attribute string

    The entitlement attribute name

  • value string

    The value of the entitlement

  • sourceSchemaObjectType string

    The object type of the entitlement from the source schema

  • description string

    The description of the entitlement

  • privileged boolean

    True if the entitlement is privileged

  • cloudGoverned boolean

    True if the entitlement is cloud governed

  • created date-time

    Time when the entitlement was created

  • modified date-time

    Time when the entitlement was last modified

  • source object
  • id string

    The source ID

  • type string

    The source type, will always be "SOURCE"

  • name string

    The source name

  • attributes object

    A map of free-form key-value pairs from the source system

  • segments string[]

    List of IDs of segments, if any, to which this Entitlement is assigned.

  • directPermissions object[]
  • rights string[]

    All the rights (e.g. actions) that this permission allows on the target

  • target string

    The target the permission would grants rights on.

  • owner object

    Simplified DTO for the owner object of the entitlement

  • id string

    The owner id for the entitlement

  • name string

    The owner name for the entitlement

  • type string

    Possible values: [IDENTITY]

    The type of the owner. Initially only type IDENTITY is supported

Loading...