Skip To Content
ArcGIS Developers
Dashboard

Quick reference

Site root

NameEndpoint typeDescription

Site Root

Resource

The root resource returns the version of the containing portal. It acts as a root to its child resources and operations. All other URIs in this table are listed relative to the root URI.

Generate Token

Operation

The Generate Token operation generates an access token in exchange for user or application credentials. All requests to portals that access secured resources need to include an access token or other authentication credentials depending on the portal.

Search

NameEndpoint typeDescription

Search root

Operation

The Search operation searches against the content in the portal. The search index is updated whenever users add, update, or delete content. There can be a lag between the time the content was updated and the time when it's reflected in the search results. The results only contain items that the user, represented by the access token, has permission to access.

Suggest

Operation

The suggest operation provides user a list of related results as they type character-by-character into the search query. The suggestion only contains items that the user has permission to access.

Community

NameEndpoint typeDescription

Community Root

Resource

The portal community root covers user and group resources and operations.

It's a placeholder URI in that there is no response available at this URI. It acts as a root to its child resources and operations.

Create Group

Operation

The Create Group operation (POST only) creates a new group.

Only authenticated users can create groups. The user who creates the group automatically becomes the owner of the group. The owner of the group is automatically an administrator for the group. The user provides the title for the group. The group ID is generated by the system. If the creating user is part of an organization, the created group is part of the same organization.

Self

Resource

The community/self resource returns the resource corresponding to the current authenticated user.

Users

NameEndpoint typeDescription

Users (search)

Operation

The User Search operation can be used to search for users within the portal.

The search index is updated whenever users are created, updated, or deleted. There can be a lag between the time the user was updated and the time when it's reflected in the search results.

The scope of the search is the caller's organization if the caller belongs to an organization for which canSearchPublic is false.

User

Resource

A user resource that represents a registered user in the portal.

Personal details of the user, such as email and groups, are returned only to the user or to an administrator within the user's organization.

Registered usernames are required to be unique within each identity provider supported by a portal.

Accept Invitation

Operation

Group administrators can invite users into their groups; this results in the user receiving new invitations to which they can respond. The invited user can accept the invitation using the Accept Invitation operation (POST only). This operation adds the invited user to the group, and the invitation is deleted. This operation also creates a notification for the group administrator indicating that the invitation was accepted. Available only to authenticated users.

Decline Invitation

Operation

An invited user can decline an invitation using the Decline Invitation operation (POST only). This operation deletes the invitation and creates a notification for the group administrator indicating that the invitation was declined. The invited user is not added to the group. Available only to authenticated users.

Delete Notification

Operation

The Delete Notification operation (POST only) is available only to the user of the notification.

Delete User

Operation

The Delete User operation (POST only) is available only to the user in question or to the administrator of the user's organization.

Disable

Operation

The Disable operation disables login access for a user the user. This operation is only available to organization administrators.

Enable

Operation

The Enable operation enables login access for the user. This operation is only available to organization administrators.

Notifications

Resource

The notifications that are available for the given user. Notifications are events that need the user's attention—application for joining a group administered by the user, acceptance of a group membership application, and so on. A notification is initially marked as new. The user can mark it as read or delete the notification.

Notification

Resource

A user notification resource available only to the user in question. A notification has the following fields:

{id : string, type : enum, data: string, status : enum }

Status is either new or read.

Type is the type of notification, e.g., "application to join group" or "invitation to join group."

Provisioned Listings

Resource

Returns a list of add-on applications that have been assigned to a user. This resource will not return applications that are included in the user's assigned app bundle, and will not return user type extensions included with the user's user type.

Update User

Operation

The Update User operation (POST only) modifies properties such as full name, description, culture, and so on.

The primary identifier (the username property) cannot be modified. It's available only to the user or to the administrator of the user's organization. Only the properties that are to be updated need to be specified in the request. Properties not specified will not be affected.

User App Bundles

Resource

Returns a list of app bundles assigned to a user. These app bundles are those that are assigned in addition to the bundles that are included with a user's user type.

User Invitations

Resource

The set of invitations that apply to the current user. Group administrators can invite users into their groups, resulting in the user receiving new invitations to which they can respond.

User Invitation

Resource

An individual invitation for a given user.

User License Type

Resource

Returns a user's assigned license type. If viewed in through the JSON format, more detailed information about the licenses included with the assigned user type are returned.

User Tags

