Bases:_BaseKube

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

#Usage Example:>>>gis=GIS(profile="your_kubernetes_admin_profile")>>>kube_admin=gis.admin>>>kube_admin<KubernetesAdminathttps://kubenetes.example.com/arcgis/admin>

propertycategory_schema

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

Returns:

CategoryManager object

propertyclassification:ClassificationManager

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

Returns:

An instance of theClassificationManager.

propertycollaborations

The collaborations resource lists all collaborations in which aportal participates

content(item_type:'ItemTypeEnum'|None=None,sort_field:str='created',order:str='asc')

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

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.

propertydatastores:DataStores

Provides access to the _DatastoreManager_, allowing the administratorto manage registered datastores.

Returns:

A KubernetesDataStores object.

propertyjobs:JobManager

This resource is a collection of the asynchronousjobs created in yourdeployment. When operations that support asynchronous executions arerun with the async option enabled, a new job entry is created thatcan be queried for its current status and messages.

propertylicense:LicenseManager

Provides access to theLicenseManager,and its set of tools to access and manage user licenses andentitlements.

propertylogs:LogManager

Accesses aLogManager object tomanage and query the Kubernetes logs.

propertymetadata

Accesses theMetadataManager whichprovides a set of tools to work with the organization’s metadatasettings.

propertymode:Mode

Provides access to aMode objectto help manageservice deployment modes.

propertyorganizations

Provides access to theKubeOrganizationsobject to work with the organization’s settings.

propertyoverview:Overview

Provides access to theoverviewresource to access persisted cache or real-time information.

Returns:

Overview object

scheduled_tasks(item:Item|None=None,active:bool|None=None,user:User|None=None,types:str|None=None)

This method allows organization admins to see all scheduled taskson 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 ofTasks.

propertysecurity:KubeSecurity

Gets aKubeSecurity object to workwith the site’s security settings

Returns:

KubeSecurity object.

propertyservices

Provides access to the KubernetesServicesManager object for the site

propertyservices_catalog

Provides access to the kubernetesKubeServiceDirectory work with theservices on the site.

propertysocial_providers

Accesses theSocialProviders resource toallow for the setting and configuration of the social providersfor the organization.

propertysystem:SystemManager

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

Returns:

SystemManager object.

propertyuploads

Gets theUploads object to workwith the site uploads.

propertyusage:UsageStatistics

Provides access to the metrics viewer and metrics API tools.

Returns:

AnUsageStatistics object.

propertywebhooks

Provides access to the organiztion’sWebhookManager.

Bases:object

Kubernetes Sharing API Implementation

add_group_users(user_names:list[str],group_id:str,admin_names:list[str])

Adds users to the group specified.

Note

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

Returns:

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

add_item(item_properties:dict[str,Any],data:str|None=None,thumbnail:str|None=None,metadata:str|None=None,owner:str|None=None,folder:str|None=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 URLto 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 descriptionbe 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 isfalse. 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:str,owner:str,folder:str|None=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:str,title:str)

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:str,tags:list[str]|str,description:str|None=None,snippet:str|None=None,access:str='public',thumbnail:str|None=None,is_invitation_only:bool=False,sort_field:str='avgRating',sort_order:str='desc',is_view_only:bool=False,auto_join:bool=False,provider_group_name:str|None=None,provider:str|None=None,max_file_size:int|None=None,users_update_items:bool=False,display_settings:str|None=None,is_open_data:bool=False,leaving_disallowed:bool=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, orlist 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 byrequest. Default is False meaning users can ask to joinby request or join by invitation.
sort_field	Optional string. Specifies how shared items withthe group are sorted.
sort_order	Optional string. Choices are asc or desc for ascendingor 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 requestingmembership 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 allowedbe uploaded/shared to a group. Default value is: 1024000
users_update_items	Optional boolean. Members can update all items in thisgroup. Updates to an item can include changes to theitem’s description, tags, metadata, as well as content.This option can’t be disabled once the group hasbeen created. Default is False.
display_settings	Optional String. Defines the default display for thegroup page to show a certain type of items. The allowedvalues are:apps, all, files, maps, layers, scenes, tools.The default value isall.
is_open_data	Optional Boolean. Defines whether the group can be usedin the Open Data capabilities of ArcGIS Hub. The defaultis False.
leaving_disallowed	Optional boolean. Defines whether users are restrictedfrom choosing to leave the group. If True, only anadministrator can remove them from the group. The defaultis False.

