arcgis.gis.admin module

Bases: object

This is the root resource for administering your online GIS. Starting from this root, all of the GIS’s environment is organized into a hierarchy of resources and operations.

Parameter: :param gis: GIS object containing Administrative credentials :param ux: the UX object (optional) :param metadata: the metadata manager object (optional) :param collaborations: the CollaborationManager object (optional)

property category_schema

This resource allows for the setting and manipulating of category schemas.

Returns:

CategoryManager object

property certificates

Provides access to managing the organization’s certificates.

Returns:

CertificateManager object

property collaborations

The collaborations resource lists all collaborations in which a portal participates

Returns:

CollaborationManager object

content(item_type=None, sort_field='created', order='asc')

The portal content operation allows an administrator to return a list of all items in the organization. Only available to administrators with a privilege to view all items in the organization.

Parameter	Description
item_type	Optional ItemTypeEnum. The item type to filter by.
sort_field	Optional String. Field to sort by.
order	Optional String. The sort order of the return data.

property credits

Manages the credits on a ArcGIS Online

Returns:

CreditManager object

property datastore_metrics

Provides administrators information about the datastore on ArcGIS Online.

return:

DataStoreMetricsManager object

history(start_date, to_date=None, num=100, all_events=True, event_ids=None, event_types=None, actors=None, owners=None, actions=None, ips=None, sort_order='asc', data_format='csv', save_folder=None)

Returns a CSV file or Pandas’s DataFrame containing the login history from a start_date to the present.

Parameter	Description
start_date	Required datetime.datetime object. The beginning date to start with.
to_date	Optional datetime.datetime object. The ending date. If not provided, the query will attempt to obtain all records till the current date.
num	Optional Integer. The maximum number of records to return. The maximum value is 10,000 set by the ArcGIS REST API. If the value of -1 is provided it will attempt to get all records for the date range. The default is 100.
all_events	Optional Boolean. If True, all types of events are included. If False, only actions targeted by the organization are included. When exporting as csv this parameter is True.
event_id	Optional String. Filter events by specific target user name or target ID in a batch result set. It can be the ID of an item, a group, a role, a collaboration, an identity provider, and so on.
event_types	Optional String. Filter events by a comma-separated list of target types in a batch result set. Values: a (organization), c (collaboration), cp (collaboration participate), cpg (collaboration participate group), cw (collaboration workspace), cwp (collaboration workspace participate), g (group), i (item), idp (identity provider), inv (invitation), r (role), u (user)
actors	Optional String. Comma seperated list of usernames.
owners	Optional String. Filter events by a comma-separated list of user names who own the action targets in a batch result set.
actions	Optional String. Comma seperated list of actions to query for. Values: add, addusers, create, delete, removeusers, share, unshare, update, failedlogin, login, and updateUsers.
ips	Optional String. Filter events by a comma-separated list of IP addresses in a batch result set.
sort_order	Optional String. Describes whether the results return in ascending or descending chronological order. The default is ascending. Values: asc or desc
data_format	Optional String. The way the data is returned to the user. The response can be a df, csv, or ‘raw’. ‘df’ returns a DataFrame, ‘csv’ returns a comma seperated file, and ‘raw’ returns the JSON string as a dictionary. Values: df, csv, ‘raw’
save_folder	Optional String. The save location of the CSV file.

Returns:

string or pd.DataFrame or dict

property idp

This resource allows for the setting and configuration of the identity provider

Returns:

IdentityProviderManager object

property license

provides a set of tools to access and manage user licenses and entitlements.

property location_tracking

The manager for Location Tracking. See LocationTrackingManager

Returns:

LocationTrackingManager object

property metadata

resources to work with metadata on GIS

Returns:

MetadataManager object

property org_recyclebin

Returns the organization recyclebin, which will allow administrators to look at the entire organization recyclebin contents.

Returns:

OrgRecycleBin

property partnered_collaboration

Returns a manager to work with partnered collaborations

Returns:

PartneredCollabManager

property password_policy

tools to manage a Site’s password policy

scheduled_tasks(item=None, active=None, user=None, types=None)

This property allows org_admins to be able to see all scheduled tasks on the enterprise

Parameter	Description
item	Optional Item. The item to query tasks about.
active	Optional Bool. Queries tasks based on active status.
user	Optional User. Search for tasks for a single user.
types	Optional String. The type of notebook execution for the item. This can be ExecuteNotebook, or UpdateInsightsWorkbook.

Yields:

Task

property servers

Provides access to managing the services hosted on ArcGIS Online

Returns:

AGOLServersManager

property social_providers

This resource allows for the setting and configuration of the social providers for a GIS.

Returns:

SocialProviders object

property urls

returns the URLs to the Hosting and Tile Server for ArcGIS Online

property usage_reports

provides access to the usage reports of the ArcGIS Online organization

Returns:

AGOLUsageReports object

property ux

returns a UX/UI manager

Returns:

UX object

Bases: object

This class allows for ArcGIS Online administrators to query statistics about the managed datastore. It is not meant to be initialized directly, but instead an instance is returned from the datastore_metrics property.

# Usage Example;
>>> gis = GIS(profile="your_online_admin_profile")

>>> ago_mgr = gis.admin
>>> ds_mgr = ago_mgr.datastore_metrics

property feature_storage

Returns storage percentage of total storage used

Returns:

list[dict[str,Any]]

query(metric, bin_size, bin_unit, aggregation=DataStoreAggregation.SUM, start_time=None, end_time=None, ago=None, ago_unit=None)

A query operation used to gather metrics about the ArcGIS Online Datastore

Parameter	Description
metric	Required DataStoreMetric. The statistical method to gather.
bin_size	Required Float or Int. The size of the bin to aggregate on.
bin_unit	Required DataStoreTimeUnit. The size of the bin.
aggregation	Required DataStoreAggregation. The type of aggregation to perform.
start_time	Optional datetime.datetime. The starting date point.
end_time	Optional datetime.datetime. The ending date point.
ago	Optional Int. The time to look back from today.
ago_unit	Optional DataStoreTimeUnit. The time unit to look back.

Returns:

list[dict[str,Any]]

query_resource_usage(query_period)

Allows administrators to view the average and max CPU usage for the organization’s datastore.

Parameter	Description
query_period	Required String. The time period to query. The allowed values are: day, week, or hour.

Returns:

dictionary containing the average and max usage.

Bases: Enum

AVG = 'avg'

COUNT = 'count'

MAX = 'max'

MIN = 'min'

STDEV = 'stdev'

SUM = 'sum'

