User Guide Cancel

Export or import organization structure and product allocations

Search
Enterprise

Enterprise

Admin Console
  1. Adobe Enterprise & Teams: Administration guide
  2. Plan your deployment
    1. Basic concepts
      1. Licensing
      2. Identity
      3. User management
      4. App deployment
      5. Admin Console overview
      6. Admin roles
    2. Deployment Guides
      1. Named User deployment guide
      2. SDL deployment guide
      3. Deploy Adobe Acrobat 
    3. Deploy Creative Cloud for education
      1. Deployment home
      2. K-12 Onboarding Wizard
      3. Simple setup
      4. Syncing Users
      5. Roster Sync K-12 (US)
      6. Key licensing concepts
      7. Deployment options
      8. Quick tips
      9. Approve Adobe apps in Google Admin Console
      10. Enable Adobe Express in Google Classroom
      11. Integration with Canvas LMS
      12. Integration with Blackboard Learn
      13. Configuring SSO for District Portals and LMSs
      14. Add users through Roster Sync
      15. Kivuto FAQ
      16. Primary and Secondary institution eligibility guidelines
  3. Set up your organization
    1. Identity types | Overview
    2. Set up identity | Overview
    3. Set up organization with Enterprise ID
    4. Setup Azure AD federation and sync
      1. Set up SSO with Microsoft via Azure OIDC
      2. Add Azure Sync to your directory
      3. Role sync for Education
      4. Azure Connector FAQ
    5. Set up Google Federation and sync
      1. Set up SSO with Google Federation
      2. Add Google Sync to your directory
      3. Google federation FAQ
    6. Set up organization with Microsoft ADFS
    7. Set up organization for District Portals and LMS
    8. Set up organization with other Identity providers
      1. Create a directory
      2. Verify ownership of a domain
      3. Add domains to directories
    9. SSO common questions and troubleshooting
      1. SSO Common questions
      2. SSO Troubleshooting
      3. Education common questions
  4. Manage your organization setup
    1. Manage existing domains and directories
    2. Enable automatic account creation
    3. Set up organization via directory trust
    4. Migrate to a new authentication provider 
    5. Asset settings
    6. Authentication settings
    7. Privacy and security contacts
    8. Console settings
    9. Manage encryption  
  5. Manage users
    1. Overview
    2. Administrative roles
    3. User management strategies
      1. Manage users individually   
      2. Manage multiple users (Bulk CSV)
      3. User Sync tool (UST)
      4. Microsoft Azure Sync
      5. Google Federation Sync
    4. Assign licenses to a Teams user
    5. In-app user management for teams
      1. Manage your team in Adobe Express
      2. Manage your team in Adobe Acrobat
    6. Add users with matching email domains
    7. Change user's identity type
    8. Manage user groups
    9. Manage directory users
    10. Manage developers
    11. Migrate existing users to the Adobe Admin Console
    12. Migrate user management to the Adobe Admin Console
  6. Manage products and entitlements
    1. Manage products and product profiles
      1. Manage products
      2. Buy products and licenses
      3. Manage product profiles for enterprise users
      4. Manage automatic assignment rules
      5. Entitle users to train Firefly custom models
      6. Review product requests
      7. Manage self-service policies
      8. Manage app integrations
      9. Manage product permissions in the Admin Console  
      10. Enable/disable services for a product profile
      11. Single App | Creative Cloud for enterprise
      12. Optional services
    2. Manage Shared Device licenses
      1. What's new
      2. Deployment guide
      3. Create packages
      4. Recover licenses
      5. Manage profiles
      6. Licensing toolkit
      7. Shared Device Licensing FAQ
  7. Get started with Global Admin Console
    1. Adopt global administration
    2. Select your organization
    3. Manage organization hierarchy
    4. Manage product profiles
    5. Manage administrators
    6. Manage user groups
    7. Update organization policies
    8. Manage policy templates
    9. Allocate products to child organizations
    10. Execute pending jobs
    11. Explore insights
    12. Export or import organization structure
  8. Manage storage and assets
    1. Storage
      1. Manage enterprise storage
      2. Adobe Creative Cloud: Update to storage
      3. Manage Adobe storage
    2. Asset migration
      1. Automated Asset Migration
      2. Automated Asset Migration FAQ  
      3. Manage transferred assets
    3. Reclaim assets from a user
    4. Student asset migration | EDU only
      1. Automatic student asset migration
      2. Migrate your assets
  9. Manage services
    1. Adobe Stock
      1. Adobe Stock credit packs for teams
      2. Adobe Stock for enterprise
      3. Use Adobe Stock for enterprise
      4. Adobe Stock License Approval
    2. Custom fonts
    3. Adobe Asset Link
      1. Overview
      2. Create user group
      3. Configure Adobe Experience Manager Assets
      4. Configure and install Adobe Asset Link
      5. Manage assets
      6. Adobe Asset Link for XD
    4. Adobe Acrobat Sign
      1. Set up Adobe Acrobat Sign for enterprise or teams
      2. Adobe Acrobat Sign - Team feature Administrator
      3. Manage Adobe Acrobat Sign on the Admin Console
    5. Creative Cloud for enterprise - free membership
      1. Overview
  10. Deploy apps and updates
    1. Overview
      1. Deploy and deliver apps and updates
      2. Plan to deploy
      3. Prepare to deploy
    2. Create packages
      1. Package apps via the Admin Console
      2. Create Named User Licensing Packages
      3. Manage pre-generated packages
        1. Manage Adobe templates
        2. Manage Single-app packages
      4. Manage packages
      5. Manage device licenses
      6. Serial number licensing
    3. Customize packages
      1. Customize the Creative Cloud desktop app
      2. Include extensions in your package
    4. Deploy Packages 
      1. Deploy packages
      2. Deploy Adobe packages using Microsoft Intune
      3. Deploy Adobe packages with SCCM
      4. Deploy Adobe packages with ARD
      5. Install products in the Exceptions folder
      6. Uninstall Creative Cloud products
      7. Use Adobe provisioning toolkit enterprise edition
    5. Manage updates
      1. Change management for Adobe enterprise and teams customers
      2. Deploy updates
    6. Adobe Update Server Setup Tool (AUSST)
      1. AUSST Overview
      2. Set up the internal update server
      3. Maintain the internal update server
      4. Common use cases of AUSST   
      5. Troubleshoot the internal update server
    7. Adobe Remote Update Manager (RUM)
      1. Release notes
      2. Use Adobe Remote Update Manager
    8. Troubleshoot
      1. Troubleshoot Creative Cloud apps installation and uninstallation errors
      2. Query client machines to check if a package is deployed
  11. Manage your Teams account
    1. Overview
    2. Update payment details
    3. Manage invoices
    4. Change contract owner
    5. Change your plan
    6. Change reseller
    7. Cancel your plan
    8. Purchase Request compliance
  12. Renewals
    1. Teams membership: Renewals
    2. Enterprise in VIP: Renewals and compliance
  13. Manage contracts
    1. Automated expiration stages for ETLA contracts
    2. Switching contract types within an existing Adobe Admin Console
    3. Value Incentive Plan (VIP) in China
    4. VIP Select help
  14. Reports & logs
    1. Audit Log
    2. Assignment reports
    3. Content Logs
  15. Get help
    1. Contact Adobe Customer Care
    2. Support options for teams accounts
    3. Support options for enterprise accounts
    4. Support options for Experience Cloud