Returns:

a dict containing group properties

create_group_from_dict(group:dict[str,Any],thumbnail:str|None=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 groupdict returned from another PortalPy call and copying it.

Example

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

create_role(name:str,description:str)

Creates a custom role with specified name and description

Returns:

role_id if role is created, else None

create_service(name:str,service_description:str='',has_static_data:bool=False,max_record_count:int=1000,supported_query_formats:str='JSON',capabilities:str|None=None,description:str='',copyright_text:str='',wkid:int=102100,service_type:int='imageService',create_params:dict|None=None,owner:str|None=None,folder:str|None=None,common_params:str|None=None,is_view:bool=False,item_id:str|None=None,tags:list[str]|str|None=None,snippet:str|None=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:str,folder:str)

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:str)

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:str)

Removes the group’s thumbnail

Returns:

Boolean

delete_item(item_id:str,owner:str,folder:str|None=None,force:bool=False,permanent:bool=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. Defaultsto 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:str,reassign_to:str|None=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 youspecify someone in the reassign_to argument then items and groups will betransferred to that user. If that argument is not set then the methodwill 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:str,password:str,expiration:int=60)

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

Note

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

Portal uses a token-based authentication mechanism wherea user provides their credentials and a short-term tokenis used for calls. Most calls made to the Portal REST APIrequire 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:str,folder_name:str)

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:str)

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 inthe 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 tohttp://<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:str,max_items:int=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")foriinresponse["items"]:print(i)

get_group_members(group_id:str)

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")foruserinresponse['users']:printuser

get_group_thumbnail(group_id:str)

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:str)

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 foundthe dictionary has the following keys:

get_item_data(itemid:str,try_json:bool=True,folder:str|None=None)

get_item_dependencies(itemid:str)

get_item_dependents_to(itemid:str)

get_org_roles(max_roles:int=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:int=1000,exclude_system:bool=True,user_type:str|None=None,role:str|None=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()foruserinresp:printuser['username']

get_properties(force:bool=False)

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

get_user(username:str)

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 foundthe 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:bool=False)

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

Note

The version information is retrieved when you create thePortal object and then cached for future requests. If youwant to make a request to the Portal and not rely on thecache 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 numberthat may not match the version of the product purchased. So2.3 is returned from Portal 10.2.1 for instance.

invite_group_users(user_names:list[str],group_id:str,role:str='group_member',expiration:int=10080)

Invites users to a group.

Note

A user who is invited to a group will see a list of invitationsin the “Groups” tab of portal listing invitations. The usercan 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.

propertyis_all_ssl

Returns true if this portal requires SSL.

propertyis_arcgisonline

Returns true if this portal is ArcGIS Online.

propertyis_kubernetes

Returns true if this portal is kubernetes.

propertyis_logged_in

Returns true if logged into the portal.

propertyis_multitenant

Returns true if this portal is multitenant.

propertyis_org

Returns true if this portal is an organization.

propertyis_subscription

Returns true if this portal is an ArcGIS Online subscription.

leave_group(group_id:str)

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:str,password:str,expiration:int=60)

Logs into the portal using username/password.

Note

You can log into a portal when you construct a portalobject or you can login later. This function isfor 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, allsubsequent portal calls will be anonymous until another logincall occurs.

Returns:

No return value.

move_item(itemid:str,owner:str,current_folder:str,folder_id:str)

Moves the item to given folder

protect_item(item_id:str,owner:str,folder:str|None=None,enable:bool=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 toto disable it

Returns:

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

publish_item(itemid:str,data:str|None=None,text:str|None=None,fileType:str='serviceDefinition',publishParameters:dict[str,Any]|None=None,outputType:str|None=None,overwrite:bool=False,owner:str|None=None,folder:str|None=None,buildInitialCache:bool=False,item_id:str|None=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.Seehttp://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Publish_Item/02r300000080000000/

reassign_group(group_id:str,target_owner:str)

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:str,current_owner:str,target_owner:str,current_folder:str|None=None,target_folder:str|None=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 thereassign_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:str,target_username:str)

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 weremoved and folder corresponds to the folder that was moved.

Note

This method must be executed as an administrator. This method alsocan 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:list[str],group_id:str)

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:str,password:str,new_password:str|None=None,new_security_question:int|None=None,new_security_answer:str|None=None)

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