Resource

Users can add tags to content they own. This resource lists all the tags used by the current user along with the number of times each tag has been used.

Groups

NameEndpoint typeDescription

Groups (search)

Operation

The Group Search operation can be used to search for groups in the portal.

The search index is updated whenever groups are created, updated, or deleted. There can be a lag between the time the group was updated and the time that it's reflected in the search results.

The results only contain groups that the user has permission to access.

Accept Group Application

Operation

When a user applies to join a group, a group application is created. Group administrators can accept this application using the Accept Group Application operation (POST only). This operation adds the applying user to this group, then deletes this application. This operation also creates a notification for the user indicating that the user's group application was accepted. Available only to group admins.

Assign Group Category Schema

Operation

When a user applies to join a group, a group application is created. Group administrators can accept this application using the Accept Group Application operation (POST only). This operation adds the applying user to this group, then deletes this application. This operation also creates a notification for the user indicating that the user's group application was accepted. Available only to group admins.

Add Users to Group

Operation

Allows a group owner, manager, and organization administrators to add organization members directly into a group without requiring them to accept an invitation.

Decline Group Application

Operation

When a user applies to join a group, a group application is created. Group administrators can decline this application using the Decline Group Application operation (POST only). This operation deletes this application and creates a notification for the user indicating that the user's group application was declined. The applying user will not be added to the group. Available only to group admins.

Delete Group

Operation

The Delete Group operation (POST only) is available only to the owner of the group.

Delete Group Category Schema

Operation

Allows a group owner or manager to remove a groups category schema.

Invite to Group

Operation

Using the Invite to Group operation (POST only), a group administrator invites users to join their group. This creates a new user invitation that the users can accept or decline. This operation also creates a notification for the user indicating that the user was invited to join the group. Available only to authenticated users.

Join Group

Operation

Users apply to join a group using the Join Group operation (POST only). This creates a new group application that the group administrators can accept or decline. This operation also creates a notification for the user indicating that the user had applied to join this group. Available only to authenticated users.

Information pertaining to the applying user, such as full name, email address, or organization, can be sent as part of the group application.

Leave Group

Operation

The Leave Group operation (POST only) is available to all group members other than the group owner. Leaving a group automatically results in the unsharing of all items the user has shared with the group.

Group

Resource

The Group resource represents a group within the portal.

Users can create groups and invite others into the group. Members of a group can use the group to share items amongst themselves.

The owner of a group is automatically an administrator. Admins can add members to a group.

Group Applications

Resource

When users apply to join a group, a group application is created. The group administrators can accept or decline. Available only to the group admins.

Group Application

Resource

When an individual user applies to join a group, a group application is created. The group administrators can accept or decline. Available only to the group admins.

Group Category Schema

Resource

Returns the category schema placed set for the group.

Group Users

Resource

The users, owner, and administrators of a given group are returned.

Group Users List

Resource

Returns the users, owner, and administrators of the group.

Protect Group

Operation

Protects the group from deletion.

Reassign Group

Operation

The Reassign Group operation (POST only) allows the administrator of an organization to reassign a group to another member of the organization.

Remove Users from Group

Operation

The operation to Remove Users from Group (POST only) is available only to the group administrators, including the owner. Both users and admins can be removed using this operation. Group owners cannot be removed from the group.

Unprotect Group

Operation

Disables the group deletion protection.

Update Group

Operation

The Update Group operation (POST only) modifies properties such as the group title, tags, and visibility. Available only to the group administrators.

Only the properties that are to be updated need to be specified in the request. Properties not specified will not be affected.

The group name and organization flag cannot be modified.

Content

NameEndpoint typeDescription

Content Root

Resource

The portal content root covers content that is owned by users and shared via groups. It's a placeholder URI in that there is no response available at this URI. It acts as a root to its child resources and operations. All resources and operations (other than publicly accessible items) under this URI require an authenticated user.

Add Comment

Operation

Adds a comment to an item accessible to you (POST only). Available only to authenticated users.

Add Rating

Operation

Adds a rating to an item accessible to you (POST only). Only one rating can be given to an item per user. If this call is made on an already rated item, the new rating will overwrite the current one. A user cannot rate their own item. Available only to authenticated users.

Analyze

Operation

Helps a client analyze a CSV or a shapefile prior to publishing or generating features.

Delete Comment

Operation

Deletes the selected comment (POST only) on an item that you created. Available only to authenticated users.