VARIANCE = 'variance'

Bases: Enum

Time Units for DataStore Metrics class

DAY = 'd'

HOUR = 'h'

MILLISECOND = 'ms'

MINUTE = 'm'

SECOND = 's'

Bases: Enum

The allowed metric values

ALLOCATED_STORAGE = 'db_allocated_storage_mb'

AVG_CPU = 'db_avg_cpu'

FEATURESTORAGE = 'db_featurestorage_mb'

PERCENT_STORAGE = 'db_percent_storage'

STORAGE_MB = 'db_used_storage_mb'

Bases: BasePortalAdmin

This is the root resource for administering your portal. Starting from this root, all of the portal’s environment is organized into a hierarchy of resources and operations. A version number is returned as a part of this resource. After installation, the portal can be configured using the Create Site operation. Once initialized, the portal environment is available through System and Security resources.

property category_schema

This resource allows for the setting and manipulating of category schemas.

Returns:

CategoryManager object

property classification

Provides access to the functionality for managing the ArcGIS Enterprise classification schema if it has been configured.

Returns:

An instance of the ClassificationManager.

property collaborations

The collaborations resource lists all collaborations in which a portal participates

Returns:

CollaborationManager object

content(item_type=None, sort_field='created', order='asc')

The portal content operation allows an administrator to return a list of all items in the organization. Only available to administrators with a privilege to view all items in the organization.

Parameter	Description
item_type	Optional ItemTypeEnum. The item type to filter by.
sort_field	Optional String. Field to sort by.
order	Optional String. The sort order of the return data.

property federation

provides access into the federation settings of a server.

Returns:

Federation object

history(start_date, num=100, save_folder=None)

Returns a CSV file containing the login history from a start_date to the present.

Parameter	Description
start_date	Required datetime.datetime object. The beginning date.
num	Optional Integer. The maximum number of records to return.
save_folder	Optional String. The save location of the CSV file.

Returns:

string

property idp

This resource allows for the setting and configuration of the identity provider

Returns:

IdentityProviderManager object

property info

Returns the current version and build number of the Enterprise system

Returns:

dict

property license

provides a set of tools to access and manage user licenses and entitlements.

Returns:

LicenseManager object

property living_atlas

provides a set of tools to manage and setup Living Atlas content.

Returns:

LivingAtlas object

property location_tracking

The manager for Location Tracking. See LocationTrackingManager.

Returns:

LocationTrackingManager object

property logs

returns a class to work with the portal logs

Returns:

Logs object

property machines

This resource lists all the portal machines in a site. Each portal machine has a status that indicates whether the machine is ready to accept requests.

Returns:

Machines object

property metadata

returns a set of tools to work with ArcGIS Enterprise metadata settings.

Returns:

MetadataManager object

property mode

Gets/Set the mode of the ArcGIS Enterprise deployment. When obtaining the mode, it returns information about the current state of the system.

Key	Description
read_only	Required Boolean. A boolean that specifies whether the Enterprise portal is in read-only mode. Read-only mode will block requests to modify or create any data, including content, users, groups, or site settings. The default value is false.
message	Optional String. Sets a custom message to be displayed whenever an attempt to modify or update content or site settings is made through the API.

>>> gis.admin.mode({'read_only' : False})
>>> assert gis.admin.mode['isReadOnly'] == False

property password_policy

tools to manage a Site’s password policy

Returns:

PasswordPolicy object

scheduled_tasks(item=None, active=None, user=None, types=None)

This property allows org_admins to be able to see all scheduled tasks on the enterprise

Parameter	Description
item	Optional Item. The item to query tasks about.
active	Optional Bool. Queries tasks based on active status.
user	Optional User. Search for tasks for a single user.
types	Optional String. The type of notebook execution for the item. This can be ExecuteNotebook, or UpdateInsightsWorkbook.

Yields:

Task

property security

accesses the controls for the security of a local portal site

Returns:

Security object

property servers

returns a server manager object

Returns:

ServerManager

property site

Site is the root resources used after a local GIS is installed. Here administrators can create, export, import, and join sites.

Returns:

Site object

property social_providers

This resource allows for the setting and configuration of the social providers for a GIS.

Returns:

SocialProviders object

property system

This resource provides access to the ArcGIS Web Adaptor configuration, portal directories, database management server, indexing capabilities, license information, and the properties of your portal.

Returns:

System object

property ux

returns a UX/UI manager with properties such as description, featured_content, name, etc.

Returns:

UX object

property webhooks

Provides access to Portal’s WebHook Manager

Returns:

WebhookManager object

Bases: _BaseKube

Kubernetes Administration Class. This class is not meant to be initialized directly, but instead is returned by the _admin_ property on the gis object when logged in as an administrator.

#Usage Example:

>>> gis = GIS(profile="your_kubernetes_admin_profile")
>>> kube_admin = gis.admin
>>> kube_admin

<KubernetesAdmin at https://kubenetes.example.com/arcgis/admin>

property category_schema

This resource allows for the setting and manipulating of catagory schemas.

Returns:

CategoryManager object

property collaborations

The collaborations resource lists all collaborations in which a portal participates

content(item_type=None, sort_field='created', order='asc')

The portal content operation allows an administrator to return a list of all items in the organization. Only available to administrators with a privilege to view all items in the organization.

Parameter	Description
item_type	Optional ItemTypeEnum. The item type to filter by.
sort_field	Optional String. Field to sort by.
order	Optional String. The sort order of the return data.

property datastores

Provides access to the _Datastore Manager_, allowing the administrator to manage registered datastores.

Returns:

A Kubernetes DataStores object.

property jobs

This resource is a collection of the asynchronous jobs created in your deployment. When operations that support asynchronous executions are run with the async option enabled, a new job entry is created that can be queried for its current status and messages.

property license

Provides access to the LicenseManager, and its set of tools to access and manage user licenses and entitlements.

property logs

Accesses a LogManager object to manage and query the Kubernetes logs.

property metadata

Accesses the MetadataManager which provides a set of tools to work with the organization’s metadata settings.

property mode

Provides access to a Mode object to help manage service deployment modes.

property organizations

Provides access to the KubeOrganizations object to work with the organization’s settings.

property overview

Provides access to the overview resource to access persisted cache or real-time information.

Returns:

Overview object

scheduled_tasks(item=None, active=None, user=None, types=None)

This method allows organization admins to see all scheduled tasks on the organization.

Parameter	Description
item	Optional Item. The item to query tasks about.
active	Optional Bool. Queries tasks based on active status.
user	Optional User. Search for tasks for a single user.
types	Optional String. The type of notebook execution for the item: ExecuteNotebook UpdateInsightsWorkbook

