Skip to main content

Object

Objects are the primary nodes in the directory graph.

They be associated with each other using Relations.

type Object {
type: ObjectType!
key: String!
displayName: String!
properties: Map!
hash: Hash!
lifecycle: Lifecycle!
relations(
side: RelationSide!
options: RelationOptions
first: Int!
after: Cursor
): RelationConnection!
}

Fields

Object.type ● ObjectType! non-null object object-types

The type of the object.

Object.key ● String! non-null scalar common

User-defined identifier for the object. Unique within an object type.

Object.displayName ● String! non-null scalar common

Optional display name for the object.

Object.properties ● Map! non-null scalar common

A JSON collection of arbitrary properties associated with the object.

Object.hash ● Hash! non-null scalar common

A hash value of object's fields.

Object.lifecycle ● Lifecycle! non-null object common

Metadata about the object's life cycle.

Object.relations ● RelationConnection! non-null object relations

The relations this object has.

side: The object's side in the relation. "OBJECT" returns relations in which the object is the object, and "SUBJECT" returns relations in which the object is the subject.

Object.relations.side ● RelationSide! non-null enum objects
Object.relations.options ● RelationOptions input objects
Object.relations.first ● Int! non-null scalar common
Object.relations.after ● Cursor scalar common

Returned by

object query

Member of

ObjectConnection object ● Relation object ● SetObjectResult object