/setUserDefaultSettings: Set User Default Settings

URL:
https://[root]/portals/[portalID]/setUserDefaultSettings
Methods:
POST
Version Introduced:
ArcGIS Enterprise: 10.8 | ArcGIS Online: June 2019

Example usage

The following is a sample ArcGIS Online POST request for the setUserDefaultSettings operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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--

The following is a sample ArcGIS Enterprise POST request for the setUserDefaultSettings operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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

The setUserDefaultSettings 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.

Request parameters

ParameterDetails

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.

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

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.