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
  externalId: String
  userType: String
  isSuperAdmin: Boolean
  isOperator: Boolean
  hasPassword: Boolean
  orgId: BigInt
  permissionsForOrg(
    orgId: BigInt!
  ): [String!]
  ageBracket: String
  country: String
}

Fields​

User.userId ● BigInt! non-null scalar​

Unique user id and primary key. BigInt serialized as a decimal string.

User.email ● String scalar​

Account email. Private: null unless the caller is this user, a super-admin or an operator (and for anonymized/soft-deleted accounts).

User.gamertag ● String scalar​

Public display name; null if unset or anonymized. Unique in combination with disambiguation.

User.disambiguation ● String scalar​

Discriminator paired with gamertag to form a unique handle; null if unset.

User.state ● String scalar​

User-level state blob, base64-encoded binary (management-owned). Private: null unless the caller is this user, a super-admin or an operator; also null when cleared.

User.isConfirmed ● Boolean scalar​

Whether the account email has been confirmed. Private: null unless the caller is this user, a super-admin or an operator.

User.createdAt ● DateTime! non-null scalar​

Account creation timestamp (ISO-8601).

User.grantEarlyAccess ● Boolean scalar​

Whether the user qualifies for early access through normal eligibility (the free-play window/rollout). Private: null unless the caller is this user, a super-admin or an operator.

User.grantEarlyAccessOverride ● Boolean scalar​

Admin override forcing early access on/off regardless of normal eligibility (set via setEarlyAccessOverride). Private: null unless the caller is this user, a super-admin or an operator.

User.externalId ● String scalar​

The id an organization knows an org-managed player by (its own account id), or null for every other account. Private: null unless the caller is this user, a super-admin or an operator.

User.userType ● String scalar​

Account type: "direct" (a Crowded Kingdoms account), "org_managed" (a player an organization signs in itself; no email, password or wallet) or "deleted". Private: null unless the caller is this user, a super-admin or an operator.

User.isSuperAdmin ● Boolean scalar​

Whether the user holds platform super-admin privileges (toggled via setSuperAdmin). Private: null unless the caller is this user, a super-admin or an operator.

User.isOperator ● Boolean scalar​

Company-employee flag that grants access to control-plane / operator features. Independent from is_super_admin. Private: null unless the caller is this user, a super-admin or an operator.

User.hasPassword ● Boolean scalar​

Whether this account has a password set. Studio reads it to say "set a password" only to accounts that have none (magic-link and OAuth sign-ups); it used to say so to everyone. The hash itself never leaves the process. Private: null unless the caller is this user, a super-admin or an operator.

User.orgId ● BigInt scalar​

The organization an org-managed player belongs to (BigInt serialized as a decimal string), or null for every other account. Private: null unless the caller is this user, a super-admin or an operator.

User.permissionsForOrg ● [String!] list scalar​

The user's effective permission keys on the given org (empty if not a member; full set if super admin). Requires a valid bearer game token. Private: null unless the caller is this user, a super-admin or an operator.

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

Organization id (BigInt sent as a decimal string) to evaluate the user against.

User.ageBracket ● String scalar​

The player's age bracket now: 'unknown' (no age given yet: recordPlayerAge), 'under_13', '13_15', '16_17' or '18_plus'. A CK account's comes from its birth month (counted from the month's last day, so it moves on that date); a managed player's from its organization. Private: null unless the caller is this user, a super-admin or an operator.

User.country ● String scalar​

The country the player declared, or its organization asserted (ISO 3166-1 alpha-2); null when none was given. Private: null unless the caller is this user, a super-admin or an operator.

Returned By​

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

Member Of​

AppUserAccess object ● AuthResponse object ● GameClientBootstrap object ● UserEdge object ● UsersPage object