Returns:

List of Tasks.

property security

Gets a KubeSecurity object to work with the site’s security settings

Returns:

KubeSecurity object.

property services

Provides access to the Kubernetes ServicesManager object for the site

property services_catalog

Provides access to the kubernetes KubeServiceDirectory work with the services on the site.

property social_providers

Accesses the SocialProviders resource to allow for the setting and configuration of the social providers for the organization.

property system

This is a collection of system-wide resources for your deployment such as the configuration store, licenses, and deployment-wide security.

Returns:

SystemManager object.

property uploads

Gets the Uploads object to work with the site uploads.

property usage

Provides access to the metrics viewer and metrics API tools.

Returns:

An UsageStatistics object.

property webhooks

Provides access to the organiztion’s Webhook Manager.

Bases: object

Kubernetes Sharing API Implementation

add_group_users(user_names, group_id, admin_names)

Adds users to the group specified.

Note

This method will only work if the user for the Portal object is either an administrator for the entire Portal or the owner of the group.

Returns:

A dictionary with a key of “not_added” which contains the users that were not added to the group.

add_item(item_properties, data=None, thumbnail=None, metadata=None, owner=None, folder=None)

Adds content to a Portal.

Note

That content can be a file (such as a layer package, geoprocessing package, map package) or it can be a URL (to an ArcGIS Server service, WMS service, or an application).

If you are uploading a package or other file, provide a path or URL to the file in the data argument.

From a technical perspective, none of the item properties below are required. However, it is strongly recommended that title, type, typeKeywords, tags, snippet, and description be provided.

Parameter	Description
item_properties	Required dictionary, see below for the keys and values
data	Optional string, either a path or URL to the data
thumbnail	Optional string, either a path or URL to an image
metadata	Optional string, either a path or URL to metadata.
owner	Optional string, defaults to logged in user.
folder	Optional string, content folder where placing item

Key	Value
type	Optional string, indicates type of item. See URL 1 below for valid values.
typeKeywords	Optional string list. Lists all sub-types. See URL 1 for valid values.
description	Optional string. Description of the item.
title	Optional string. Name of the item.
url	Optional string. URL to item that are based on URLs.
tags	Optional string of comma-separated values. Used for searches on items.
snippet	Optional string. Provides a very short summary of the what the item is.
extent	Optional string with comma separated values for min x, min y, max x, max y.
spatialReference	Optional string. Coordinate system that the item is in.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string, any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values: private, shared, org, or public.
commentsEnabled	Optional boolean. Default is true. Controls whether comments are allowed.
culture	Optional string. Language and country information.
overwrite	Optional boolean. Default is false. Controls whether item can be overwritten.

URL 1: http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r3000000ms000000

Returns:

The item id of the uploaded item if successful, None if unsuccessful.

can_delete(item_id, owner, folder=None)

checks if you can delete the item.

Parameter	Description
item_id	required string, unique identifier for the item
owner	required string, owner of the item currently
folder	optional string, folder containing the item. Defaults to the root folder.

Returns:

a tuple containing a boolean and a dict with details

con = None

create_folder(owner, title)

Creates a folder for the given user with the given title.

Parameter	Description
owner	required string, the name of the user
title	required string, the name of the folder to create for the owner

Returns:

a json object like the following: {“username” : “portaladmin”,”id” : “bff13218991c4485a62c81db3512396f”,”title” : “testcreate”}

create_group(title, tags, description=None, snippet=None, access='public', thumbnail=None, is_invitation_only=False, sort_field='avgRating', sort_order='desc', is_view_only=False, auto_join=False, provider_group_name=None, provider=None, max_file_size=None, users_update_items=False, display_settings=None, is_open_data=False, leaving_disallowed=False)

Creates a group with the values for any particular arguments that are specified. Only title and tags are required.

Parameter	Description
title	Required string. The name of the group.
tags	Required string. A comma-delimited list of tags, or list of tags as strings.
description	Optional string. A detailed description of the group.
snippet	Optional string. A short snippet (<250 characters) that summarizes the group.
access	Optional string. Choices are private, public, or org.
thumbnail	Optional string. URL or file location to a group image.
is_invitation_only	Optional boolean. Defines whether users can join by request. Default is False meaning users can ask to join by request or join by invitation.
sort_field	Optional string. Specifies how shared items with the group are sorted.
sort_order	Optional string. Choices are asc or desc for ascending or descending, respectively.
is_view_only	Optional boolean. Defines whether the group is searchable. Default is False meaning the group is searchable.
auto_join	Optional boolean. Only applies to org accounts. If True, this group will allow joining without requesting membership approval. Default is False.
provider_group_name	Optional string. The name of the domain group.
provider	Optional string. Name of the provider.
max_file_size	Optional integer. This is the maximum file size allowed be uploaded/shared to a group. Default value is: 1024000
users_update_items	Optional boolean. Members can update all items in this group. Updates to an item can include changes to the item’s description, tags, metadata, as well as content. This option can’t be disabled once the group has been created. Default is False.
display_settings	Optional String. Defines the default display for the group page to show a certain type of items. The allowed values are: apps, all, files, maps, layers, scenes, tools. The default value is all.
is_open_data	Optional Boolean. Defines whether the group can be used in the Open Data capabilities of ArcGIS Hub. The default is False.
leaving_disallowed	Optional boolean. Defines whether users are restricted from choosing to leave the group. If True, only an administrator can remove them from the group. The default is False.

Returns:

a dict containing group properties

create_group_from_dict(group, thumbnail=None)

Creates a group and returns a group id if successful.

Note

Use create_group in most cases. This method is useful for taking a group dict returned from another PortalPy call and copying it.

Example

create_group({'title': 'Test', 'access':'public'})

create_role(name, description)

Creates a custom role with specified name and description

Returns:

role_id if role is created, else None

create_service(name, service_description='', has_static_data=False, max_record_count=1000, supported_query_formats='JSON', capabilities=None, description='', copyright_text='', wkid=102100, service_type='imageService', create_params=None, owner=None, folder=None, common_params=None, is_view=False, item_id=None, tags=None, snippet=None)

Creates service.

#”Create,Delete,Query,Update,Editing”,

Returns:

The item id of the created service item if successful, None if unsuccessful.

delete_folder(owner, folder)

Deletes folder owned by owner with the given folder name.

Parameter	Description
owner	required string, the name of the user
folder	required string, the folder name

Returns:

a boolean if succeeded.