Delete Provision

Operation

Deletes all of an item's provisions for the specified purchaser.

Delete Rating

Operation

Deletes the rating that you created for the specified item (POST only).

Express Interest

Operation

Allows a purchaser to express interest in a marketplace listing.

Features

Resource

Feature operations consist of analyze and publish.

Generate

Operation

Helps a client generate features from a CSV or shapefile.

Groups

Resource

The Groups resource lists the groups the user can access for a particular item.

Group Content

Resource

The group's content provides access to the items that are shared with the group.

Group items are stored by reference and are not physically stored in a group. Rather, they are stored as links to the original item (/content/items/<itemId>).

Available only to the users of the group.

Group Content Search

Operation

Searches for items in a group.

Item

Resource

An item in the portal. Items have a title, type, snippet, description, tags, an optional URL (if the item represents a service or other web resource with its own URL), and optional associated data that is available as a child resource (/<item>/data).

Each item in a portal has a well-known URI (/content/items/<itemId>) that's common across all users. In addition, each item has an owner-specific URI (/content/users/<userName>[/<folderId>]/items/<itemId>) that's accessible only by the owner of the item. The actual item is stored just once.

The well-known item is the resource returned by all search operations. Search results do not reflect the organization of items within the contributing user's folders.

Item Comments

Resource

Lists all comments for the item accessible to you. Available only to authenticated users.

Item Comment

Resource

Lists details for a particular comment.

Item Data

Resource

The data component of an item. Getting this resource streams the actual data represented by the item to the client. Only certain types of items have associated data as described in the item types page.

The content type of the response is derived from the mime type of the associated data. If the mime type cannot be derived, the response content type will be set to application/octet-stream.

Item Info File

Resource

An item info file such as the item card, thumbnail, documentation, etc., can be packaged with the uploaded file.

The content type of the response is derived from the info file's mime type. If the mime type cannot be derived, the response content type will be set to application/octet-stream.

Item Rating

Resource

Returns the rating given by the current user, if any.

List Item

Resource

Lists a specified item in the marketplace. The listing properties must be specified before an item is listed.

Listings (search)

Operation

This operation searches for marketplace listings.

Listing

Resource

Returns information on a marketplace listing.

Package Info File

Resource

The Package Info File for the uploaded item is only available for items that are ArcGIS packages (e.g., Layer Package, Map Package). It contains information that's used by clients (ArcMap, ArcGIS Pro, ArcGIS Explorer, etc.) to work appropriately with downloaded packages.

The package info file is an XML file, and it's the only format available.

Provision Organization Entitlements

Operation

For a license-by-user listing, selling organization administrator or members can use this operation to provision entitlements for a purchasing organization.

Purchase Listing

Operation

Allows the purchaser or vendor can complete a marketplace listing purchase.

Provision User Entitlements

Operation

For a license-by-user listing, purchasing organization administrators can use this operation to provision entitlements to organization members.

Related Items

Resource

Gets all the items related by a certain relationship type to this item. An optional direction can be specified if the direction of the relationship is ambiguous. Otherwise, the service will try to infer it.

Set Content Status

Operation

Allows item owners or organization administrators to mark an item as authoritative or deprecated to recommended or discourage the user of the item.

Share Item (as group admin)

Operation

Shares a public item with groups that you own. For the item owner, this Share Item resource works the same as user share Item.

Available to the user and the administrator of the organization.

Start Trial

Operation

A purchaser can start a trial for a marketplace listing by invoking this operation.

Unshare Item (as group admin)

Operation

Unshares a public item with groups that you own. For the item owner, this Unshare Item resource works the same as user unshare Item.

Available to the user and the administrator of the organization.

Update Categories

Operation

Allows group owners and managers to add or remove group content categories on group items.

Update Comment

Operation

Updates a comment on an item that you created (POST only). Available only to authenticated users.

Update Items with Content Categories

Operation

Allows item owner and organization administrators to add or remove organization content categories on items.

User Entitlements

Resource

Allows purchasing organization administrators or a user with the specified privilege to retrieve all user entitlements assigned to users in their organization.

User Entitlement

Resource

Allows users, purchasing organization administrators, and members with specified privileges to retrieve entitlements assigned to the user.

User content

NameEndpoint typeDescription

User Content

Resource

Each item in a portal has a unique URI that is common across all users.

