GraphQL Overview

Whether this account is the current owner of the entitlement in the distribution chain

ID of the account. Example: "SampleOrg12345"

Name of the account

Type of the account. Valid types are PUBLISHER, CUSTOMER, CHANNEL_PARTNER, SELF_REGISTERED, UNKNOWN. Example: "CUSTOMER"

Email address of the Contact in the account. Example: "Joe@example.com"

Partner tier of the account owning the entitlement. Valid values are END_CUSTOMER and PARTNER_TIER_ONE. Example: "END_CUSTOMER"

Name of the custom attribute. Example: "REGION"

Value assigned to the custom attribute. Format and example depend on the type:

• Single Text: "EMEA"
• Multi-valued text: provide list of values between brackets [] delimited by , (e.g. ["Text1", "Text2"])
• Date: "YYYY/MM/DD" (e.g. "2025/12/31")
• Number: 12345

Attribute name. Example: "ca_text"

Attribute value (can be text/number/boolean/multiselect/date). Example: "testing"

Name of the custom attribute

Type of the custom attribute. It can be of LINE_ITEM or LICENSE_MODEL

Value assigned to the custom attribute. If the value is of type Date, then it should use yyyy/MM/dd format. Similarly, appropriate value corresponding to the type of custom attribute must be provided

Unique identifier of the account (short account name). Example: "12345"

Defines the account type. Valid values: CUSTOMER, PUBLISHER, CHANNEL_PARTNER. Default: CUSTOMER. (Using GraphQL, a new account cannot be created with an accountType of SELF_REGISTERED) Example: "CUSTOMER"

First line of account's address. Example: "123 Flexera St"

Second line of account's address. Example: "Suite 100"

List of custom attributes attached to this account. Note that mandatory custom attributes must be included in this list

City portion of account's address. Example: "Chicago"

Two-letter country code. Example: "US"

Description of the account. Example: "Flexera Software LLC - Main Office"

Display name of the account (full account name). Example: "Flexera Software LLC"

Region in which this account's address exists. Example: "North America"

State portion of account's address. Example: "IL"

Applicable to CUSTOMER and CHANNEL_PARTNER accounts, visible determines whether or not an account unrelated to this account can see the name of this account when it is in a channel partner tier of an entitlement, line item, or device. If visible is false, this account will appear as Name Withheld to unrelated accounts. Default: true. Example: true

Zip/Postal code of the account's address. Example: "60601"

List of accounts associated with the entitlement. If account is not provided, the entitlement will be associated with UNKNOWN_ORG_UNIT(default account)

Whether the customer can use the entitlement ID to log into the End-User Portal after the entitlement is deployed

List of entitlement custom attributes. Note that mandatory custom attributes must be included in this list

Flag to indicate if the entitlement should be auto-deployed

Whether the entitlement ID is to be auto-generated. Example: false

Description of the entitlement. Example: "Description for entitlement"

Name of the email template to be used for entitlement related emails. Example: "DEFAULT"

Entitlement ID of the entitlement. If you specify the entitlement ID, then it must be unique across all entitlements and line items. If you specify the entitlement ID here, then the autoGenerate flag must be set to false. Example: "ent-id-1234"

List of line items contained in the entitlement

Address of the ship-to contact. Example: "Building-Street-City"

Email address of the ship-to contact. Example: "Joe@example.com"

Auto Deploy flag to indicate whether the feature bundle should be deployed or not. If true, the feature bundle will be automatically deployed after creation.

Describe the characteristics of this feature bundle that make it unique. Example: "This feature bundle enables advanced reporting."

Name to uniquely identify the feature bundle. Must contain only ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyFeatureBundle"

Optional feature list for the feature bundle.

Select an Aggregation Type for the feature. Valid values: NONE, SUM, MAX. Example: "SUM"

Auto Deploy flag to indicate whether the feature should be deployed or not. If true, the feature will be automatically deployed after creation.

Describe the characteristics of this feature that make it unique. Maximum length: 2000 characters. Example: "This feature enables advanced reporting."

Name to uniquely identify the feature. Must contain only ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyFeature"

Optional override parameters for the feature.

Specify maxVersion of the feature. Format: yyyy.MMdd, yyyy.MM.dd, or yyyy.MM . Example: "2023.10.15"

If a FIXED version format is selected, specify version of the feature. Must not contain whitespace characters. Maximum length: 64 characters. Example: "1.0"

Select a FIXED or DATEBASED version format. Valid values: FIXED, DATEBASED. Example: "FIXED"

List of line item input objects

Allow renewals flag to indicate whether the maintenance product can be renewed. Example: true

Allow upgrades flag to indicate whether the maintenance product can be upgraded. Example: true

Allow upsells flag to indicate whether the maintenance product can be upsold. Example: true

Description of the maintenance product. Example: "This maintenance product is for advanced maintenance."

Name to uniquely identify the maintenance product. Can only contain ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyMaintenanceProduct"

Optional part number list for the maintenance product.

Maintenance product product line. Example: "Uncategorized Products"

Optional product list for the maintenance product.

Maintenance product version. Maximum length: 64 characters. Example: "1.0"