Applies to enterprise.

Learn how global administrators can streamline organization and product management with export and import features in the Global Admin Console.

Access the Organizations tab in the Global Admin Console to export or import the organization structure, and go to the Product Allocation tab for allocation data. Use the More Options   icon to select export or import.

Sign in to the Global Admin Console

Export the organization structure

As a global administrator, you can export the organization hierarchy. You can download a JSON, CSV, or XLSX representation of the entire organization hierarchy, or a subset of it. You can then use this data to analyze or make modifications.

The export format chosen impacts the structure of the exported data.

  • CSV format allows exporting only one kind of data at a time. When exporting product profiles in CSV format, the profiles and resources are combined into one table. There are multiple entries for the product profile, one for each resource.
  • XLSX format results in each organization detail displaying in a separate sheet.
    Records are connected between the different object types by a reference id. In some cases, there may be multiple rows for a particular object, such as in the case of Resource objects when there are a set of values associated with a given resource.
  • JSON format is the most flexible. It can take advantage of structural relationships between exported objects. For example, products in an organization appear directly in the organization element. The same fields are exported in all three formats but some values are redundant in the JSON format.

  1. Sign in to the Global Admin Console. In the Organizations tab, use the organization picker to select the organization hierarchy where you want to perform the export. Data for all organizations in the hierarchy is exported.

  2. Select the More Options   icon and choose Export.

    Add organization

  3. In the Export dialog box, select what to export and a format to export the data in.

    Export org data

  4. Select Export. The export file can take several minutes to generate. Once complete, to download the report, navigate to the Global Admin Console > Insights > Export Reports. Learn more about the Export Reports feature.

    Note:

    The JSON files are exported in a zip format. You can open them using a zip utility or the operating system's zip features.

    After downloading the file, you can manipulate the data, and then import it back. The updates imported appear in the Global Admin Console as though you have manually edited the data.