delete_group(group_id)

Deletes a group.

Parameter	Description
group_id	string containing the id for the group to be deleted.

Returns

a boolean indicating whether it was successful.

delete_group_thumbnail(group_id)

Removes the group’s thumbnail

Returns:

Boolean

delete_item(item_id, owner, folder=None, force=False, permanent=False)

Deletes an item.

Parameter	Description
item_id	Required string, unique identifier for the item
owner	Required string, owner of the item currently
folder	Optional string, folder containing the item. Defaults to the root folder.
force	Optional bool. If True, will force delete orphaned items
permanent	Optional bool. If True, item will not be sent to recycle bin.

Returns:

a boolean, indicating success

delete_user(username, reassign_to=None)

Deletes a user from the portal, optionally deleting or reassigning groups and items.

Note

You can not delete a user in Portal if that user owns groups or items. If you specify someone in the reassign_to argument then items and groups will be transferred to that user. If that argument is not set then the method will fail if the user has items or groups that need to be reassigned.

Parameter	Description
username	Required string, the name of the user
reassign_to	Optional string, new owner of items and groups

Returns:

a boolean indicating whether the operation succeeded or failed.

generate_token(username, password, expiration=60)

Generates and returns a new token, but doesn’t re-login.

Note

This method is not needed when using the Portal class to make calls into Portal. It’s provided for the benefit of making calls into Portal outside of the Portal class.

Portal uses a token-based authentication mechanism where a user provides their credentials and a short-term token is used for calls. Most calls made to the Portal REST API require a token and this can be appended to those requests.

Parameter	Description
username	required string, name of the user
password	required password, name of the user
expiration	optional integer, number of minutes until the token expires

Returns:

a string with the token

get_folder_id(owner, folder_name)

Finds the folder for a particular owner and returns its id.

Parameter	Description
owner	required string, the name of the user
folder_name	required string, the name of the folder to search for

Returns:

a boolean if succeeded.

get_group(group_id)

Returns group information for the specified group group_id.

Arguments

group_id : required string, indicating group.

Returns:

a dictionary object with the group’s information. The keys in the dictionary object will often include:

Key	Value
title:	the name of the group
isInvitationOnly	if set to true, users can’t apply to join the group.
owner:	the owner username of the group
description:	explains the group
snippet:	a short summary of the group
tags:	user-defined tags that describe the group
phone:	contact information for group.
thumbnail:	File name relative to http://<community-url>/groups/<groupId>/info
created:	When group created, ms since 1 Jan 1970
modified:	When group last modified. ms since 1 Jan 1970
access:	Can be private, org, or public.
userMembership:	A dict with keys username and memberType.
memberType:	provides the calling user’s access (owner, admin, member, none).

get_group_content(group_id, max_items=10)

Returns members of the specified group.

Arguments

group_id: required string, specifies the group

Returns

a dictionary with keys: owner, admins, and users.

Key	Value
owner	string value, the group’s owner
admins	list of strings, typically this is the same as the owner.
users	list of strings, the members of the group

Example (to print items in a group)

response = portal.get_group_content("67e1761068b7453693a0c68c92a62e2e")
for i in response["items"] :
    print (i)

get_group_members(group_id)

Returns members of the specified group.

Arguments

group_id: required string, specifies the group

Returns

a dictionary with keys: owner, admins, and users.

Key	Value
owner	string value, the group’s owner
admins	list of strings, typically this is the same as the owner.
users	list of strings, the members of the group

Example (to print users in a group)

response = portal.get_group_members("67e1761068b7453693a0c68c92a62e2e")
for user in response['users'] :
    print user

get_group_thumbnail(group_id)

Returns the bytes that make up the thumbnail for the specified group group_id.

Arguments

group_id: required string, specifies the group’s thumbnail

Returns

bytes that represent he image.

Example

response = portal.get_group_thumbnail("67e1761068b7453693a0c68c92a62e2e")
f = open(filename, 'wb')
f.write(response)

get_item(itemid)

Returns the item information for the specified item.

Arguments

itemid required string, the item-id whose information you want.

Returns:

None if the item is not found and returns a dictionary object if the item is found the dictionary has the following keys:

get_item_data(itemid, try_json=True, folder=None)

get_item_dependencies(itemid)

get_item_dependents_to(itemid)

get_org_roles(max_roles=1000)

Returns all roles within the portal organization.

Arguments

max_roles : optional int, the maximum number of users to return.

Returns:

a list of dicts. Each dict has the following keys:

get_org_users(max_users=1000, exclude_system=True, user_type=None, role=None)

Returns all users within the portal organization.

Arguments

max_users : optional int, the maximum number of users to return.

Returns:

a list of dicts. Each dict has the following keys:

Key	Value
username :	string
storageUsage:	int
storageQuota:	int
description:	string
tags:	list of strings
region:	string
created:	int, when account created, ms since 1 Jan 1970
modified:	int, when account last modified, ms since 1 Jan 1970
email:	string
culture:	string
orgId:	string
preferredView:	string
groups:	list of strings
role:	string (org_user, org_publisher, org_admin)
fullName:	string
thumbnail:	string
idpUsername:	string

Example (print all usernames in portal):

resp = portalAdmin.get_org_users()
for user in resp:
    print user['username']

get_properties(force=False)

Returns the portal properties (using cache unless force=True).

get_user(username)

Returns the user information for the specified username.

Arguments

username required string, the username whose information you want.

Returns:

None if the user is not found and returns a dictionary object if the user is found the dictionary has the following keys:

Key	Value
access	string
created	time (int)
culture	string, two-letter language code (‘en’)
description	string
email	string
fullName	string
idpUsername	string, name of the user in the enterprise system
groups	list of dictionaries. For dictionary keys, see get_group doc.
modified	time (int)
orgId	string, the organization id
preferredView	string, value is either Web, GIS, or null
region	string, None or two letter country code
role	string, value is either org_user, org_publisher, org_admin
storageUsage	int
storageQuota	int
tags	list of strings
thumbnail	string, name of file
username	string, name of user

get_version(force=False)

Returns the portal version (using cache unless force=True).

Note

The version information is retrieved when you create the Portal object and then cached for future requests. If you want to make a request to the Portal and not rely on the cache then you can set the force argument to True.

Arguments:

force boolean, true=make a request, false=use cache

Returns:

a string with the version. The version is an internal number that may not match the version of the product purchased. So 2.3 is returned from Portal 10.2.1 for instance.

invite_group_users(user_names, group_id, role='group_member', expiration=10080)

Invites users to a group.

Note

