Users

Create user

Changed on

Creates a user record and optionally zero or more identities for the user. An example identity could be the email address of the user.

<div> <code>create:users</code> </div>
post/api/v1/user

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/user
  • Auth: HTTP bearer

Request body

organization_codestring

The unique code associated with the organization you want the user to join.

provided_idstring

An external id to reference the user.

Example request

{
  "identities": [
    {
      "type": "email",
      "is_verified": true,
      "details": {
        "email": "email@email.com"
      }
    },
    {
      "type": "phone",
      "is_verified": false,
      "details": {
        "phone": "+61426148233",
        "phone_country_id": "au"
      }
    },
    {
      "type": "username",
      "details": {
        "username": "myusername"
      }
    }
  ]
}

Response

User successfully created.

idstring

Unique ID of the user in Kinde.

createdboolean

True if the user was successfully created.

Changes

  • 0c5023c4d856Revision changes
    • info

      added the new optional request property //

  • 2d09422a38e4Revision changes
    • breaking

      added the new required header request parameter Accept to all path's operations

    • info

      the endpoint scheme security kindeBearerAuth was added to the API

    • info

      the endpoint scheme security ManagementAPI was removed from the API