Import the organization structure

As a global administrator, you can import potentially modified data. When uploaded, the new data is compared with current data and any changes are applied to the organization hierarchy. All import operations are performed on the updated copy of the organization hierarchy. If you have any pending changes, the import changes will be added on top of the pending changes in the hierarchy.

  1. Sign in to the Global Admin Console. In the Organizations tab, use the organization picker to select the organization hierarchy where you want to perform the import.

  2. Select the More Options  icon and select Import. Depending on the size and complexity of the import file, processing can take from a few seconds to several minutes.

  3. Select Select a file, and choose a JSON, CSV, or XLSX file to be uploaded. For CSV, only one organization detail can be imported at a time and it does not support importing Products.

    The imported changes appear as though you have manually edited the data.

  4. Select Close.

  5. Select Review Pending Changes. Then, select Submit Changes to execute them.

    Before executing the changes, the pending actions are displayed in the same manner as when edits are made manually in the Global Admin Console.

Export and import schemas

While importing data using a CSV file, the fields can appear in any order but must always match their header row. 

While importing data, you must specify an operation for each element. The operation can be any one of the following:

  • Update: indicates an edit.
  • Create: indicates to creating a new object (For example, organization, user group, or administrator).
  • Delete: indicates deletion of an object (For example, organization, user group, or administrator).

Input records with no or blank operation field are ignored.

Field Name Description Notes
id

Organization Id.

When adding a new organization this can be empty or set to a placeholder identifier, for example, new_org_1. The placeholder identifier is used in cases where other imported entries need to refer to this organization. After creation, an actual organization id will be assigned and replace all uses of the placeholder organization id.

 Can be set to a temporary value when operation=create
name Organization simple name. Min length 4, max 100. Names can contain UTF-8 characters up to 3-bytes, 4-byte characters are not supported.
 Can be set or updated when operation=create or operation=update, respectively
countryCode Country or region code Must be set when operation=create, can be updated when operation=Update
type Type of organization Read only
parentOrgId

Parent organization id. Blank for root organization.

When updating, significant restrictions apply including that new parent be in same hierarchy and have the products that are present in the organization.

 Can be set or updated when operation=create or operation=update, respectively
adminCount Number of administrators Read only
domainCount Number of domains Read only
userCount Number of users Read only
userGroupCount Number of user groups Read only
admins Set of admin objects representing administrators for this organization
 May be missing if not selected for export. It displays in a separate tab in XLSX files.