A user who is invited to a group will see a list of invitations in the “Groups” tab of portal listing invitations. The user can either accept or reject the invitation.

Requires

The user executing the command must be group owner

Parameter	Description
user_names:	a required string list of users to invite
group_id :	required string, specifies the group you are inviting users to.
role:	an optional string, either group_member or group_admin
expiration:	an optional int, specifies how long the invitation is valid for in minutes.

Returns:

a boolean that indicates whether the call succeeded.

property is_all_ssl

Returns true if this portal requires SSL.

property is_arcgisonline

Returns true if this portal is ArcGIS Online.

property is_kubernetes

Returns true if this portal is kubernetes.

property is_logged_in

Returns true if logged into the portal.

property is_multitenant

Returns true if this portal is multitenant.

property is_org

Returns true if this portal is an organization.

property is_subscription

Returns true if this portal is an ArcGIS Online subscription.

leave_group(group_id)

Removes the logged in user from the specified group.

Requires:

User must be logged in.

Arguments:

group_id: required string, specifies the group id

Returns:

a boolean indicating whether the operation was successful.

logged_in_user()

Returns information about the logged in user.

Returns:

a dict with the following keys:

Key	Value
username	string
storageUsage	int
description	string
tags	comma-separated string
created	int, when group created (ms since 1 Jan 1970)
modified	int, when group last modified (ms since 1 Jan 1970)
fullName	string
email	string
idpUsername	string, name of the user in their identity provider

login(username, password, expiration=60)

Logs into the portal using username/password.

Note

You can log into a portal when you construct a portal object or you can login later. This function is for the situation when you need to log in later.

Parameter	Description
username	required string
password	required string
expiration	optional int, how long the token generated should last.

Returns:

a string, the token

logout()

Logs out of the portal.

Note

The portal will forget any existing tokens it was using, all subsequent portal calls will be anonymous until another login call occurs.

Returns:

No return value.

move_item(itemid, owner, current_folder, folder_id)

Moves the item to given folder

protect_item(item_id, owner, folder=None, enable=True)

Enable or disable delete protection on the item

Parameter	Description
item_id	required string, unique identifier for the item
owner	required string, owner of the item currently
folder	optional string, folder containing the item. Defaults to the root folder.
enable	optional boolean, True to enable delete protection, False to to disable it

Returns:

dict with key “success” containing boolean whether process completed or not

publish_item(itemid, data=None, text=None, fileType='serviceDefinition', publishParameters=None, outputType=None, overwrite=False, owner=None, folder=None, buildInitialCache=False, item_id=None)

Publishes a hosted service based on an existing source item. Publishers can create feature services as well as tiled map services. Feature services can be created using input files of type csv, shapefile, serviceDefinition, featureCollection, and fileGeodatabase. CSV files that contain location fields, (ie.address fields or X, Y fields) are spatially enabled during the process of publishing. Shapefiles and file geodatabases should be packaged as .zip files. Tiled map services can be created from service definition (.sd) files, tile packages, and existing feature services. Service definitions are authored in ArcGIS for Desktop and contain both the cartographic definition for a map as well as its packaged data together with the definition of the geo-service to be created. Use the Analyze operation to generate the default publishing parameters for CSVs. See http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Publish_Item/02r300000080000000/

reassign_group(group_id, target_owner)

Reassigns a group to another owner.

Parameter	Description
group_id	required string, unique identifier for the group
target_owner	required string, username of new group owner

Returns:

a boolean, indicating success

reassign_item(item_id, current_owner, target_owner, current_folder=None, target_folder=None)

Allows the administrator to reassign a single item from one user to another.

Note

If you wish to move all of a user’s items (and groups) to another user then use the reassign_user method. This method only moves one item at a time.

Parameter	Description
item_id	required string, unique identifier for the item
current_owner	required string, owner of the item currently
current_folder	optional string, folder containing the item. Defaults to the root folder.
target_owner	required string, desired owner of the item
target_folder	optional string, folder to move the item to.

Returns:

a boolean, indicating success

reassign_user(username, target_username)

Reassigns all of a user’s items and groups to another user.

Items are transferred to the target user into a folder named <user>_<folder> where user corresponds to the user whose items were moved and folder corresponds to the folder that was moved.

Note

This method must be executed as an administrator. This method also can not be undone. The changes are immediately made and permanent.

Parameter	Description
username	Required string, user who will have items/groups transferred
target_username	Required string, user who will own items/groups after this.

Returns:

a boolean indicating success

remove_group_users(user_names, group_id)

Remove users from a group.

Parameter	Description
user_names	required string, comma-separated list of users
group_id	required string, the id for a group.

Returns:

a dictionary with a key notRemoved that is a list of users not removed.

reset_user(username, password, new_password=None, new_security_question=None, new_security_answer=None)

Resets a user’s password, security question, and/or security answer.

Note

This function does not apply to those using enterprise accounts that come from an enterprise such as ActiveDirectory, LDAP, or SAML. It only has an effect on built-in users.

If a new security question is specified, a new security answer should be provided.

Parameter	Description
username	Required string, account being reset
password	Required string, current password
new_password	Optional string, new password if resetting password
new_security_question	Optional int, new security question if desired
new_security_answer	Optional string, new security question answer if desired

Returns:

a boolean, indicating success

search(q, bbox=None, sort_field='title', sort_order='asc', max_results=1000, outside_org=False, categories=None, category_filters=None)

search_groups(q, sort_field='title', sort_order='asc', max_groups=1000, outside_org=False, categories=None, filter=None)

Searches for portal groups.

Note

A few things that will be helpful to know.

1. The query syntax has quite a few features that can’t be adequately described here. The query syntax is available in ArcGIS help. A short version of that URL is http://bitly.com/1fJ8q31.

2. Most of the time when searching groups you want to search within your organization in ArcGIS Online or within your Portal. As a convenience, the method automatically appends your organization id to the query by default. If you don’t want the API to append to your query set outside_org to True.

Parameter	Description
q	required string, query string. See notes.
sort_field	optional string, valid values can be title, owner, created
sort_order	optional string, valid values are asc or desc
max_groups	optional int, maximum number of groups returned
outside_org	optional boolean, controls whether to search outside your org
categories	optional string.
filter	optional string.

Returns:

A list of dictionaries. Each dictionary has the following keys.