In addition, each user has a personal view of the content they own. The user's content is organized into a set of personal folders.

A user's personal view consists of items that are either in the root content folder for the user (the My Contents home folder) or in a subfolder of the home folder with a given folderId. Multilevel folders are not supported. Each item in the portal has both an absolute and an owner-specific URI.

Accessible only to the user.

Add Item

Operation

The Add Item operation (POST only) is used to add an item to a user-specified folder. Adding an item can involve uploading an item file, submitting text content, or submitting a URL. This operation is available only to the user specified in the folder URL. The user owning the folder automatically becomes the owner of the item. The item by default is flagged as private (e.g., not shared with any group). This can be changed with the Share operation on the item.

Add Item Part

Operation

Add Part allows for multipart item uploads. Each upload takes a part number, which must be sequential.

Add Relationship

Operation

Adds a relationship of a certain type between two items.

Relationships are not tied to an item. They are directional links from an origin item to a destination item. They have an owner and a type. The type defines the valid origin and destination item types as well as some "composite" rules. See Relationship types .

Users don't have to own any of the items they relate unless the relationship is a composite relationships.

Users can only delete relationships that they own.

Relationships are deleted automatically if one of the two items is deleted.

Add Resources

Operation

Allows users to add new file resources to an existing item.

Can Delete Item

Operation

Specifies whether an item can be deleted or not.

Cancel

Operation

Cancels the multipart item upload.

Commit

Operation

Commit is called once all parts are uploaded. The parts are combined into a file, and the original uploads are overwritten. The status call checks the status of the operation.

Copy Item

Operation

The copy item operation (POST only) creates a new item that is a copy of the original item on the server side. Hosted services are copied as reference only. Reserved keywords, ratings, views, comments and listing properties are removed from the new item.

Create Folder

Operation

The Create Folder operation (POST only) is available only on the user's root content folder. Multilevel folders are not supported.

The user provides the title for the folder. The folder ID is generated by the system.

Create Proxies

Operation

Creates proxy services that will store and manage credentials and provide authentication.

Create Service

Operation

The Create Service operation can be used for creating hosted feature services.

Create Image Service

Operation

Creates a hosted image service from raster data.

Create Relational Catalog Service

Operation

Creates a relational catalog service on the hosting server.

Delete Folder

Operation

The Delete Folder operation (POST only) is available only on the user's non-root folders. The user's root folder cannot be deleted.

Deleting a folder also deletes all items that it contains.

Delete Info

Operation

Deletes an individual file from an item's esriinfo folder.

Delete Item

Operation

The Delete Item operation (POST only) removes an item owned by the user. Available only to the user and administrators.

Delete Items

Operation

Deletes a batch of items from the user's folder.

Delete Proxies

Operation

Removes hosted proxies from an item.

Delete Proxy

Operation

Removes a proxy service that was set on an item.

Delete Relationship

Operation

Deletes a relationship of a certain type between two items. The current user must own the relationship to delete it. If the relationship does not exist, an error is thrown.

Export Item

Operation

Exports a service item to the specified output format (POST only). Available only to users with an organizational subscription. Invokable only by the service item owner or an administrator.

Export Item Resources

Operation

Exports all file resources of an item into a zip file.

Item Resources

Resource

Returns all file resources associated with an existing item.

Item Resource

Resource

Returns a specific resource associated with an existing item.

Move Item

Operation

The Move Item operation (POST only) moves the item from the current folder to the target folder specified as a parameter. Moving an item does not change the well-known URI item, which continues to be /content/items/<itemId>.

Available only to the user and administrators.

Move Items

Operation

Moves a batch of items from the current folder to the target folder specified as a parameter.

Parts

Resource

Lists the file parts of a multiitem upload.

Protect

Operation

Protects an item from deletion.

Proxies

Resource

Returns the hosted proxy services set on a registered app item.

Proxy

Resource

Returns a hosted proxy set on a registered app item based on the proxyId.

Publish Item

Operation

Publishes a service item to ArcGIS Online. The resulting item is a feature service. Available only to users with an organizational subscription.

Reassign Item

Operation

The Reassign Item operation (POST only) allows the administrator of an organization to reassign a member's item to another member of the organization.

Registered App Info

Resource

Returns information pertaining to a registered app.

Remove Resources

Operation

Removes one or all resources associated with an item.

Replace Service

Operation

Allows you to replace vector tile layers.

Share Items

Operation

