Skip to main content

UserClaims

User authorization claims and permissions data.

Contains comprehensive user identity, permissions, and access control information used for authorization decisions across the system.

type UserClaims {
  userId: Int!
  userDirectoryId: Int!
  adminUserId: Int!
  contactId: Int
  customerId: Int
  companyId: Int
  companyIds: [Int!]
  roles: [String!]!
  discounts: [String!]!
  acllist: [Int!]!
  class: String!
  loginRoot: Int
  dateCreated: DateTime!
}

Fields​

UserClaims.userId ● Int! non-null scalar​

Unique identifier for the user within the system.

Primary user ID used to associate the user with their data and track their activities across all system operations.

UserClaims.userDirectoryId ● Int! non-null scalar​

Directory identifier for the user's organizational context.

Links the user to their organizational directory, determining their access to directory-specific resources and permissions.

UserClaims.adminUserId ● Int! non-null scalar​

Administrative user identifier for elevated permissions.

When present, indicates the user has administrative privileges and links to their admin user profile.

UserClaims.contactId ● Int scalar​

Contact identifier when the user represents a contact entity.

Links the user to a specific contact record, enabling contact-specific operations and data access.

UserClaims.customerId ● Int scalar​

Customer identifier when the user represents a customer entity.

Links the user to a specific customer record, enabling customer-specific operations and data access.

UserClaims.companyId ● Int scalar​

Primary company identifier for the user's main organizational affiliation.

Represents the user's default company context used when no specific company is provided in operations.

UserClaims.companyIds ● [Int!] list scalar​

Complete list of company identifiers the user has access to.

Enables multi-company operations and determines which company data the user can access and modify.

UserClaims.roles ● [String!]! non-null scalar​

User's assigned roles for permission-based access control.

Determines what operations the user can perform and what resources they can access within the system.

UserClaims.discounts ● [String!]! non-null scalar​

Available discount codes and pricing rules for the user.

Contains discount identifiers that can be applied to transactions and pricing calculations for this user.

UserClaims.acllist ● [Int!]! non-null scalar​

Access control list defining specific resource permissions.

Contains identifiers for resources and operations the user has explicit access to, providing fine-grained permission control.

UserClaims.class ● String! non-null scalar​

User classification type for permission and access control.

Determines the user's category within the system which affects their available permissions and accessible resources.

UserClaims.loginRoot ● Int scalar​

Root login identifier for hierarchical user relationships.

Links to a parent or root user account, used for managing user hierarchies and delegated access permissions.

UserClaims.dateCreated ● DateTime! non-null scalar​

Timestamp when the user claims were created.

Indicates when these authorization claims were first established, used for auditing and claim lifecycle management.