Skip to main content

Account Entitlements

This API returns entitlements of the account.
A token with ORG_ADMIN authority is required to call this API.

Path Parameters
    id string required

    The account id

    Example: ef38f94347e94562b5bb8424a56397d8
Query Parameters
    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
    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
    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

An array of account entitlements


Schema
  • Array [
  • id string

    The entitlement id

    name string

    The entitlement name

    created date-time

    Time when the entitlement was created

    modified date-time

    Time when the entitlement was last modified

    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

    privileged boolean

    Default value: false

    True if the entitlement is privileged

    cloudGoverned boolean

    Default value: false

    True if the entitlement is cloud governed

    description string

    The description of the entitlement

    requestable boolean

    Default value: false

    True if the entitlement is requestable

    attributes object

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

    property name* any

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

    source object
    id string

    The source ID

    type string

    The source type, will always be "SOURCE"

    name string

    The source name

    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

    directPermissions object[]
  • Array [
  • ]
  • segments string[] nullable

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

    manuallyUpdatedFields object

    Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.

    DISPLAY_NAME boolean

    Default value: false

    True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to Entitlement response schema > name property.

    DESCRIPTION boolean

    Default value: false

    True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to Entitlement response schema > description property.

  • ]
Loading...