Skip to main content

Returns an Entitlement resource based on id.

GET 
/Entitlements/:entitlementId

The Entitlement resource with matching id is returned.

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.

Request​

Path Parameters

    entitlementId stringrequired

    id of Entitlement resource.

Query Parameters

    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​

Returns a single Entitlement resource based on the id.

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

    displayableName 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 displayName 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.

    emails string

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

Loading...