Skip to main content

Returns all Entitlement resources.

GET 
/Entitlements

This endpoint returns all Entitlement resources.

Attributes to include in the response can be specified with the 'attributes' query parameter.

Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

The schemas related to Entitlements are:

  • urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement

Request​

Query Parameters

    filter string

    Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

    sortBy string

    Allows sorting the results by a resource's attributes.

    sortOrder string

    Default value: ascending

    Determines what order to sort results in.

    startIndex integer

    Default value: 1

    Determines the starting index of the result set.

    count integer

    Default value: 1000

    Specifies the number of results per page.

    attributes string

    A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

    excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses​

Returned all SCIM resources for this endpoint.

Schema
    totalResults integer

    Number of resources returned for this endpoint.

    startIndex integer

    The starting index of the resource set list. Can be specified with startIndex query parameter.

    schemas string[]

    SCIM Schema used for response.

    Resources undefined[]
  • Array [
    • id string

    Unique identifier of the Entitlement.

    descriptions object

    A list of localized descriptions of the Entitlement.

    locale string

    The locale associated with this Entitlement description.

    value string

    The description in localized form.

    displayName string

    Displayable name of the Entitlement.

    type string

    Type of the Entitlement.

    application undefined[]

    The corresponding Application object of the Entitlement.

  • Array [
    • value string

    The Application associated with the Entitlement.

    $ref string

    The URI of the SCIM resource representating the Entitlement application.

    displayName string

    The name of the Entitlement Application. OPTIONAL and READ-ONLY.

  • ]
    • owner undefined[]

    The owner of the Entitlement.

  • Array [
    • value string

    The id of the SCIM resource representing the Entitlement Owner.

    $ref string

    The URI of the SCIM resource representing the Entitlement Owner.

    displayName string

    The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.

  • ]
    • requestable boolean

    Flag to indicate this entitlement is requestable.

    aggregated boolean

    Flag to indicate this entitlement has been aggregated.

    attribute string

    Attribute of the Entitlement.

    value string

    Attribute value of the Entitlement.

    lastRefresh date-time

    The DateTime when the Entitlement was refreshed.

    lastTargetAggregation date-time

    The date aggregation was last targeted of the Entitlement.

    classifications object

    Classifications of this Entitlement.

    source string

    The source of the ObjectClassification.

    effective boolean

    Flag indicating this is an effective Classification.

    classification objectrequired

    Classification of this object.

    name string

    The name of the classification.

    displayName string

    The display name of the classification.

    origin string

    The origin of the Classification.

    type string

    The type of the Classification.

    meta object
    created date-time

    DateTime when the Entitlement was created.

    location string

    URL to the Entitlement.

    lastModified date-time

    DateTime of Entitlement last modification.

    version string

    Entitlement version.

    resourceType string

    Resource type of the metadata subject.

    schemas array
    entitleAuth string

    This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.

    entDate date-time

    This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.

    active boolean

    This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.

    rank integer

    This is an Extended Attribute from Managed Attribute.

    rule string

    This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.

    reviewer object

    This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.

    displayName string

    Display name of the Entitlement reviewer.

    value string

    id of the Entitlement reviewer.

    $ref string

    URI reference of the Entitlement reviewer resource.

    email string

    This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.

  • ]
Loading...