domains Set of domain objects representing domains in this organization
products Set of product objects representing products in this organization
productProfiles Set of product profile objects representing product profiles in this organization
userGroups Set of user group objects representing user groups in this organization
orgPolicies Structure representing policies and their values
operation One of blank, Create, Update or Delete. Action to take when data is imported. Always blank on export.

 

Import requirements:

  • For update or delete, orgId must refer to an existing organization in your hierarchy.
  • If you are creating a new organization, you can leave the orgId field blank or set it to a unique id that you can make up, such as new-1, or new-2. This provides an id that can be used to refer to the to-be-created organization.
  • Country code should be valid.
  • orgId for Update and Delete operation should already be present in the organization hierarchy.
  • orgId marked as Delete should not be selected as a parentOrgId for organizations with Update or Create operation.
  • Child organizations at same level and of the same parent should not have same orgNames.
  • For creating an organization or updating an organization name, the organization's name must not match the name of an existing child of the same parent.
Field Name Description Use
orgId Reference to organization in which the admin resides. Used as a reference to find containing or associated objects.
firstName

Admin user first name.

First and Last name for Adobe ID users can be replaced with a user-supplied value when the user accepts the invitation.

 Can be set or updated when operation=create or operation=update, respectively 
lastName Admin user last name
email Admin user email address. This is a primary key for the user and must be unique.
countryCode Country or region code where user operates. Only applies to Federated and Enterprise Id types.
userType One of "Adobe ID", "Enterprise ID", or "Federated ID". Read only
adminType One of "GLOBAL ADMIN", "GLOBAL VIEWER", "SYSTEM ADMIN", "USER GROUP ADMIN", "PRODUCT ADMIN", "PRODUCT PROFILE ADMIN", "DEPLOYMENT ADMIN", and "STORAGE_ADMIN". Can be set when operation=Create
groupId Group id of group this user is an admin of. Relevant for user group and product profile admins only.
licenseId Product license id of the product this user is admin of. Relevant for product admins only.
domain Domain name of user if not using email domain
userName User name of user if not using email address
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Import requirements:

  • orgId, email, adminType and userType must contain valid values.
  • countryCode must be valid.
  • If the user already exists and is being updated, the userType must match the user.
  • Check for duplicate email addresses in the organization.

Exports and imports of product profiles consist of two parts: the product profile details, and a set of resources associated with the product profile. These resources identify services which can be configured, usually just to enable or disable them.

  • The resource objects are nested within the product profile in JSON format.
  • When using CSV or XLSX with product profiles, the profiles and resources are combined into one table. There will be multiple entries for the product profile, one for each resource.
  • The "selected" field in the resource controls whether the service is enabled.
  • When importing product profiles, there must be a Create or Update operation on the product profile itself and on any resource objects that are to be updated or created.
Field Name Description Use
productProfileId

Identifier of product profile

Placeholder value can be used on create so that other objects can reference the new profile.

 Can be set to temporary value when operation=create
productProfileName Name of product profile. It cannot be a duplicate of other product profiles or user groups in the same organization.
 Can be set or updated when operation=create or operation=update, respectively
productProfileDescription Text description of the product profile
licenseId License Id reference to the product Used as a reference to find containing or associated object
orgId Organization that contains the user group
notifications True or false to indicate if email notification should be sent to users when they are added or removed from this product profile Can be set or updated when operation=create or operation=update, respectively
resources

Array of resources associated with this product profile.

The resources field is only present for JSON format. For CSV and XLSX format, resources are represented with the following additional fields: resourceName, resourceId, resourceDescription, icon, selected, quota, resourceType. For details on these fields, see Products and Resources.

