[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get Entitlement

Description

Get entitlement record by id

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/portal/v2/entitlements/{id}
Copy

Path Parameters

Path Parameters

string
id Required

id


Query Parameters

Query Parameters

string
org_id Optional

org_id


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns EntitlementV2 of type */*
{
    "description": "Entitlement description",
    "groupIds": [
        "group-id-1",
        "group-id-2"
    ],
    "id": "ent-id-12345",
    "location": "US",
    "name": "dev's entitlement",
    "orgId": "0123456789",
    "userIds": [
        "user-id-1",
        "user-id-2"
    ]
}
array of string
poolIds Required

List of PoolIds


array of ResourceDetail
resourceDetails Required

List of filter applications for this entitlements


string as date-time
createdAt Optional

Time when the entitlement was created


string
id Optional

Entitlement ID


string
location Optional

Location that is mapped with Org Id


string
name Optional

Entitlement name


string
orgId Optional

Org ID that owns this entitlement


string
description Optional

Entitlement description


array of string
groupIds Optional

List of entitled user groups - requires group ID returned from IAM


string as date-time
updatedAt Optional

Time when the entitlement was updated


array of string
userIds Optional

List of entitled users - requires user ID returned from IAM

Errors

Errors

401

Unauthorized


403

Forbidden


404

Not found

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v2/entitlements/{id}


Feedback

Was this page helpful?