- URL:https://[root]/portals/[portalID]/setUserDefaultSettings(POST only)
- Version Introduced:ArcGIS Enterprise: 10.8 | ArcGIS Online: June 2019
Example usage
Below is a sample ArcGIS Online POST request for the setUserDefaultSettings operation:
POST /sharing/rest/portal/0123456789ABCEDEF/setUserDefaultSettings HTTP/1.1
Host: org.arcgis.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Length: []
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="role"
org_publisher
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="userLicenseType"
creatorUT
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="groups"
["43c2c91a304b44b59e5f8e871294069c"]
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="userType"
arcgisonly
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="apps"
[{"itemId": "f761dd0f298944dcab22d1e888c60293","entitlements": ["Insights"]}]
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="appBundles"
[{"itemId": "99d7956c7e824ff4ab27422e2a26c2b7}]
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="f"
pjson
------WebKitFormBoundaryJ2oaXLihj9kAMRWS--Below is a sample ArcGIS Enterprise POST request for the setUserDefaultSettings operation:
POST /webadaptor/sharing/rest/portal/0123456789ABCEDEF/setUserDefaultSettings HTTP/1.1
Host: machine.domain.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Length: []
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="role"
org_publisher
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="userLicenseType"
creatorUT
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="groups"
["43c2c91a304b44b59e5f8e871294069c"]
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="userType"
arcgisonly
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="apps"
[{"itemId": "f761dd0f298944dcab22d1e888c60293","entitlements": ["Insights"]}]
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="appBundles"
[{"itemId": "99d7956c7e824ff4ab27422e2a26c2b7}]
------WebKitFormBoundaryJ2oaXLihj9kAMRWS
Content-Disposition: form-data; name="f"
pjson
------WebKitFormBoundaryJ2oaXLihj9kAMRWS--Description
This operation allows administrators to set, and edit, new member defaults. Members who create their own built-in accounts and members added by an administrator or through automatic account creation will be automatically assigned the new member defaults. New member defaults can also be configured on the New Member Defaults tab in the Organization Settings of the portal.
Note:
Support for setting new member default groups and apps was introduced at ArcGIS Enterprise 10.8.1.
Request parameters
| Parameter | Details |
|---|---|
| role | The role ID. To assign a custom role as the new member default, you will need to retrieve its ID from the Roles resource. Values: org_admin | org_publisher | org_user | iBBBBBBBBBBBBBBB (Data Editor) | iAAAAAAAAAAAAAAA (Viewer) | Custom role ID |
| userLicenseType | The ID of a user type licensed with your organization. To see which user types are included with your organization's licensing, see the License resource in the Portal Admin API. Values: creatorUT | editorUT | GISProfessionalAdvUT | GISProfessionalBasicUT | GISProfessionalStdUT | viewerUT | fieldWorkerUT | |
| groups | A JSON array of group ID numbers that specify the groups new members will be added to. |
| userType (ArcGIS Online only) | Determines if new members will have Esri access (both) or if Esri access will be disabled (arcgisonly). The default value is arcgisonly. Note:While this parameter only applies to ArcGIS Online, the value for this parameter will still be passed through in Enterprise requests. However, it will have no impact on your Enterprise organization or new member defaults. Values: arcgisonly | both |
| apps | A JSON array of an app's itemID and, when applicable, entitlement. |
| appBundles | A JSON array of an app bundle's ID. |
| f | The response format. The default response format is html. Values: html | json | pjson |
JSON Response example
{"success": true}