If the product profile has more than one resource, there will be multiple rows present, one for each resource. The other fields will have the same values for each resource.

  
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Import requirements:

  • productProfileId, licenseId and orgId must have valid values.
  • When creating a product profile, the productProfileName must be a valid name and must not duplicate another product profile name or user group name in the same organization.
  • The quota field must have a valid value for the unit type. This is numeric or "unlimited" when resourceType=QUOTA or blank otherwise.
  • The notification field must be true or false.
  • For CSV and XLSX imports, validate productProfileId, all its entries must have the same orgId, licenseId, and productProfileName.
  • Validate duplicate productProfileName in the input file and the organization.
  • Profiles to be updated and deleted must be present in the organization.
  • Resources to be updated and deleted (deactivated) must be present in the profile.
  • For profiles to be created, ensure the following:
    • The orgId should be a new organization or an existing organization.
    • The licenseId should be a new product or an existing product.
    • Validate the resources for the profile.

Resources in product profiles:

Field Name Description Use
resourceName Name of the resource Read only
resourceId Identifier of the resource Read only
resourceDescription Text description of the resource Read only
icon URL to image for resource Read only
selected For a configuration entry, whether the feature is enabled. This field is present in JSON only.

Can be set or updated when operation=create or operation=update, respectively
quota Quantity of primary resource that can be given out to users via this product profile. This field is present in JSON only.
resourceType If present, value is SERVICE. It indicates this resource represents a service that can be enabled or disabled based on the value of the selected field. This field is present in JSON only.
 Read only
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Import requirements:

Operation field on resources is ignored when the product profile to which they belong have operations set as Delete or Create.

  • No resource should be marked for deletion, it is an invalid operation.
  • For product profiles to be created, the number of resources should match the source product profile's number of resources.
  • For resources with Update operation, the resource must be present in the product profile.
Field Name Description Use
userGroupId

Identifier of user group

Placeholder value can be used on create so that other objects can reference the new user group.

 Can be set to temporary value when operation=create
userGroupName Name of user group Can be set or updated when operation=create or operation=update, respectively
userGroupDescription Text description of user group
userCount Number of users in user group Read only
profiles

Array of product profile ids that the user group is associated with.

XLSX has one row per value with same values for other fields.

 Can be set or updated when operation=create or operation=update, respectively
orgId Organization that contains the user group Used as a reference to find containing or associated object.
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Import requirements:

  • orgId must refer to an existing organization or an organization being created in the same import.
  • userGroupId must refer to an existing group for update or delete, and can be an id you define for new user groups.
  • For update or create, userGroupNameorganization must not be blank and must not duplicate another user group or product profile name in the same organization.
  • Ensure userGroupName is not duplicate in the input file and the organization.
  • userGroups to be updated or deleted must be present in the organization.
  • Profile to be removed from user group must be present in the user group. Update operations cannot be performed on the profile of a user group.
  • For user groups to be created, ensure the following:
    • The orgId should be a new organization or an existing organization.
    • The licenseId, if applicable, should be a new product or an existing product.
    • The productProfileId should be a new product profile or an existing product profile.

The domain information provides read-only information about domains available in each organization. This data is not editable.

Field Name

Description

Use

orgId

Reference to organization in which this domain is listed

Used as a reference to find containing or associated objects.

domainName

Name of the domain, for example, adobe.com.

Read only

directoryName

Name of the directory in which the domain is listed

Read only

directoryType

One of Federated ID or Enterprise ID.

Read only

domainStatus

One of "ACTIVE", "RESERVED", "UNCLAIMED", "CLAIMED", "VALIDATED", "WITHDRAWN", "ACTIVE", "EXPIRED".

Read only

In XLSX files, there are two sheets- one for products and one for the resources. In JSON, resource objects are nested in the product object.

Products:

Field Name Description Use
licenseId

id which identifies the product. Each product has a unique license id in the organization in which it is listed. 

The license id for the same product will be different in different organizations. When adding a new product this can be empty or use a placeholder identifier, for example, new_product_1. The placeholder identifier is used in cases where other imported entries need to refer to this product instance. After creation, an actual license id is assigned that replaces all uses of the placeholder license id.

 Can be set to temporary value when operation=create
productName Name of the product Read only
productDescription Text description of the product Read only
allowOverallocation

Boolean indicating whether overallocation of this product instance is allowed.