Note

This function does not apply to those using enterprise accountsthat 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 shouldbe 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:str,bbox=None,sort_field:str='title',sort_order:str='asc',max_results:int=1000,outside_org:bool=False,categories:str|None=None,category_filters:str|None=None)

search_groups(q:str,sort_field:str='title',sort_order:str='asc',max_groups:int=1000,outside_org:bool=False,categories:int|None=None,filter:str|None=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’tbe adequately described here. The query syntax isavailable in ArcGIS help. A short version of that URLishttp://bitly.com/1fJ8q31.

2. Most of the time when searching groups you want tosearch within your organization in ArcGIS Onlineor within your Portal. As a convenience, the methodautomatically appends your organization id to the query bydefault. If you don’t want the API to append to your queryset 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 tohttp://<community url>/groups/<group id>/info/
title	string, name of group as shown to users

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

Searches portal users.

This gives you a list of users and some basic informationabout those users. To get more detailed information (such as role), youmay 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’tbe adequately described here. The query syntax isavailable in ArcGIS help. A short version of that URLishttp://bitly.com/1fJ8q31.

2. Most of the time when searching groups you want tosearch within your organization in ArcGIS Onlineor within your Portal. As a convenience, the methodautomatically appends your organization id to the query bydefault. If you don’t want the API to append to your queryset outside_org to True. If you use this feature with anOR clause such as field=x or field=y you should put thisinto 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 outsideyour org
exclude_system	Optional boolean. Controls if built-in system accounts arereturned or not. True means built-in account are notreturned, where as False means that they are.
user_type	Optional String. Ability to filter users by the assignedtype 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:str,owner:str,folder:str|None=None,everyone:bool=False,org:bool=False,groups:str='',allow_members_to_edit:bool=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 willbe shared.
allow_members_to_edit	Optional boolean to allow item to be shared with groupsthat 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:str,groups:str='',allow_members_to_edit:bool=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:str,password:str,fullname:str,email:str)

Signs up users to an instance of Portal for ArcGIS.

Note

This method only applies to Portal and not ArcGISOnline. This method can be called anonymously, butkeep in mind that self-signup can also be disabledin a Portal. It also only creates built-inaccounts, it does not work with enterpriseaccounts coming from ActiveDirectory or yourLDAP.

There is another method called createUser thatrequires administrator access that can alwaysbe used against 10.2.1 portals or later thatcan create users whether they are builtin orenterprise 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:str,owner:str,folder:str|None=None,groups:str='')

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:str,groups:str='')

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:str,title:str|None=None,tags:list[str]|str|None=None,description:str|None=None,snippet:str|None=None,access:str|None=None,is_invitation_only:bool|None=None,sort_field:str|None=None,sort_order:str|None=None,is_view_only:bool|None=None,thumbnail:str|None=None,max_file_size:int|None=None,users_update_items:str|None=None,clear_empty_fields:bool=False,display_settings:str|None=None,is_open_data:bool=False,leaving_disallowed:bool=False,hidden_members:bool=False,membership_access:str|None=None,autojoin:bool=False)

Updates a group.

Note

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

Returns:

a boolean indicating success

update_item(itemid:str,item_properties:dict[str,Any]|None=None,data:str|None=None,thumbnail:str|None=None,metadata:str|None=None,owner:str|None=None,folder:str|None=None,large_thumbnail:str|None=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 URLto 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 youwant to update description, then only providethe 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:str,access:str|None=None,preferred_view:str|None=None,description:str|None=None,tags:list[str]|str|None=None,thumbnail:str|None=None,fullname:str|None=None,email:str|None=None,culture:str|None=None,region:str|None=None,user_type:str|None=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 youwant to update description, then only providethe 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