/provisionUserEntitlements: Provision User Entitlements

URL:: https://[root]/content/listings/[itemID]/provisionUserEntitlements
Methods:: POST

Example Usage

URL for Provision User Entitlements

Use dark colors for code blocksCopy
https://www.arcgis.com/sharing/rest/content/listings/6489da7f08f045ac8c0a5b1de37d56fe/provisionUserEntitlements

Description

For a license-by-user listing, purchasing organization administrator can use this operation (POST only) to provision entitlements to org members. It can only be made if the item has already been purchased, or is being tried by the purchasing org. A maximum of 25 users can be provisioned in one request.

Request Parameters

Parameter Details

Parameter	Details
`[Common Parameters]`	For a complete listing, see Common parameters.
`userEntitlements`	A JSON object representing the set of entitlements assigned to the specified set of users. Example: Use dark colors for code blocksCopy `1 2 3 4 { "users": ["username1", "username2"], "entitlements": ["standard", "networkAnalyst"] //"standard" is an entitlement string that uniquely identifies entitlement, listing itemId is used typically for provider apps }` Only members of the purchasing org can be specified in the request. Specified `entitlements` are assigned to all specified `users`. If different sets of entitlements are to be assigned to different users, multiple requests with this operation are required. When there is no `entitlements` specified, it will revoke access to the item completely for the specified users. The total number of currently provisioned users plus users specified in requests should be no larger than the maximum number of users allowed for the purchasing org.

[Common Parameters]

For a complete listing, see Common parameters.

userEntitlements

A JSON object representing the set of entitlements assigned to the specified set of users.

Example:

Use dark colors for code blocksCopy
{
  "users": ["username1", "username2"],
  "entitlements": ["standard", "networkAnalyst"] //"standard" is an entitlement string that uniquely identifies entitlement, listing itemId is used typically for provider apps
}

Only members of the purchasing org can be specified in the request.

Specified entitlements are assigned to all specified users. If different sets of entitlements are to be assigned to different users, multiple requests with this operation are required.

When there is no entitlements specified, it will revoke access to the item completely for the specified users.

The total number of currently provisioned users plus users specified in requests should be no larger than the maximum number of users allowed for the purchasing org.

Response Properties

Property	Details
`success`	Indicates whether the operation was successful.

JSON Response Syntax

Use dark colors for code blocksCopy
{"success": true | false}

JSON Response Example

Use dark colors for code blocksCopy
{"success": true}

or

{"error": {
 "code": 400,
 "message": "item not provisioned",
 "details": []
}}