Skip to main content

SetObjectInput

Input for the setObject mutation.

input SetObjectInput {
  type: String!
  key: String!
  displayName: String!
  properties: Map!
  hash: Hash
}

Fields​

SetObjectInput.type ● String! non-null scalar common​

The type of object to create or update. If id is set, type must match the type of the existing object.

SetObjectInput.key ● String! non-null scalar common​

The key of the object to create or update. If id is set, key is optional and, if specified, replaces the object' existing key.

SetObjectInput.displayName ● String! non-null scalar common​

Optional display name for a new object or new name for an existing object.

SetObjectInput.properties ● Map! non-null scalar common​

Optional set of JSON properties to be set on the object. If the object already exists, its properties are replaced by the specified values.

SetObjectInput.hash ● Hash scalar common​

Optional value of the hash value previously read from the directory.

If a hash value is specified and the object being mutated already exists, the update will be rejected unless the hash value matches the existing object's hash value. This can be used to ensure that the object being mutated has not been modified since it was read from the directory.

Member of​

setObject mutation