Shares a batch of items with the specified list of groups (POST only). Users can only share items with groups to which they belong. This operation also allows you to share items with "everyone", in which case, the items are publicly accessible.

Share Item (as item owner)

Operation

Shares the item with the specified list of groups (POST only). Users can only share items with groups to which they belong. This operation also allows you to share the item with "everyone", in which case, the item is publicly accessible, or with your "organization", in which case, everyone within your organization will have access to it.

Available only to the user and administrators.

Status

Operation

Inquires about status when publishing an item, adding an item in async mode, or adding with a multipart upload. "Partial" is available for Add Item Multipart, when only a part is uploaded and the item is not committed.

Unlist Item

Operation

Unlists a previously listed item from the marketplace.

Unshare Items

Operation

Unshares a batch of items with the specified list of groups (POST only).

Update Folder

Operation

Allows users to rename an existing non-root folder title.

Update Info

Operation

Allows you to upload multiple files to an item's esriinfo folder.

Update Item

Operation

The Update Item operation (POST only) allows users to update information for an item. Users can use this operation to update item information such as the name, description, tags, and so on.

The parameters that are to be updated need to be specified in the request. Parameters not specified will not be affected. All parameters for this operation are optional.

Available only to the user and administrators.

Update Proxy

Operation

Updates a hosted proxy service that has been set on an item.

Update Resources

Operation

Updates an item's existing file resources.

User Item (Link)

Resource

The owner-specific view of an item in a portal. Includes the list of groups that share the item. Access to the item via this URI is available only to the user.

Each item in a portal has a well-known URI (/content/items/<itemId>) that is common across all users. In addition, each item has an owner-specific URI (/content/users/<userName>[/<folderId>]/items/<itemId>) that is accessible only by the owner of the item. The actual item is stored just once.

Unprotect

Operation

Disables the item's deletion protection.

Unshare Item (as item owner)

Operation

Stops sharing the item with the specified list of groups (POST only).

Available only to the user and administrators.

OAuth2

NameEndpoint typeDescription

OAuth2 root

Resource

The root of all OAuth2 resources and responses.

Authorize

Operation

This resource allows apps supporting user logins using OAuth2 to allow users to log in to the ArcGIS platform via the app.

Register App

Operation

Registers an app item with the portal.

Registered App

Resource

Returns information on an app registered with the portal.

Revoke Token

Operation

Invalidates OAuth2 access or refresh tokens.

Token

Operation

This resource allows the issuing and refreshing of user access tokens.

Unregister App

Operation

Removes an item's app registration.

Portals

NameEndpoint typeDescription

Portals root

Resource

A multitenant portal contains multiple portals, each one of which is owned by and represents an organization. Each user in the multitenant portal belongs to one of these organizational portals or to a default portal that includes all users who do not belong to an organization.

The Portals Root resource is a root placeholder resource that covers all the portals contained in the multitenant portal.

Languages

Resource

Lists available languages.

Regions

Resource

Lists available regions.

Portal self

NameEndpoint typeDescription

Portal Self (organization)

Resource

The portal to which the current user belongs. This is an organizational portal if the user belongs to an organization or the default portal if the user does not belong to one.

The Portal resource includes information such as the title, thumbnail, and description for the portal and the groups that contain featured content.

Add Resource

Operation

Adds a resource, such as an image, that can be referenced from the description for a portal.

Assign Category Schema

Operation

Allows organization administrators to set up content categories for an organization.

Assign User Credits

Operation

Allows organization administrators to set up content categories for their organization.

Category Schema

Resource

Returns the content category schema for the organization.

Check Service Name

Operation

This resource checks if a given service name and type are available for publishing a new service. Duplicate names are not allowed. True indicates that the name and type are not found in the organization's services and is available for publishing. False means the requested name and type are not available.

Configure Social Providers

Operation

Allows organization administrators to enable sign up and sign in to the organization using credentials from social networks like Facebook and Google.

Create Role

Operation

Creates a new custom role.

Customers List

Operation

Returns a user's purchases, trials, and interests expressed on items listed by the organization.

Delete Category Schema

Operation

Removes the category schema set for the organization.

Delete User Default Settings

Operation

Allows administrators to clear previously configured new member defaults.

Organization Settings

Resource

Returns a view of the portal's configuration as seen by the current user, either anonymous or logged in.

Portal History

Operation

Allows the organization administrator to query historical events that occurred in the organization.

