Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview

AccountInput

Represents an Account

CurrentOwner
Boolean

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

accountId
String!,non-null

ID of the account. Example: "SampleOrg12345"

accountName
String

Name of the account

accountType
String!,non-null

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

contactEmail
String

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

partnerTierName
String!,non-null

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

Sample
{ "CurrentOwner": true, "accountId": "Example String", "accountName": "Example String", "accountType": "Example String", "contactEmail": "Example String", "partnerTierName": "Example String" }

AttributeInput

Represents a custom attributes. Mandatory custom attributes must be provided for the request to be successful

name
String!,non-null

Name of the custom attribute. Example: "REGION"

value
JSON!,non-null

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
Sample
{ "name": "Example String", "value": "Example Custom Scalar" }

AttributesInput

Attributes input for custom attributes.

name
String

Attribute name. Example: "ca_text"

value

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

Sample
{ "name": "Example String", "value": "Example Custom Scalar" }

AttributeUpdateInput

Represents an update to a custom attribute

name
String!,non-null

Name of the custom attribute

type
String!,non-null

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

value
String!,non-null

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

Sample
{ "name": "Example String", "type": "Example String", "value": "Example String" }

CreateAccountInput

Input for creating an account

accountId
String!,non-null

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

accountType
String!,non-null

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"

address1
String

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

address2
String

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
String

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

country
String

Two-letter country code. Example: "US"

description
String

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

name
String!,non-null

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

region
String

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

state
String

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

visible
Boolean
Default:true

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

zipcode
String

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

Sample
{ "accountId": "Example String", "accountType": "Example String", "address1": "Example String", "address2": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "city": "Example String", "country": "Example String", "description": "Example String", "name": "Example String", "region": "Example String", "state": "Example String", "visible": true, "zipcode": "Example String" }

Scalars

Overview