Skip to main content

Customer Object

Represents a customer, which is an object that allows for logical separation of Users, Instances, and other data that are specific to a particular deployment of the Organization's product(s).

Return fields#

id (ID!)#

The ID of the object.

avatarUrl (String)#

The URL for the avatar image.

labels ([String!])#

The labels that are associated with the object.

name (String!)#

The name of the Customer, which must be unique within the scope of its Organization.

org (Organization!)#

The Organization to which the Customer belongs.

description (String!)#

Additional notes about the Customer.

credentials (CredentialConnection!)#

The Customer the Credential belongs to, if any. If NULL then Organization will be specified.

instances (InstanceConnection!)#

The Customer for which the Instance is deployed.

users (UserConnection!)#

The Customer the user belongs to, if any. If this is NULL then Organization will be specified.

attachments ([Attachment])#

A JSON list of objects where each object has a key for name and URL that together describe the Attachment.

allowAddUser (Boolean!)#

Specifies whether the signed-in User can add a User to the Customer.

allowAddInstance (Boolean!)#

Specifies whether the signed-in User can add an Instance to the Customer.

allowAddAlertMonitor (Boolean!)#

Specifies whether the signed-in User can add an Alert Monitor to the Customer.

allowAddCredential (Boolean!)#

Specifies whether the signed-in User can add a Credential to the Customer.

allowEnableInstance (Boolean!)#

Specifies whether Instances may be enabled based on the utilization allowed by the current Plan.

allowExecuteInstance (Boolean!)#

Specifies whether Instances may be executed based on the utilization allowed by the current Plan.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the Customer.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the Customer.

starred (Boolean)#

Indicates whether the record is starred by the signed-in User.