Skip to main content

CreateAuthenticationClaimsInput

Initial authorization claims and permissions for new user accounts.

Defines the user's starting permissions, roles, and organizational associations that will be embedded in their authentication tokens and used for access control.

input CreateAuthenticationClaimsInput {
  userId: Int!
  class: String!
  companyId: Int
  companyIds: [Int!]
  roles: [String!] = []
}

Fields​

CreateAuthenticationClaimsInput.userId ● Int! non-null scalar​

Unique identifier for the user within the system.

This ID will be used to associate the user with their data and permissions across all system operations.

CreateAuthenticationClaimsInput.class ● String! non-null scalar​

User classification type for permission and access control.

Determines the user's category within the system (e.g., 'contact', 'customer', 'admin') which affects their available permissions and accessible resources.

CreateAuthenticationClaimsInput.companyId ● Int scalar​

Primary company identifier for the user's organizational association.

Represents the user's main company affiliation and will be used as the default company context when no specific company is provided in operations.

CreateAuthenticationClaimsInput.companyIds ● [Int!] list scalar​

Complete list of company identifiers the user has access to.

Includes all companies the user is associated with, enabling multi-company access and operations across different organizational contexts.

CreateAuthenticationClaimsInput.roles ● [String!] list scalar​

Initial role assignments for the user account.

Defines the user's starting permissions and access levels within the system. Roles determine what operations the user can perform and what data they can access.

Member Of​

CreateAuthenticationInput input