Key	Value
access	string, values=private, org, public
created	int, ms since 1 Jan 1970
description	string
id	string, unique id for group
isInvitationOnly	boolean
isViewOnly	boolean
modified	int, ms since 1 Jan 1970
owner	string, user name of owner
phone	string
snippet	string, short summary of group
sortField	string, how shared items are sorted
sortOrder	string, asc or desc
tags	string list, user supplied tags for searching
thumbnail	string, name of file. Append to http://<community url>/groups/<group id>/info/
title	string, name of group as shown to users

search_users(q, sort_field='username', sort_order='asc', max_users=1000, outside_org=False, exclude_system=True, user_type=None, role=None)

Searches portal users.

This gives you a list of users and some basic information about those users. To get more detailed information (such as role), you may need to call get_user on each user.

Note

A few things that will be helpful to know.

1. The query syntax has quite a few features that can’t be adequately described here. The query syntax is available in ArcGIS help. A short version of that URL is http://bitly.com/1fJ8q31.

2. Most of the time when searching groups you want to search within your organization in ArcGIS Online or within your Portal. As a convenience, the method automatically appends your organization id to the query by default. If you don’t want the API to append to your query set outside_org to True. If you use this feature with an OR clause such as field=x or field=y you should put this into parenthesis when using outside_org.

Parameter	Description
q	required string, query string. See notes.
sort_field	optional string, valid values can be username or created
sort_order	optional string, valid values are asc or desc
max_users	optional int, maximum number of users returned
outside_org	optional boolean, controls whether to search outside your org
exclude_system	Optional boolean. Controls if built-in system accounts are returned or not. True means built-in account are not returned, where as False means that they are.
user_type	Optional String. Ability to filter users by the assigned type of user account.
role	Optional String. Filters user by assigned role.

Returns:

A a list of dictionary objects with the following keys:

Key	Value
created	time (int), when user created
culture	string, two-letter language code
description	string, user supplied description
fullName	string, name of the user
modified	time (int), when user last modified
region	string, may be None
tags	string list, of user tags
thumbnail	string, name of file
username	string, name of the user

share_item(item_id, owner, folder=None, everyone=False, org=False, groups='', allow_members_to_edit=False)

Shares an item with the specified list of groups

Parameter	Description
item_id	Required string, unique identifier for the item
owner	Required string, owner of the item currently
folder	Optional string, folder containing the item. Defaults to the root folder.
everyone	Optional boolean, share with everyone
org	Optional boolean, share with the organization
groups	Optional string, Comma-separated list of group IDs with which the item will be shared.
allow_members_to_edit	Optional boolean to allow item to be shared with groups that allow shared update

Returns:

Dictionary with key “notSharedWith” containing array of groups with which the item could not be shared.

share_item_as_group_admin(item_id, groups='', allow_members_to_edit=False)

Shares public item with the specified list of groups belonging to caller

Returns:

dict with key “notSharedWith” containing array of groups with which the item could not be shared.

signup(username, password, fullname, email)

Signs up users to an instance of Portal for ArcGIS.

Note

This method only applies to Portal and not ArcGIS Online. This method can be called anonymously, but keep in mind that self-signup can also be disabled in a Portal. It also only creates built-in accounts, it does not work with enterprise accounts coming from ActiveDirectory or your LDAP.

There is another method called createUser that requires administrator access that can always be used against 10.2.1 portals or later that can create users whether they are builtin or enterprise accounts.

Parameter	Description
username	required string, must be unique in the Portal, >4 characters
password	required string, must be >= 8 characters.
fullname	required string, name of the user
email	required string, must be an email address

Returns:

a boolean indicating success

unshare_item(item_id, owner, folder=None, groups='')

Stops sharing the item with the specified list of groups

Parameter	Description
item_id	Required string, unique identifier for the item
owner	Required string, owner of the item currently
folder	Optional string, folder containing the item. Defaults to the root folder.
groups	Optional string, comma-separated list of group IDs with which the item will be unshared.

Returns:

dict with key “notUnsharedFrom” containing array of groups from which the item could not be unshared.

unshare_item_as_group_admin(item_id, groups='')

Stops sharing public item with the specified list of groups belonging to caller

Parameter	Description
item_id	required string, unique identifier for the item
groups	optional string, comma-separated list of group IDs with which the item will be unshared.

Returns:

dict with key “notUnsharedFrom” containing array of groups from which the item could not be unshared.

update_group(group_id, title=None, tags=None, description=None, snippet=None, access=None, is_invitation_only=None, sort_field=None, sort_order=None, is_view_only=None, thumbnail=None, max_file_size=None, users_update_items=None, clear_empty_fields=False, display_settings=None, is_open_data=False, leaving_disallowed=False, hidden_members=False, membership_access=None, autojoin=False)

Updates a group.

Note

Only provide the values for the arguments you wish to update.

Returns:

a boolean indicating success

update_item(itemid, item_properties=None, data=None, thumbnail=None, metadata=None, owner=None, folder=None, large_thumbnail=None)

Updates an item in a Portal.

Note

That content can be a file (such as a layer package, geoprocessing package, map package) or it can be a URL (to an ArcGIS Server service, WMS service, or an application).

If you are uploading a package or other file, provide a path or URL to the file in the data argument.

Only pass in arguments for properties you want to update. All other properties will be left as they are. If you want to update description, then only provide the description argument in item_properties.

Parameter	Description
item_properties	Optional dictionary, see below for the keys and values
data	Optional string, either a path or URL to the data
thumbnail	Optional string, either a path or URL to an image
metadata	Optional string, either a path or URL to metadata.
owner	Optional string, defaults to logged in user.
folder	Optional string, content folder where placing item
large_thumbnail	Optional string, either a path or URL to an image

Key	Value
type	Optional string, indicates type of item. See URL 1 below for valid values.
typeKeywords	Optional string list. Lists all sub-types. See URL 1 for valid values.
description	Optional string. Description of the item.
title	Optional string. Name of the item.
url	Optional string. URL to item that are based on URLs.
tags	Optional string of comma-separated values. Used for searches on items.
snippet	Optional string. Provides a very short summary of the what the item is.
extent	Optional string with comma separated values for min x, min y, max x, max y.
spatialReference	Optional string. Coordinate system that the item is in.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string, any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values: private, shared, org, or public.
commentsEnabled	Optional boolean. Default is true. Controls whether comments are allowed.
culture	Optional string. Language and country information.

URL 1: http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r3000000ms000000

Returns:

a boolean, that indicates success.

update_user(username, access=None, preferred_view=None, description=None, tags=None, thumbnail=None, fullname=None, email=None, culture=None, region=None, user_type=None)

Updates a user’s properties.

Note

Only pass in arguments for properties you want to update. All other properties will be left as they are. If you want to update description, then only provide the description argument.

