- URL: https://[root]/portals/[portalID]/collaborations/[collaborationID]/participants/[portalID]/updateWebAuthConfig
- Required Capability:Administrator (host)
- Version Introduced:10.6
Example usage
Below is a sample ArcGIS Online POST request for the updateWebAuthConfig operation:
POST /sharing/rest/portals/123456789ABCDEF/collaborations/972da76ce4a5460aaf60213279d6c3ed/participants/e6623fad-8bba-42e5-b88e-6b7e1a502ef6/updateWebAuthConfig HTTP/1.1
Host: org.arcgis.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryAkloB7590BRuYyVx
Content-Length: []
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthUsername"
authUsername
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthPassword"
authPassword
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthCertificateFile"; filename=""
Content-Type: application/octet-stream
certficateFile.pfx
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthCertPassword"
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="clearWebAuthConfig"
false
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="f"
pjson
------WebKitFormBoundaryAkloB7590BRuYyVx--Below is a sample ArcGIS Enterprise POST request for the updateWebAuthConfig operation:
POST /webadaptor/sharing/rest/portals/123456789ABCDEF/collaborations/972da76ce4a5460aaf60213279d6c3ed/participants/e6623fad-8bba-42e5-b88e-6b7e1a502ef6/updateWebAuthConfig HTTP/1.1
Host: machine.domain.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryAkloB7590BRuYyVx
Content-Length: []
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthUsername"
authUsername
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthPassword"
authPassword
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthCertificateFile"; filename=""
Content-Type: application/octet-stream
certficateFile.pfx
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="webAuthCertPassword"
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="clearWebAuthConfig"
false
------WebKitFormBoundaryAkloB7590BRuYyVx
Content-Disposition: form-data; name="f"
pjson
------WebKitFormBoundaryAkloB7590BRuYyVx--Description
The updateWebAuthConfig resource adds, updates, or removes the web-tier authentication credentials or certificate used to communicate with another participant in the collaboration. This participant is identified by the participant'sportalID in the URL.
Request parameters
| Parameter | Details |
|---|---|
| webAuthUsername | The username for the web-tier authentication. This can be in the format domain/username or just username. |
| webAuthPassword | The corresponding password for the username. |
| webAuthCertificateFile | The PKI certificate file used for client certificate authentication. This file needs to be in PKCS12 format. |
| webAuthCertPassword | The corresponding password for the PKI certificate file. If no password is required, this field can be left empty. |
| clearWebAuthConfig | If true, this will clear all web-tier authentication credentials or certificates stored for the participant portal. This value is false by default. Values: true | false |
| f | The response format. The default format is html. Values: html | json | pjson |
Response parameters
| Parameter | Details |
|---|---|
| success | This value will either be true or false. |
| collaborationID | The ID of the collaboration for which the web-tier authentication credentials were changed. |
| portalID | The ID of the participant whose web-tier authentication credentials were changed. |
JSON Response example
{
"success": true,
"collaborationId": "3e9d1694351a4b5badef66c7599fced5",
"portalId": "e6623fad-8bba-42e5-b88e-6b7e1a502ef6"
}