Skip to main content

User

No description

type User {
  userId: BigInt!
  email: String
  gamertag: String
  disambiguation: String
  state: String
  isConfirmed: Boolean!
  createdAt: DateTime!
  grantEarlyAccess: Boolean!
  grantEarlyAccessOverride: Boolean!
  orgId: BigInt
  externalId: String
  userType: String!
  isSuperAdmin: Boolean!
  isOperator: Boolean!
  permissionsForOrg(
    orgId: BigInt!
  ): [String!]!
}

Fields​

User.userId ● BigInt! non-null scalar​

Unique user id (primary key). BigInt serialized as a string.

User.email ● String scalar​

Account email address. Null for soft-deleted / anonymized accounts.

User.gamertag ● String scalar​

Public display name. Null until set, or after account deletion.

User.disambiguation ● String scalar​

Discriminator paired with gamertag; the (gamertag, disambiguation) pair is unique.

User.state ● String scalar​

Opaque base64-encoded client state blob. Null when unset.

User.isConfirmed ● Boolean! non-null scalar​

True once the user has confirmed their email address.

User.createdAt ● DateTime! non-null scalar​

Account creation timestamp.

User.grantEarlyAccess ● Boolean! non-null scalar​

Base early-access entitlement flag for this account (before any admin override).

User.grantEarlyAccessOverride ● Boolean! non-null scalar​

Admin override that force-enables early access regardless of the base flag/window. Set via setEarlyAccessOverride (super-admin only).

User.orgId ● BigInt scalar​

Optional primary/home organization id (BigInt as string), if the account is tied to one. Full org membership is modeled via org_members; see myOrganizations.

User.externalId ● String scalar​

Optional external identity-provider id for federated / SSO accounts.

User.userType ● String! non-null scalar​

Account type discriminator (e.g. 'direct'); becomes 'deleted' after soft-delete. Mutable by super admins via updateUserType.

User.isSuperAdmin ● Boolean! non-null scalar​

Platform super-admin flag. When true the user bypasses all org permission checks platform-wide. Managed via setSuperAdmin (super-admin only).

User.isOperator ● Boolean! non-null scalar​

Company-employee flag that grants access to control-plane / operator features. Independent from is_super_admin.

User.permissionsForOrg ● [String!]! non-null scalar​

The current user's effective permission keys on the given org. Empty if not a member. Always full set if super admin.

User.permissionsForOrg.orgId ● BigInt! non-null scalar​

Organization id (BigInt as string) to evaluate the parent user's effective permissions against.

Returned By​

me query ● setEarlyAccessOverride mutation ● setOperator mutation ● setSuperAdmin mutation ● updateGamertag mutation ● updateUserType mutation ● user query

Member Of​

AppUserAccess object ● AuthResponse object ● UserEdge object ● UsersPage object