URL:
https://<root>/portals/[portalID]/aiServer/enable
Methods:
POST
Version Introduced:
12.2

Example usage

The following is a sample ArcGIS Enterprise POST request for the enable 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
POST /<context>/sharing/rest/portals/0123456789ABCDEF/aiServer/enable HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Length: []

------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="capability"

aiAssistants
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="username"

agolUser
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="password"

agol.pass
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="authenticationUrl"

https://arcgis.com/sharing/rest/generateToken
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="f"

pjson
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="token"

<token>
------WebKitFormBoundaryKkUYxki4o00zqwAV--

Description

The enable operation adds and stores ArcGIS Online credentials for a specified AI capability. While the Update Settings operation can be used to enable the general use of AI capabilities for the organization, as well as enable specific AI capabilities for organization members, doing so only enables AI-related endpoints and information to be visible and accessible in the API. Before an AI capability can be fully utilized, it must have stored ArcGIS Online credentials associated with it. The ArcGIS Online account associated with the AI capability will be used by any member who has the required privilges to use AI tools. This operation can only be performed by administrators assigned the default administrator role or administrators that have been assigned a custom role that includes the Security and Infrastructure administrative privilege.

In the event that the stored credentials need to be updated, this operation can be used to replace older credentials by providing new username and password information. To disable further use of the enabled capability, the Disable AI Capability can be used to remove stored credetials, which halts all further use of the AI capability until new credentials are provided.

It is recommended that the workflow for enabling AI capabilities, as well as storing and updating credentials, is performed from the portal site's organization settings page.

Request parameters

ParameterDetails

capability

(Required)

Specifies the AI capability to which the stored credentials are applied.

Values: aiAssistants | aiServices | aiAgents

username

(Required)

The username for an ArcGIS Online account.

password

(Required)

The password for the specified username.

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response example

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

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