Skip to main content

Account Entitlements

GET 

/accounts/:id/entitlements

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

Request

Path Parameters

    id stringrequired

    The account id

    Example: ef38f94347e94562b5bb8424a56397d8

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

Responses

An array of account entitlements

Schema
  • Array [
  • id string

    System-generated unique ID of the Object

    name stringrequired

    Name of the Object

    created date-time

    Creation date of the Object

    modified date-time

    Last modification date of the Object

    attribute string

    Name of the entitlement attribute

    value string

    Raw value of the entitlement

    description string

    Entitlment description

    attributes object

    Entitlement attributes

    property name* any

    Entitlement attributes

    sourceSchemaObjectType string

    Schema objectType on the given application that maps to an Account Group

    privileged boolean

    Determines if this Entitlement is privileged.

    cloudGoverned boolean

    Determines if this Entitlement is goverened in the cloud.

    source object

    Source the entitlement belongs to.

    type string

    Possible values: [SOURCE]

    DTO type of source the entitlement belongs to.

    id string

    ID of source the entitlement belongs to.

    name string

    Human-readable name of source the entitlement belongs to.

  • ]
Loading...