Skip to content

This page lists domain fields and values. For the concept, see Domains. For operations, see Manage domains.

Domain payload

{
  "payload": {
    "id": "1f1e3d9c-f2bf-4a92-a0fa-4a825e70ecb4",
    "alias": "Operations",
    "lock": "Unlocked",
    "governingStrategy": "ConsiderDescendants",
    "permissions": {
      "readAccess": {
        "domains": ["admin"],
        "users": ["admin"],
        "accounts": ["admin"],
        "transactions": ["admin"],
        "policies": ["admin"],
        "endpoints": ["admin"],
        "requests": ["admin"],
        "events": ["admin"]
      }
    },
    "description": "Operations domain",
    "customProperties": {},
    "users": [],
    "policies": [],
    "type": "v0_CreateDomain"
  }
}

Fields

FieldTypeRequiredDescription
idUUID stringYesUnique domain identifier.
aliasstringYesHuman-readable domain name.
lockenumYesUnlocked or Locked.
governingStrategyenumNoConsiderDescendants or CoerceDescendants.
permissionsobjectYesRead access by object type.
descriptionstringNoDomain description.
customPropertiesobjectYesString key-value metadata. Use {} when empty.
usersarrayNoUsers to create with the domain.
policiesarrayNoPolicies to create with the domain.
childrenDomainIdsarrayNoExisting child domain IDs to reparent under the new domain. Include only for domain injection.
typestringYesv0_CreateDomain.

Governing strategy values

ValueBehavior
ConsiderDescendantsParent and child policies can both be considered.
CoerceDescendantsMatching parent policies override child policies.

Read access fields

FieldControls visibility of
domainsDomain records and hierarchy.
usersUser records and roles.
accountsAccount records and balances.
transactionsTransaction records.
policiesPolicy definitions.
endpointsEndpoint records.
requestsIntents and requests.
eventsSystem events.

Lock values

ValueBehavior
UnlockedDomain can operate.
LockedDomain activity is disabled.

For policy fields embedded in a domain payload, see Policy reference.

Domain examples

Policies