Skip to main content

AddRoleInput

Autogenerated input type of AddRole

input AddRoleInput {
  clientMutationId: String
  description: String
  domain: DomainEnum!
  name: String!
  partyTypes: [PartyTypeEnum!]!
  prettyName: String!
}

Fields​

AddRoleInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

AddRoleInput.description ● String scalar​

This argument is optional. It is used to describe the role type.

AddRoleInput.domain ● DomainEnum! non-null enum​

This argument is required. Indicates the domain of the role type. The domain is used to the system to know in which context the role type is applicable. For instance, a role type with domain set to "BRAND" is only applicable to brands and cannot be used in other contexts.

AddRoleInput.name ● String! non-null scalar​

This argument is required and it will be used to handle the role type in the system.The role type name must be unique on must not contain spaces or special characters.

AddRoleInput.partyTypes ● [PartyTypeEnum!]! non-null enum​

This argument is required. It is used to indicate the party types that can be assigned to the role type.

AddRoleInput.prettyName ● String! non-null scalar​

This argument is used to display the role type in a more user friendly way.

Member Of​

addRoleType mutation