Kinde · Schema

User

A Kinde user — an end-user account inside a Kinde business. Users can authenticate via multiple identities (email, phone, social, enterprise SSO) and belong to one or more organizations.

AuthenticationAuthorizationCustomer IdentityIdentity ManagementOAuthOpenID ConnectSingle Sign-OnMulti-Factor AuthenticationRole-Based Access ControlFeature FlagsBillingB2BSaaSDeveloper Platform

Properties

Name Type Description
id string Globally unique Kinde-generated user id (e.g. kp_abc123).
provided_id stringnull External id provided when creating the user.
preferred_email stringnull Primary email address used for sign-in and notifications.
username stringnull Optional username for the user.
first_name stringnull
last_name stringnull
full_name stringnull
is_suspended boolean Whether the user has been suspended from signing in.
picture stringnull URL of the user's profile picture.
total_sign_ins integernull
failed_sign_ins integernull
last_signed_in stringnull
created_on stringnull
organizations array List of organization codes the user belongs to.
identities array All identities (login methods) linked to the user.
View JSON Schema on GitHub

JSON Schema

kinde-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.com/schemas/kinde/user",
  "title": "User",
  "description": "A Kinde user — an end-user account inside a Kinde business. Users can authenticate via multiple identities (email, phone, social, enterprise SSO) and belong to one or more organizations.",
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Globally unique Kinde-generated user id (e.g. kp_abc123)."
    },
    "provided_id": {
      "type": ["string", "null"],
      "description": "External id provided when creating the user."
    },
    "preferred_email": {
      "type": ["string", "null"],
      "format": "email",
      "description": "Primary email address used for sign-in and notifications."
    },
    "username": {
      "type": ["string", "null"],
      "description": "Optional username for the user."
    },
    "first_name": {
      "type": ["string", "null"]
    },
    "last_name": {
      "type": ["string", "null"]
    },
    "full_name": {
      "type": ["string", "null"]
    },
    "is_suspended": {
      "type": "boolean",
      "description": "Whether the user has been suspended from signing in."
    },
    "picture": {
      "type": ["string", "null"],
      "format": "uri",
      "description": "URL of the user's profile picture."
    },
    "total_sign_ins": {
      "type": ["integer", "null"],
      "minimum": 0
    },
    "failed_sign_ins": {
      "type": ["integer", "null"],
      "minimum": 0
    },
    "last_signed_in": {
      "type": ["string", "null"],
      "format": "date-time"
    },
    "created_on": {
      "type": ["string", "null"],
      "format": "date-time"
    },
    "organizations": {
      "type": "array",
      "items": { "type": "string" },
      "description": "List of organization codes the user belongs to."
    },
    "identities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": { "type": "string", "enum": ["email", "phone", "username", "oauth2:google", "oauth2:microsoft", "oauth2:apple", "saml", "oidc"] },
          "details": { "type": "object" }
        }
      },
      "description": "All identities (login methods) linked to the user."
    }
  }
}