Purchases

Resource

Returns the purchases, trials, and interests expressed by the organization for items in the marketplace.

Remove Resource

Operation

Removes a resource, such as an image, that can be referenced from the description for a portal.

Remove Social Providers

Operation

Disables the ability for social logins in the organization and removes the social providers.

Remove Users

Operation

Removes users from an organization.

Available only to administrators.

Resources

Resource

Returns the set of descriptive resources for the portal.

Security Policy

Resource

Lists the properties of an organization's security policy.

Set User Default Settings

Operation

Allows administrators to set and edit new member defaults.

Social Providers

Operation

Returns the social login configuration properties for the organization.

Unassign User Credits

Operation

Allows organization administrators to remove credit allocations for users.

Update

Operation

The Update Portal operation allows portal administrators to update the properties of a portal.

Available only to administrators.

Update Organization Settings

Operation

Allows administrators to enable and customize an access notice and informational banner for your organization.

Update Security Policy

Operation

Updates the security policy of an organization.

Update User Level

Operation

Allows administrators of an organization to update the level of a user.

Update User Role

Operation

Updates the role for a specific user within an organization.

Available only to administrators.

Users

Resource

Returns the set of users that belong to the portal.

User Default Settings

Operation

Returns the stored new member default settings.

Certificates

NameEndpoint typeDescription

Certificates

Resource

Returns all custom certificates that are registered with the organization.

Certificate

Resource

Returns certificate information for a specific certificate registered with an organization.

Register HTTPS Certificate

Operation

Allows administrators to register custom X.509 HTTPS certificates with their organization.

Unregister Certificate

Operation

Allows organization administrators to delete a registered certificate.

Update HTTPS Certificate

Operation

Allows organization administrators to update a registered custom X.509 HTTPS certificate.

Collaborations

NameEndpoint typeDescription

Collaborations

Resource

Lists all collaborations the organization participates in.

Accept Collaboration Invitation

Operation

Allows a portal to accept a collaboration invitation.

Add Workspace

Operation

Adds a new workspace to a distributed collaboration.

Collaboration

Resource

Returns information about a specific collaboration.

Create Collaboration

Operation

Creates a collaboration.

Delete Collaboration

Operation

Deletes a distributed collaboration from the host portal & stops any sharing set up from the collaboration.

Delete Schedule

Operation

Deletes a job scheduled for synchronized items in a collaboration workspace.

Delete Service Proxy Config

Operation

Removes stored Viewer (level 1) credentials saved on a collaboration workspace.

Delete Workspace

Operation

Deletes a collaboration workspace.

Export Invitation Response

Operation

Exports a collaboration invitation response file from a collaboration guest portal.

Import Invitation Response

Operation

Imports an invitation response file from a portal collaboration guest.

Invalidate

Operation

Invalidates a previously generated distributed collaboration invitation.

Invite Participant

Operation

Allows you to invite other portals to your collaboration by creating an invitation file.

Invitations

Resource

Returns the invitation information for all the invitations generated by a collaboration host.

Invitation

Resource

Returns the information about a specific invitation.

Participants

Resource

Provides information about all of the participants in a distributed collaboration.

Participant

Resource

Provides information about the collaboration participant with a specified ID.

Pause Schedule

Operation

Suspends a scheduled job for synchronized items in a collaboration workspace.

Refresh

Operation

Refreshes a previously generated distributed collaboration invitation.

Remove Participant

Operation

Allows a collaboration host to remove a participant from a distributed collaboration.

Remove Participation

Operation

Removes collaboration participation by a guest from a collaboration.

Remove Portal Group Link

Operation

Removes the link between a collaboration workspace and a portal group.

Resume Schedule

Operation

Restarts a scheduled job for synchronized items in a collaboration workspace.

Schedule

Resource

Returns a job schedule for synchronized items in a collaboration workspace.

Sync

Resource

Performs a data sync in a workspace.

Sync Status

Resource

Provides a summary of each scheduled sync for items in a collaboration workspace.

Sync Status Details

Operation

Provides a detailed description of status for a selected sync ID.

Update Collaboration Info

Operation

Updates certain properties of a collaboration, such as its name, description, and configuration properties.

Update Item Delete Policy

Operation

Update Participant Access Modes

Operation

Updates the access mode for a specific participant in a distributed collaboration.

Update Participant Info

Operation

Updates the collaboration information for a specific participant.