Overallocation refers to the ability to grant more quantity to a child organization than you have been granted.

 Can be set or updated when operation=create or operation=update, respectively
icon URL of product icon Read only
sourceLicenseId License id of product instance in organization from which this product was allocated. Value is null if this instance is not an allocated product, instead is a purchased product. Can be set when operation=Create
productId Identifier of product. Read only
orgId Identifier of organization containing this product instance Used as a reference to find containing or associated object.
redistributable Boolean indicating whether this product has resources that can be granted to child organizations. Read only
resources object containing a set of resource objects representing the resources and settings in this product  
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Import requirements:

  • For create, licenseId must be a unique id that you create. 
  • For update, licenseId must be the id of an existing product in the organization specified.
  • orgId must refer to an existing organization or one that is being created in the same import operation.
  • For create, sourceLicenseId must refer to an existing product or the id you defined for a product being created in the same import operation.
  • licenseId and sourceLicenseId should not be same for products with Create operation.
  • Validate organizations of products, the organization should be a new one or should already be present in the organization hierarchy.
  • For Update and Delete operation, product should already be present in the organization hierarchy.
  • licenseId marked as Delete should not be used as a sourceLicenseId of products with Create and Update operation.
  • For products with Create operation, validating that the sourceLicenseId should be present in the parent organization.

Resources for products:

Resource objects can appear in products and in product profiles.

Field Name Description Use
resourceName Name of the resource Read only
resourceId Identifier of the resource Read only
resourceDescription Text description of the resource Read only
icon URL to image for resource Read only
productName Name of product this resource is part of. Read only
licenseId License id (product instance) of the product this resource is part of. Used as a reference to find containing or associated object.
grantedQuantity Granted quantity of this resource: amount of resources this organization has available to use locally or allocate to child organizations. Can be set or updated when operation=create or operation=update, respectively
unit Name of the unit of grant quantity. Read only
currentQuantity Current usable quantity in this organization. This is the grantedQuantity less resources allocated to child organizations. This is the value that is displayed in the Admin Console for this product/resource. Read only
provisionedQuantity Quantity actually provisioned: can be less than grant or current, can be less than currentQuantity if some limitation is in place. Read only
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Import requirements:

Operation field on resources is ignored when the product to which they belong have operations set as Delete or Create.

  • No resource should be marked for deletion, it is an invalid operation.
  • For products to be created, the number of resources should match the source products number of resources.
  • For resources with Update operation, the resource must be present in the product.

Import and export product allocation data

As a Global Administrator, you can export the product allocation data as a JSON or CSV file. You can then manipulate this data and upload it back to import the changes. When the potentially modified data is uploaded, the new data is compared with current data and any changes are applied to the product allocation data. You can then review and submit the pending changes for them to take effect.

Export the product allocation model

To export the product allocation model, do the following:

  1. Sign in to the Global Admin Console and navigate to the Product Allocation tab.
  2. Select the More Options  icon and select Export CSV or Export JSON. Your file is downloaded. Learn more about the export formats.

Import the product allocation model

You can export data, modify it, and then import the modified file. To import the product allocation model, do the following:

  1. Sign in to the Global Admin Console and navigate to the Product Allocation tab.
  2. Select the More Options  icon and select Import.
  3. Select a JSON or CSV file to upload.
  4. Select Review Pending Changes. After reviewing, select Submit Changes to execute them.

Export and import formats for product allocation

The export and import formats are the same. While importing in CSV format, the fields can appear in any order but must always match their header row. While importing in JSON format, the fields can appear in any order.

You must specify the operation while importing product allocation data. The operation can be one of the following:

  • Update: indicates an edit (change to grantedQuantity, allowOverAllocation values).
  • Create: indicates to add a product resource to the specified organization.
  • Delete: indicates deletion of product.

If no operation is given, then no changes occur when data is imported for that row in CSV or object in JSON.

In the exported file, there is one row or record for each product resource. Some products have more than one resource.