Parameter	Description
username	Required string, name of the user to be updated.
access	Optional string, values: private, org, public
preferred_view	Optional string, values: Web, GIS, null
description	Optional string, a description of the user.
tags	Optional string, comma-separated tags for searching
thumbnail	Optional string, path or url to a file. can be PNG, GIF, JPEG, max size 1 MB
fullname	Optional string, name of the user, only for built-in users
email	Optional string, email address, only for built-in users
culture	Optional string, two-letter language code, fr for example
region	Optional string, two-letter country code, FR for example

Returns:

a boolean indicating success

update_user_role(username, role)

Updates a user’s role.

Note

There are three types of roles in Portal - user, publisher, and administrator. A user can share items, create maps, create groups, etc. A publisher can do everything a user can do and create hosted services. An administrator can do everything that is possible in Portal.

Parameter	Description
username	required string, the name of the user whose role will change
role	required string, one of these values org_user, org_publisher, org_admin

Returns:

a boolean, that indicates success

url = None

usage(startTime, endTime, period, vars, etype, stype, groupby, appId=None)

user_folders(owner)

user_items(owner, folder, max_results=100)

Bases: _BaseKube

A representation of the Kubernetes Hosting Service Directory.

This is a private method and should not be created by a user.

find(service_name, folder=None)

finds a service based on it’s name in a given folder

property folders

returns a list of server folders

get(name, folder=None)

returns a single service in a folder

list(folder=None)

returns a list of services at the given folder

publish_sd(sd_file, folder=None, service_config=None)

Publishes a service definition file to ArcGIS Server.

Parameter	Description
sd_file	Required string. The service definition file to be uploaded and published.
folder	Optional string. The folder in which to publish the service definition file to. If this folder is not present, it will be created. The default is None in which case the service definition will be published to the System folder.
service_config	Optional Dict[str, Any]. A set of configuration overwrites that overrides the service definitions defaults.

Returns:

A boolean indicating success (True) or failure (False).

report(as_html=True, folder=None)

Generates a table of Services in the given folder, as a Pandas dataframe.

Bases: _BaseKube

Provides access to the web adaptor resources defined on the ArcGIS Enterprise.

property configuration

This resource is a collection of configuration properties that apply to the ArcGIS Enterprise on Kubernetes Web Adaptor configured with your deployment. The only supported property is sharedKey, which represents credentials that are shared with the web adaptor. The web adaptor will use these credentials to communicate with your deployment.

unregister_adaptor(adaptor_id)

This operation unregisters an ArcGIS Enterprise on Kubernetes Web Adaptor from your deployment. Once a web adaptor has been unregistered, the web adaptor will no longer be trusted and its credentials will not be accepted. This operation is typically used when you want to register a new ArcGIS Enterprise on Kubernetes Web Adaptor or when the previous one needs to be updated.

Parameter	Description
adaptor_id	Required string. The web adaptor to unregister.

web_adaptor(adaptor_id)

This resource returns the properties of an individual web adaptor, such as the HTTP and HTTPS ports.

Parameter	Description
adaptor_id	Required string. The specific web adaptor to get.

Bases: _BaseKube

Provides access to the architecture resources defined on the ArcGIS Enterprise.

property development

The development architecture profile is designed for use in nonproduction environments, including those for testing and evaluation, and requires the least amount of hardware and resources. This profile prioritizes replicated pods for publishing tools and the private ingress controller, setting replicas for both pods at 2. All other pod replicas are set as 1.

Returns:

Dict[str, Any]

property enhanced

The enhanced-availability architecture profile is designed for use in business or mission-critical production environments. This profile is designed for the highest level of availability, as it includes increased and expanded redundancy across critical pods. As a high-availability profile, enhanced-availability provides continued use and availability in the event of a failure. However, of the available profiles, the hardware requirements are the highest.

Returns:

Dict[str, Any]

property standard

The standard-availability architecture profile is designed for use in production environments and those wanting to minimize unplanned downtime with redundancy across many pods. As a high-availability pod, standard-availability provides continued use and availability in the even of a failure, and requires less hardware than enhanced-availability.

Returns:

Dict[str, Any]

Bases: BasePortalAdmin

Simple Usage Reports from ArcGIS Online

applications(start_time=None, time_frame='week')

Creates a usage report for all registered application logins for a given ArcGIS Online organization.

Note

Output can contain users outside your organization that used organization applications

Parameter	Description
start_time	optional datetime, the time to step back from. If None, the current time is used.
time_frame	optional string, is the timeframe report to create. Allowed values: today, week, 14days, 30days, 60days, 90days, 6months, year

Returns:

dictionary with the number of application logins grouped by application and username.

Results aggregated by:

• hour if time_frame is today

• day if time_frame is week, 7days, 14days, 30days, 60days or 90days

• week if time_frame is 6months

• month if time_frame is year

# Usage example:

>>> import datetime as dt
>>> from arcgis.gis import GIS

