Skip to main content

List Access Profile's Entitlements

This API lists the Entitlements associated with a given Access Profile

A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile

Path Parameters
    id string required

    ID of the containing Access Profile

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 Entitlement fields and operators: id: eq, in

    name: eq, sw

    attribute: eq, sw

    value: eq, sw

    created, modified: gt, lt, ge, le

    owner.id: eq, in

    source.id: eq, in

    Example: attribute eq "memberOf"
    sorters comma-separated

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

    Sorting is supported for the following fields: name, attribute, value, created, modified

    Example: name,-modified
Responses

List of Entitlements


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

    property name* any

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

    segments string[] nullable

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

    directPermissions object[]
  • Array [
  • ]
  • ]
Loading...