- FeatureBundleInput
Input for creating a product.
Allow obsolete fulfillment in end user portal. Example: true
Allow obsolete fulfillment in producer portal. Example: true
Auto deploy flag to indicate whether the product should be deployed automatically. If true, validations are performed and dependent features/bundles will be deployed. Example: true
Product description. Example: "This is a sample product description"
End date in YYYY-MM-DD format. Example: "2025-02-01"
List of feature bundles associated with product.
List of features associated with product.
List of host types. Example: ["Flexnet Server"]
License generator name. If not provided, it will be fetched based on licenseTechnology. Example: "TestGenerator"
List of license model names associated with product. Example: ["Embedded Counted"]
License technology name. If not provided, defaults to 'FlexNet Licensing'. Example: "Test"
List of part numbers associated with product (must be unique across products).
Product category name. If not provided, defaults to 'Uncategorized Products'. Example: "Uncategorized Products"
Product category custom attributes.
Product custom attributes.
Name of the product. Maximum length: 128 characters. Example: "Product A"
Upgrade email template associated with product. Use 'none' for no template or 'default' for the default template. Example: "default"
Start date in YYYY-MM-DD format. Example: "2024-01-01"
Trusted Key Configuration name. Example: "Trusted Key"
Used on device flag (only applies when license technology is FlexNet Licensing). Example: true
Version of the product. Maximum length: 64 characters. Example: "1.0.0"
Virtual Trusted Key Configuration name. Example: "Virtual Trusted Key"
{ "allowObsoleteFulfilmentInEP": true, "allowObsoleteFulfilmentInPP": true, "autoDeploy": true, "description": "Example String", "endDate": "Example String", "featureBundles": [ { "__typename": "FeatureBundleInput" } ], "features": [ { "__typename": "FeatureInput" } ], "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ "Example String" ], "licenseTechnology": "Example String", "partNumbers": [ { "__typename": "PartNumberRequestInput" } ], "productCategory": "Example String", "productCategoryAttributes": [ { "__typename": "AttributesInput" } ], "productCustomAttributes": [ { "__typename": "AttributesInput" } ], "productName": "Example String", "productUpgradeEmailTemplate": "Example String", "startDate": "Example String", "trustedKey": "Example String", "usedOnDevice": true, "version": "Example String", "virtualTrustedKey": "Example String" }
Input for creating a suite.
Allow download obsolete fulfillment record in Admin. Example: false
Allow download obsolete fulfillment record in Portal. Example: false
Auto deploy flag to indicate whether the suite should be deployed automatically. Example: true
List of custom attributes for the suite.
Description of the suite. Example: "Enterprise product suite"
List of supported host types. Example: ["Windows", "Linux"]
License generator used by the suite. Example: "GeneratorX"
List of license models for the suite. Example: ["Embedded Counted", "Subscription"]
License technology used by the suite. Example: "FlexNet"
Package properties for the suite.
List of part numbers with optional license model associations.
Product category name. If not provided, defaults to "Uncategorized Products". Example: "Enterprise Software"
List of product category attributes.
List of products included in this suite.
Name of the suite. Maximum length: 128 characters. Example: "Suite A"
Trusted key for the suite. Example: "TrustedKey123"
Indicates if the suite is used on a device. Example: true
Version of the suite. Example: "1.0"
Virtual trusted key for the suite. Example: "VirtualTrustedKey456"
{ "allowDownloadObsoleteFrInAdmin": true, "allowDownloadObsoleteFrInPortal": true, "autoDeploy": true, "customAttributes": [ { "__typename": "AttributesInput" } ], "description": "Example String", "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ "Example String" ], "licenseTechnology": "Example String", "packageProperties": { "__typename": "SuitePackageInput" }, "partNumbers": [ { "__typename": "PartNumberRequestInput" } ], "productCategory": "Example String", "productCategoryAttributes": [ { "__typename": "AttributesInput" } ], "products": [ { "__typename": "SuiteProductRequestInput" } ], "suiteName": "Example String", "trustedKey": "Example String", "usedOnDevice": true, "version": "Example String", "virtualTrustedKey": "Example String" }
Input for creating a user
List of account associated with user. Set user's account and list of the user's roles. User name and roles are required if the user can log in.
List of user custom attributes. Note that mandatory custom attributes must be included in this list
City portion of address. Example: "New York"
Two-letter country code. Example: "US"
Display name of the user. Example: "John Doe"
Email address of the user. Example: "johndoe@xyz.com"
User's fax number. Example: "01154785"
First Name of the user. Example: "John"
Last Name of the user. Example: "Doe"
User's locale. Example: "en_US"
Whether the User should opt to receive email notifications. Example: false
User's phone number. Example: "989915487"
Indicates whether created user can login to portal or not. If portalLogin is false, the user is treated as a contact. Example: true
Is this a shared login among several users? Example: false
State portion of address. Example: "The Empire State"
Flag to indicate if the user should be Active or Inactive. Status can be one of the following values: Active, Inactive. Example: "Active"
Street portion of address. Example: "High Street"
Provide time zone setting in the format: GMT#.#DST#. When a user is saved, this offset is converted to a time zone string and the time zone string is displayed when a user is retrieved. Example: "GMT-6.0DST0"
Important: The user name must match the email address for the user. If portalLogin is set to false, this field is ignored. If portalLogin is set to true, this field is required. Example: "johndoe@xyz.com"
Postal code of address. Example: "10118"
{ "accountRoles": [ { "__typename": "UserAccountRoleInput" } ], "attributes": [ { "__typename": "AttributeInput" } ], "city": "Example String", "country": "Example String", "displayName": "Example String", "emailAddress": "Example String", "faxNumber": "Example String", "firstName": "Example String", "lastName": "Example String", "locale": "Example String", "optIn": true, "phoneNumber": "Example String", "portalLogin": true, "shared": true, "state": "Example String", "status": "Example String", "street": "Example String", "timezone": "Example String", "userName": "Example String", "zipcode": "Example String" }
Duplication group details
Duplication group option to define override behavior. Valid values: NO_OVERRIDE, GROUPMASK, NONE.
Group mask details for the duplication group
{ "dupGroupOption": "Example String", "groupMask": { "__typename": "GroupMaskDataTypeInput" } }
Feature within a feature bundle
Name to uniquely identify the feature. Must contain only ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyFeature"
Quantity of the feature (minimum value is 1). Example: 1
Version of the feature (for FIXED version format). Maximum length: 64 characters. Example: "1.0"
{ "featureName": "Example String", "quantity": 40, "version": "Example String" }
Feature bundle information for product creation.
Count of features in the bundle (minimum value is 1). Example: 1
Name of the feature bundle. Example: "Test Bundle"
{ "count": 40, "name": "Example String" }
Feature information for product creation.
Feature count (minimum value is 1). Example: 1
Feature name. Example: "Edit Feature"
Feature version. Example: "1.0"
{ "count": 40, "name": "Example String", "version": "Example String" }
Override parameters for feature configuration
Indicates whether the feature is borrowable. Example: true.
Determines whether the feature is counted. Valid values: Yes, No, Do_Not_Override. Example: "Yes"
Duplication group details for the feature
Notice string to override the default value. Maximum length: 255 characters. Example: "This is a notice."
Determines whether the feature is reusable. Valid values: Yes, No, Do_Not_Override. Example: "No"
Serial number to override the default value. Maximum length: 255 characters. Example: "SN123456"
Vendor string to override the default value. Maximum length: 255 characters. Example: "Vendor123"
{ "borrowable": true, "counted": "Example String", "dupGroup": { "__typename": "DupGroupInput" }, "notice": "Example String", "reusable": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }
Group mask data type for specifying uniqueness criteria
Set of group mask types defining the uniqueness criteria. Valid values: USER, HOST, DISPLAY, VENDOR . Example: ["USER", "HOST"]
{ "option": [ "Example String" ] }
Represents a License Model
specify who is issuing the license. Example: "SampleLicenseIssuer"
specify a name that uniquely identifies this license model. Example: "LicenseModelName"
This field is usually set at entitlement time and includes customer name and purchase order. Example: "Premium Feature A"
specify the serial number of the license. Example: "SampleSerialno"
Unique value assigned by each publisher to each license. Example: "uniqueVendorString"
{ "issuer": "Example String", "licenseModelName": "Example String", "notice": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }
Represents a line item in the entitlement
Whether this line item is activatable
Activation ID of the line item. If you specify the activation ID, then it must be unique across all entitlements and line items. If you specify the activation ID here, then the autoGenerate flag must be set to false. Example: "act-id-1234"
List of custom attributes related to the line item
Whether the Line item should be auto-deployed
Whether the activation ID should be auto-generated. Example: false
End date of the line item in YYYY-MM-DD format. Example: "2025-01-01"
Type of order for the line item. The default is NEW_ORDER. Example: "NEW_ORDER" Default: NEW_ORDER
PartNumber
Whether this line item is permanent. A permanent line item has no expiration date
List of products entitled by this line item
Number of copies for the entitlement. Example: 1
Quantity per copy. Minimum value is 1. Default: 1
Start date of the line item in YYYY-MM-DD format. Example: "2025-01-01"
{ "activatable": true, "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "orderType": "Example String", "partNumber": "Example String", "permanent": true, "product": [ { "__typename": "ProductInput" } ], "quantity": 40, "quantityPerCopy": 40, "startDate": "Example String" }