Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview

CreateUserInput

Input for creating a user

accountRoles

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
String

City portion of address. Example: "New York"

country
String

Two-letter country code. Example: "US"

displayName
String

Display name of the user. Example: "John Doe"

emailAddress
String!,non-null

Email address of the user. Example: "johndoe@xyz.com"

faxNumber
String

User's fax number. Example: "01154785"

firstName
String!,non-null

First Name of the user. Example: "John"

lastName
String!,non-null

Last Name of the user. Example: "Doe"

locale
String

User's locale. Example: "en_US"

optIn
Boolean

Whether the User should opt to receive email notifications. Example: false

phoneNumber
String

User's phone number. Example: "989915487"

portalLogin
Boolean

Indicates whether created user can login to portal or not. If portalLogin is false, the user is treated as a contact. Example: true

shared
Boolean

Is this a shared login among several users? Example: false

state
String

State portion of address. Example: "The Empire State"

status
String

Flag to indicate if the user should be Active or Inactive. Status can be one of the following values: Active, Inactive. Example: "Active"

street
String

Street portion of address. Example: "High Street"

timezone
String

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"

userName
String

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"

zipcode
String

Postal code of address. Example: "10118"

Sample
{ "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" }

DupGroupInput

Duplication group details

dupGroupOption
String

Duplication group option to define override behavior. Valid values: NO_OVERRIDE, GROUPMASK, NONE.

Group mask details for the duplication group

Sample
{ "dupGroupOption": "Example String", "groupMask": { "__typename": "GroupMaskDataTypeInput" } }

FeatureBundleFeatureInput

Feature within a feature bundle

featureName
String!,non-null

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

quantity
Int

Quantity of the feature (minimum value is 1). Example: 1

version
String

Version of the feature (for FIXED version format). Maximum length: 64 characters. Example: "1.0"

Sample
{ "featureName": "Example String", "quantity": 40, "version": "Example String" }

FeatureBundleInput

Feature bundle information for product creation.

count
Int

Count of features in the bundle (minimum value is 1). Example: 1

name
String

Name of the feature bundle. Example: "Test Bundle"

Sample
{ "count": 40, "name": "Example String" }

FeatureInput

Feature information for product creation.

count
Int

Feature count (minimum value is 1). Example: 1

name
String

Feature name. Example: "Edit Feature"

version
String

Feature version. Example: "1.0"

Sample
{ "count": 40, "name": "Example String", "version": "Example String" }

FeatureOverrideParamsInput

Override parameters for feature configuration

borrowable
Boolean

Indicates whether the feature is borrowable. Example: true.

counted
String

Determines whether the feature is counted. Valid values: Yes, No, Do_Not_Override. Example: "Yes"

Duplication group details for the feature

notice
String

Notice string to override the default value. Maximum length: 255 characters. Example: "This is a notice."

reusable
String

Determines whether the feature is reusable. Valid values: Yes, No, Do_Not_Override. Example: "No"

serialNumber
String

Serial number to override the default value. Maximum length: 255 characters. Example: "SN123456"

vendorString
String

Vendor string to override the default value. Maximum length: 255 characters. Example: "Vendor123"

Sample
{ "borrowable": true, "counted": "Example String", "dupGroup": { "__typename": "DupGroupInput" }, "notice": "Example String", "reusable": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }

GroupMaskDataTypeInput

Group mask data type for specifying uniqueness criteria

option
[String!],non-null

Set of group mask types defining the uniqueness criteria. Valid values: USER, HOST, DISPLAY, VENDOR . Example: ["USER", "HOST"]

Sample
{ "option": [ "Example String" ] }

LicenseModelInput

Represents a License Model

issuer
String

specify who is issuing the license. Example: "SampleLicenseIssuer"

licenseModelName
String!,non-null

specify a name that uniquely identifies this license model. Example: "LicenseModelName"

notice
String

This field is usually set at entitlement time and includes customer name and purchase order. Example: "Premium Feature A"

serialNumber
String

specify the serial number of the license. Example: "SampleSerialno"

vendorString
String

Unique value assigned by each publisher to each license. Example: "uniqueVendorString"

Sample
{ "issuer": "Example String", "licenseModelName": "Example String", "notice": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }

LineItemInput

Represents a line item in the entitlement

activatable
Boolean

Whether this line item is activatable

activationId
String

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

autoDeploy
Boolean

Whether the Line item should be auto-deployed

autoGenerate
Boolean

Whether the activation ID should be auto-generated. Example: false

expiryDate
String

End date of the line item in YYYY-MM-DD format. Example: "2025-01-01"

orderType
String
Default:"NEW_ORDER"

Type of order for the line item. The default is NEW_ORDER. Example: "NEW_ORDER" Default: NEW_ORDER

partNumber
String

PartNumber

permanent
Boolean

Whether this line item is permanent. A permanent line item has no expiration date

List of products entitled by this line item

quantity
Int

Number of copies for the entitlement. Example: 1

quantityPerCopy
Int

Quantity per copy. Minimum value is 1. Default: 1

startDate
String!,non-null

Start date of the line item in YYYY-MM-DD format. Example: "2025-01-01"

Sample
{ "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" }

LineItemPropertyInput

Represents the properties of a line item that can be updated

activationId
String!,non-null

Activation ID of the line item for which attributes has to be updated

List of custom attributes related to the line item and license model

deploy
Boolean

Whether this line item is to be deployed

orderType
String

Order type can have values like 'New_Order', 'Renewal_Order', 'Upgrade_Order' and Upsell_Order. This is used to identify the type of order for the line item

parentActivationId
String

Activation ID which will be updated as a parent line item if order type relation exists between line items. If order type is 'New' then this field will be ignored

Product related to the line item

Sample
{ "activationId": "Example String", "attributes": [ { "__typename": "AttributeUpdateInput" } ], "deploy": true, "orderType": "Example String", "parentActivationId": "Example String", "product": { "__typename": "UpdateProductInput" } }

LinkLineItemInput

Input for line item to be linked

activationId
String!,non-null

Activation ID of the line item

Sample
{ "activationId": "Example String" }

Scalars

Overview