Skip to main content

LicenseInput

The parameters that can be used to create a license.

input LicenseInput {
target: ID
namespaceId: ID!
restrictionType: RestrictionType
terms: LicenseTermsInput
protection: ProtectionInfoInput
source: String!
checkoutsLeft: Int
customAttributes: [AttributeInput!]
}

Fields

LicenseInput.target ● ID scalar

The target (e.g. ISBN) for which to create a licence.

LicenseInput.namespaceId ● ID! non-null scalar

The namespace in which to create the license. Should be a UUID.

LicenseInput.restrictionType ● RestrictionType enum

The type of the restrictions defined by the license. Defaults to LIMITED.

LicenseInput.terms ● LicenseTermsInput input

The terms for the activation of the license and the limits for each individual loan.

LicenseInput.protection ● ProtectionInfoInput input

The specific conditions for consumption as requested by the content owner.

LicenseInput.source ● String! non-null scalar

An annotation for the origin of the license.

LicenseInput.checkoutsLeft ● Int scalar

For a partially-consumed license, the number of checkouts left.

LicenseInput.customAttributes ● [AttributeInput!] list input

A list of key-value attributes to set with the license.

Member of

createLicense mutation