Skip to content
URL:
https://<root>/orgs/<orgID>/properties
Methods:
GET
Operations:
Update Properties
Version Introduced:
10.9.1

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.


Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

The properties resource lists properties specific to an organization that can be modified to control your deployment. At 10.9.1, the only supported system property is privatePortalURL, which can be set using the Update operation.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Organization properties

ParameterDetails

privatePortalURL

Specifies the internal URL that a federated ArcGIS Server should use to communicate with ArcGIS Enterprise on Kubernetes-hosted services. This property is typically used when ArcGIS Enterprise on Kubernetes is configured for web-tier authentication.

Example usage

The following is a sample request URL for the properties resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/orgs/0123456789ABCDEF/properties?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
{"privatePortalURL": "https://organization.example.com/<context>"}

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