Get all entitlements about a user

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  EntitlementFieldSet	EntitlementFieldSet	Query-String	Specifies which values to be returned in the Entitlements array.
  UserKey	UserKey	Route	The unique key for the user's client.

• Response Parameters

  View Response Codes

  Name	Type	Description
  Entitlements	Entitlement []	The all client specific entitlements for market data, which the user currently has access to..
  ExchangeId	String	The unique ID of the exchange.

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidUserId The requested user id was invalid.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /port/v1/users/5DG7K1P5cqYBZ77tl7Af4w==/entitlements?EntitlementFieldSet=Default

• Response Example

  Response body

  {
    "Entitlements": [
      {
        "DelayedFullBook": [
          "CertificateDiscount"
        ],
        "DelayedGreeks": [
          "CertificateCappedOutperformance"
        ],
        "Greeks": [
          "CertificateCappedCapitalProtected"
        ],
        "RealTimeFullBook": [
          "CertificateUncappedCapitalProtection"
        ],
        "RealTimeTopOfBook": [
          "WarrantDoubleKnockOut"
        ]
      }
    ],
    "ExchangeId": "stringValue"
  }