Update Portal Group Link

Operation

Updates the group linked with a workspace for a participant in a distributed collaboration.

Update Schedule

Operation

Updates or creates a job schedule for synchronized items in a collaboration workspace.

Update Service Proxy Config

Operation

Adds or updates credentials that will be used by other participating portals when accessing services copied by reference.

Update Web-Tier Authentication Configuration

Operation

Adds, updates, or removes the web-tier authentication credentials or certificate used to communicate with another participant in the collaboration.

Update Workspace Info

Operation

Updates collaboration workspace properties.

Validate Collaboration Invitation

Operation

Allows a portal to validate a collaboration invitation.

Validate Invitation Response

Operation

Checks for the existence of the collaboration and validity of the invitation response file.

Workspaces

Resource

Lists all the workspaces in a given collaboration.

Workspace

Resource

Provides information about the collaboration workspace with a specified ID.

Datastores

NameEndpoint typeDescription

Datastores

Resource

Provides access to operations that allows you to manage you data stores and bulk publish layers.

Add to Server

Operation

Registers a data store to ArcGIS Server.

Get Servers for Data Store

Operation

Returns a list of your servers that a given data store has been registered to.

Refresh Server

Operation

Propagates changes, such as data store registration information, to your ArcGIS Server.

Remove from Server

Operation

Unregisters a specified data store from your ArcGIS Server.

Validate Datastore

Operation

Ensures that your ArcGIS Server can connect and use the dataset sotred within a given data store.

All Datasets

Resource

Provides access to bulk publishing operations.

Delete Layers

Operation

Deletes all layers published from the data store.

Get Layers

Operation

Returns a list of layers bulk published from a data store.

Publish Layers

Operation

Publishes, or syncs, the datasets from a data store onto your ArcGIS Server.

IDP

NameEndpoint typeDescription

IDP

Resource

Lists organization identity federation information configured using a single identity provider.

Federation

Resource

Lists organization identity federation information configured using a federation of identity providers.

Register Federation

Operation

Allows organization administrator to configure enterprise login using a SAML-based federation of identity providers.

Register IDP

Operation

Allows organization administrators to configure enterprise logins using a single identity provider.

Update Federation

Operation

Allows organization administrator to edit the configuration of enterprise logins with a SAML-based federation of identity providers.

Update IDP

Operation

Allows the organization administrator to edit the enterprise login configuration with a single IDP.

Unregister Federation

Operation

Allows organization administrators to remove the enterprise login set up with a SAML-based federation of identity providers.

Unregister IDP

Operation

Allows organization administrators to remove the enterprise login set up with a single identity provider.

Roles

NameEndpoint typeDescription

Roles

Resource

Lists all custom roles within the organization.

Delete Role

Operation

Allows default organization administrators to delete a custom role.

Privileges

Resource

Lists all privileges for a custom role.

Role

Resource

Lists properties of a custom role.

Set Role Privileges

Operation

Allows default organization administrators to set privileges for a custom role.

Update Role

Operation

Allows default organization administrators to update properties of a custom role.

Servers

NameEndpoint typeDescription

Servers

Resource

Lists the ArcGIS Server sites that have been federated with the portal.

Register Server

Operation

Registers an ArcGIS Server site with your Portal for ArcGIS deployment.

Server

Resource

Returns information on an ArcGIS Server site that has been federated with the portal.

Unregister Server

Operation

Unregisters an ArcGIS Server site from the portal.

Update Server

Operation

Updates the properties of an ArcGIS Server site that has been registered, or federated, with the portal.

Webhooks

NameEndpoint typeDescription

Webhooks

Resource

Lists all the webhooks for an organization.

Activate Webhook

Operation

Restarts a deactivated webhook.

Create Webhook

Operation

Allows organization administrators to create a new webhook.

Deactivate Webhook

Operation

Pauses the specified webhook.

Delete Webhook

Operation

Permanently removes the specified webhook from the portal.

List a Specific Webhook

Resource

Displays information for specified webhooks and provides access to webhook management operations.

Notification Status

Operation

Displays information pertaining to trigger events associated with the specified webhook.

Update Webhook

Operation

Allows administrators to update any of the previously configured parameters for their webhook.

Update Settings

Operation

Adjusts several advanced parameters that apply to every webhook.

Webhook Settings

Resource

Displays advanced parameters that configure the connection behavior of your webhook.