>>> gis = GIS(profile="my_organizational_profile)
>>> jan2_23 = dt.datetime(2023, 1, 2)

>>> usage_reporter = gis.admin.usage_reports

>>> usage_reporter.applications(start_time= jan2_23,
                                time_frame="week")

{'startTime': 1672099200000,
'endTime': 1672704000000,
'period': '1d',
'data': [{'etype': 'svcusg',
        'stype': 'applogin',
        'username': <username 1>,
        'userOrgId': 'JXwx ... Ok2o',
        'appId': 'arcgisnotebooks',
        'appOrgId': 'Ab3e ... q0o7i',
        'num': [['1672099200000', '0'],
                ...
                ['1672444800000', '4'],
                ['1672531200000', '3'],
                ['1672617600000', '0']]},
 ...
 ...
        {'etype': 'svcusg',
         'stype': 'applogin',
         'username': 'external username2',
         'userOrgId': 'JLxMbZo4ex3kOa2o',
         'appId': 'arcgisonline',
         'appOrgId': 'Ab3e ... q0o7i',
         'num': [['1672099200000', '0'],
                 ...
                 ['1672444800000', '62'],
                 ['1672531200000', '10'],
                 ['1672617600000', '0']]}]}

credit(start_time=None, time_frame='week', export=False)

Creates a Panda’s dataframe or CSV file reporting on credit consumption within an ArcGIS Online organization.

Parameter	Description
start_time	optional datetime, the time to step back from. If None, the current time is used.
time_frame	optional string, is the timeframe report to create. Allowed values: today, week (default), 14days, 30days, 60days, 90days, 6months, year
export	optional boolean, if True, a csv is generated from the request. If False, a Panda’s dataframe is returned. Default is False

Returns:

string path to csv file or Panda’s Dataframe (default) that records the total number of credits consumed per:

• hour if time_frame is today

• day if time_frame is week, 7days, 14days, 30days, 60days or 90days

• week if time_frame is 6months

• month if time_frame is year

# Usage example

>>> usage_reporter = gis.admin.usage_reports

>>> usage_reporter.credit(start_time= jan2_23,
                          time_frame= "week")

    date    credits
    ________________________________________
    0       2022-12-26 16:00:00     173.1696
    ...
    6       2023-01-01 16:00:00     177.6483

generate_report(focus='org', report_type='users', title=None, duration=None, start_time=None, notify=False, future=True)

Generates the reports of the overall usage of the organizations. Reports define organization usage metrics for either a weekly or monthly time frame.

Parameter	Description
focus	Optional String. The report type. Currently, only the organization (org) report type is supported.
report_type	Required String. The type of report to generate. Values: ‘content’ ‘users’ ‘activity’ ‘credits’ ‘serviceUsages’ ‘itemUsages’
title	deprecated Optional String. The output report item’s title.
duration	Optional String. Specifies the time duration for the reports. This parameter is required when report_type is set to credits, activity, serviceUsages, or itemUsages. Note The daily value is only available when report_type is set to activity. The yearly value is only available when report_type is set to itemUsages. Values: ‘daily’ ‘weekly’ ‘monthly’ ‘quarterly’ ‘yearly’
start_time	Optional datetime.datetime. The start time of the time duration. The time format is Unix time with millisecond precision. If duration = ‘weekly’, the start_time value must be a time on Sunday or Monday GMT. If duration = ‘monthly, the start_time value must be on the first day of the month.
notify	Optional Boolean. The Job will print a message upon task completion.
future	Optional Boolean. Returns an asynchronous Job when True, when False, returns an Item.

Returns:

Async Job Object or Item

users(start_time=None, time_frame='week')

Creates a credit usage report for resources of an ArcGIS Online organization with results aggregated by specific username and user’s organization id.

Note

Reports can contain users outside your organization.

Parameter	Description
start_time	optional datetime, the time to step back from. If None, the current time is used.
time_frame	optional string, is the timeframe report to create. Allowed values: today, week, 14days, 30days, 60days, 90days, 6months, year

Returns:

dictionary reporting the number of credits consumed by users through this organization.

Results are aggregated by:

• hour if time_frame is today

• day if time_frame is week, 7days, 14days, 30days, 60days or 90days

• week if time_frame is 6months

• month if time_frame is year

 # Usage Example:

 >>> from arcgis.gis import GIS
 >>> import datetime as dt

 >>> gis = GIS(profile="my_organizational_profile")
 >>> usage_reporter = gis.admin.usage_reports

 >>> jan2_23 = dt.datetime(2023, 1, 2)
 >>> user_usg = usage_reporter.users(start_time = jan2_23,
                                     time_frame = "week")

 >>> list(user_usg.keys())
 ['startTime', 'endTime', 'period', 'data']

 >>> type(user_usg["data"])
 list

 ### The data key's value will be a list of
 ### dictionaries. Each dictionary will have varying keys.
 ### If the dictonary has no userOrgId key, that indicates
 ### a public user account.

 >>> user_usg['data'][1]
 {'username': '<user_name1>',
  'credits': [['1672099200000', '0.0'],
              ['1672185600000', '0.0'],
              ...
              ['1672617600000', '2.0E-4']]}

>>> user_usg['data'][2]
{'username': '<user_name2>',
 'userOrgId': 'JXrNeAy8ce1q2b4l'
 'credits': [['1672099200000', '0.0'],
             ['1672185600000', '0.0'],
            ...
             ['1672617600000', '0.0']]}

Bases: object

This represents a single instance of an application bundle

assign(users)

Assigns the current application bundle to a list of users

Parameter	Description
users	Required List. A list of user names or User objects to assign the current application bundle to.

Returns:

Boolean. True if successful else False

property properties

returns the application bundles properties

revoke(users)

Revokes the current application bundle to a list of users

Parameter	Description
users	Required List. A list of user names or User objects to remove the current application bundle to.

Returns:

Boolean. True if successful else False.

property users

returns a list of users assigned the application bundle

Bases: object

This class allows for the addition, removal and viewing of category schema.

add(items, category)

Adds a category to an existing set of items

Parameter	Description
items	Required Items. The content within a GIS that will be updated with a list of categories.
category	Required String. Assigns a category value to the items.

Returns:

Dictionary indicating ‘success’ or ‘error’

>>> item = [gis.content.get("<item id 1>"),
            gis.content.get("<item id 2>")]
>>> cs = gis.admin.category_schema
>>> print(cs.add(items=[item], category="/Categories/TEST3"))
[{'results': [{'itemId': '<item id 1>', 'success': True}]},
 {'results': [{'itemId': '<item id 2>', 'success': True}]}]

categorize_item(item, categories)

Assigns or removes a category to a single item.

Parameter	Description
item	Required Item or Item ID (string). The content within a GIS that will be updated with a list of categories.
categories	Required list. Assigns a list of string values to the item’s categories

Returns:

Boolean. True if successful else False

remove(items, category)

remove a category to an item or items

replace(items, old_category, new_catgory)

finds and replaces a category value with a new value one

reset(items)

deletes all the categories for a given set of items

property schema

Get/Set the catagory schema for a GIS.

When schema is used as a getter, then operation returns the GIS’ defined category schema is any.

When schema is used as a setter, the parameter:

Parameter	Description
value	optional list. The schema list. Syntax Example: [ { “title”: “Themes”, “categories”: [ { “title”: “Basemaps”, “categories”: [ {“title”: “Partner Basemap”}, { “title”: “Esri Basemaps”, “categories”: [ {“title”: “Esri Redlands Basemap”}, {“title”: “Esri Highland Basemap”} ] } ] }, { “title”: “Region”, “categories”: [ {“title”: “US”}, {“title”: “World”} ] }]}]

Bases: object

This class provides properties for getting information about the classification schema and methods for managing it. This class is not meant to be initialized directly, but is accessed by using the classification property on the ArcGIS Enterprise admin object.

>>> from arcgis.gis import GIS
>>> gis = GIS(profile="your_enterprise_admin_profile")

>>> classification_mgr = gis.admin.classification
>>> classification_mgr

Classification Manager @ <enterprise_url>/portal/sharing/rest/portals/self/classification