Skip to main content

SetObjectTypeInput

Input for the setObjectType mutation. This input type is used to create or modify an object type.

All fields are required except for id. If an object type with the specified name already exists, it is updated. If no object type with the specified name exists, a new object type is created.

The only time id is required is to change the name of an existing object type. In that case, id is used to identify the object type and name is the new name.

input SetObjectTypeInput {
id: TypeID
name: String!
displayName: String
isSubject: Boolean
ordinal: Int
status: [Flag!]
hash: Hash
}

Fields

id (TypeID)

ID of an existing object type to update. If set, an object type with the specified ID must already exist.

name (String!)

Name of the object type. Must be unique among all object types in the directory.

displayName (String)

Friendly display name of the object type. This is how the object type appears in the Aserto console.

isSubject (Boolean)

Whether or not the object type represents a subject (user, group, etc.).

ordinal (Int)

Sort order of the object type. Lower ordinals appear first when enumerating object types.

status ([Flag!])

A set of modifier flags that can be applied to the object type. It should be left empty ([]) in most cases.

hash (Hash)

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

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