Skip To Content

/assignUserCredits: Assign User Credits

  • URL:https://[root]/portals/[portalID]/assignUserCredits(POST only)

Example usage

Below is a sample ArcGIS Online POST request for the assignUserCredits operation:


POST /sharing/rest/portals/0123456789ABCDEF/assignUserCredits HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

userAssignments=[
  {"username":"user1","credits": 100.0},
  {"username":"user2","credits": 100.0},
  {"username":"user3","credits": 100.0},
  {"username":"user6","credits": 500.0}
]&f=pjson

Description

The assignUserCredits operation (POST only) allows organization administrators to allocate credits for organizational users in ArcGIS Online.

Request parameters

ParameterDetails
userAssignments

A JSON array of objects, each contains a pair of user name and the number of credits to designate to that user. A maximum of 100 users can be assigned all together in each request.

Example


[
  {"username":"user1","credits": 100.0},
  {"username":"user2","credits": 100.0},
  {"username":"user3","credits": 100.0},
  {"username":"user6","credits": 500.0}
]
f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
success

Indicates if the operation was successful.

notAssignedUsers

A JSON array of user names representing a subset of users whose credits were not assigned successfully. Used when success is true.

Example:

["user3", "user6"]

JSON Response syntax


{
  "success": true | false,
  "notAssignedUsers": ["<username1>", "<username2>"...]
}

JSON Response example


{
  "success": true,
  "notAssignedUsers": ["user3", "user6"]
}