If a product has more than one resource, Update operations can apply to independent resources, a Delete operation deletes the product including all resources from an organization, and a Create operation needs a record for each of the resources in the import file so that the proper quantity of each of them can be specified. The allowOverAllocation field is product wide and it does not matter which resource an update to this field is in.

Field Name Description Use
productName Name of the product. For example, All Apps. Read only
licenseId

Id of a product (unique to a product in an organization).

When adding a new product this can be empty or set to a placeholder identifier, for example, new_product_1.  The placeholder identifier is used in cases where other imported entries need to refer to this product. After creation, an actual license id will be assigned and replace all uses of the placeholder license id.

 Can be set when operation=Create
sourceLicenseId Id of parent product. It is empty or null if this represents a purchase instead of an allocation. Can be set when operation=Create
productId Id that identifies this product class. This id is shared amongst products of the same type and differs from the licenseId which identifies an instance of this product. Read only
resourceName Name of this product resource. For example, User Licenses. Read only
resourceId Id that identifies this product resource. Can be set when operation=Create
orgPathName Pathname of the organization this product resource is in. Segments separated by "/". Read only
orgName Simple name of the organization containing this product resource. This is the final segment of the orgPathName. Read only
orgId Organization Id of the organization containing this product resource. Can be set when operation=Create
grantedQuantity

Number of units of resource quantity granted to this organization by its parent or the amount purchased if this product resource entry represents a purchase.

This field is updatable except for purchased products or root allocations that global administrator does not have permission to change.

Can be updated when operation=Update

or

operation=Create
unit Name of the resource unit. For example, Users. Read only
totalAllocations Sum of the grants to child organizations from this organization for this product resource. This value includes the direct grants to immediate children plus overallocations from those organizations. For example, if this organization granted a child 10 and the child then allocated its child 25, the totalAllocations would be 25: the 10 granted to the child plus an overage of 15 in that child. Read only
grantOverage Amount by which totalAllocations exceeds the grantedQuantity. If totalAllocations doesn't exceed grantedQuantity, this value is null or zero. Read only
localLicensedQuantity Amount of this resource granted to this organization left over for its use after the quantity allocated to children is deducted. This is the amount shown as available in the Admin Console. This value can be zero but is never negative even if this organization has overallocated resources to its children. Read only
localUsage Number of units of the resource used in this organization. For example, delegating a User License to a user would count as 1 unit of usage. Read only
totalUsage Number of units of the resource used by this organization and all children. This shows usage of this resource in the part of the organization hierarchy rooted by this organization. Read only
useOverage Amount of the total usage over the grant of the organization (organization and children have used more of the resource than available). This shows a nonzero value when totalUsage exceeds localLicensedQuantity, Read only
allowOverAllocation Indicates whether user is allowed to grant more resources to children even though there is no more to grant (allowed to grant despite grant overage) This value applies to all resources of this product. If an attempt is made to update allowOverallocation for more than one resource of the same product to different values, the result is random.  Can be updated when operation=Update
isPurchasedProduct true if the product is a purchase product (not allocated by parent). This is equivalent to sourceLicenseId having an empty value. Read only
redistributable true if the product can be allocated to children, false means that the product is only available in the organization in which it is shown and resources cannot be allocated to another organization. Read only
operation One of blank, Create, Update or Delete. Action to take when data is imported.  

Data validation

  • The operation field must have a valid operation.
  • The product import data must have properties and values for required fields.
  • The product import data properties must be of the correct type.
  • The product policy field (overAllocation) must not be provided for different resources.
  • The grantedQuantity field:
    • Can't be changed to unlimited if it is not already unlimited.
    • Must be a non-negative integer or the string value unlimited.

Permission/accessible validation

  • The organization associated with the import data must exist. If you are updating, ensure that the product and resource associated with the import data actually exist.

Add product validation

  • SourceLicenseId must exist.
  • Organization associated with the new product must exist.
  • The product being created must not exist (product with same licenseId).
  • The resources associated with a product being created must have a corresponding productId that matches that product.

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy