Skip to main content


Input for the setRelationType mutation.

input SetRelationTypeInput {
name: String!
objectType: String!
displayName: String
ordinal: Int
status: [Flag!]
unions: [RelationTypeSelector!]
hash: Hash

Fields ● String! non-null scalar common

Name of the relation type.

SetRelationTypeInput.objectType ● String! non-null scalar common

The type of object that can be the object of the relation. If id is set the objectType is optional and if specified, must match the object type defined on the existing relation type.

SetRelationTypeInput.displayName ● String scalar common

Display name of the relation type.

SetRelationTypeInput.ordinal ● Int scalar common

Sort ordinal of the relation type.

SetRelationTypeInput.status ● [Flag!] list enum common

A set of flags that describe the status of the relation type.

SetRelationTypeInput.unions ● [RelationTypeSelector!] list input relation-types

A list of relation types that are supertypes of this relation type.

This relation type receives all permissions defined in the supertypes. Unioned relation types must be defined with the same object type.

SetRelationTypeInput.hash ● Hash scalar common

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

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

Member of

setRelationType mutation