b2evolution b2evolution

  • Sign in
  • Sign up
  • About
  • Downloads
  • Hosting
  • Docs
  • Support
  • Sign in
  • Sign up
  • Manuals Home
  • Latest Updates
 
  1. b2evolution CMS User Manual
  2. Advanced Topics
  3. Using the APIs
  4. REST API or RESTful API
  5. Create a User (REST)

Create a User (REST)

POST <baseurl>/api/v1/users

This API end-point allows to create a User. It is the equivalent of the back-office feature: Creating a New User.

Parameters

The request user fields

Name

Type

Description

Required?

Default

edited_user_login

string

User login

yes

edited_user_status

string

Account status: new, activated, autoactivated, emailchanged, deactivated, failedactivation, closed

yes

edited_user_pass1

string

Password

yes

identity_form

boolean

true/1 to save the fields below:

no

false

edited_user_grp_ID

integer

Group ID

no

Depending on setting "Group for new users", see Standard Registration Panel

edited_user_level

integer

User level; min - 0, max - 10

yes

edited_user_email

string

Email address

yes

edited_user_firstname

string

First name

Depending on setting "Firstname", see User Latitude Panel

edited_user_lastname

string

Last name

Depending on setting "Lastname", see User Latitude Panel

edited_user_nickname

string

Nickname

Depending on setting "Nickname", see User Latitude Panel

edited_user_gender

string

Gender; M - Male, F - Female

Depending on setting "Gender", see Options for All Registration Methods Panel

edited_user_ctry_ID

integer

Country ID

Depending on setting "Country", see User Latitude Panel

edited_user_rgn_ID

integer

Region ID

Depending on setting "Region", see User Latitude Panel

edited_user_subrg_ID

integer

Sub-region ID

Depending on setting "Sub-region", see User Latitude Panel

edited_user_city_ID

integer

City ID

Depending on setting "City", see User Latitude Panel

edited_user_age_min

integer

Minimum age group

no

edited_user_age_max

integer

Maximum age group

no

organizations[]

array

Array of organization IDs

no

org_roles[]

array

Array of organization roles

no

edited_user_source

string

Source of user creating

no

Messages / Errors

Possible Message/Error Codes

Error code

HTTP response

Message

no_access

403

You are not logged in.

user_invalid_id

404

Invalid user ID

no_access

403

You have no permission to edit other users!

update_failed

403

Many different errors on wrong entered user fields, such as:

  • Please enter your login.
  • This login already exists.
  • Please enter your e-mail address.
  • You must be at least %d years old to use this service.
  • etc.

update_success

201

New user has been created.

Created by yurabakhtin • Last edit by yurabakhtin on 2018-10-12 10:49 • •

No feedback yet

On this page

  • Parameters
  • Messages / Errors

Search the Manual

Content Hierarchy

  • b2evolution CMS User Manual
  • User's Guide
  • Installation / Upgrade
  • Front-office Reference
  • Back-office Reference
  • Developer Reference
  • Operations Reference
  • Advanced Topics
    • Using Desktop Blogging Tools
    • Using Blogging Apps
    • Blogging by email
    • Using the APIs
      • REST API or RESTful API
        • List Collections (REST)
        • List Posts (REST)
        • List Items (REST)
        • Retrieve a Post (REST)
        • Retrieve any item (REST)
        • Search (REST)
        • List Users (REST)
        • Retrieve a User (REST)
        • Create a User (REST)
        • Update a User (REST)
        • Delete a User (REST)
        • Cookie Authentication (REST)
        • Basic HTTP Authentication (REST)
      • B2 API
      • API Error Codes
      • Blogger API
      • MetaWeblog API
      • MovableType API
    • Contributing
    • Translations (i18n/l10n)
    • Monetizing
    • How to...
    • Podcasting
  • Glossary
  • Archives
CMS engine

This online manual is powered by b2evolution CMS – A complete engine for your website.

About b2evolution

  • What is it?
  • Features
  • Getting Started
  • Screenshots
  • Online demo
  • Testimonials
  • Design philosophy
  • Free & open source
  • Terms of service

Downloads

  • Latest releases
  • Skins
  • Plugins
  • Language packs

About us

  • About us
  • Contact

Webhosting Guide

  • Web hosting blog
  • Best web hosting
  • Cheap web hosting
  • Green web hosting
  • Hosting with SSH
  • VPS hosting
  • Dedicated servers
  • Reseller hosting
  • Int'l: UK / France

Docs & Support

  • Online manual
  • Forums
  • Hire a pro !

Other

  • Adsense
  • Press room
  • Privacy policy

Stay in touch

  • GitHub
  • Twitter
  • Facebook
  • LinkedIn
  • News blog
  • RSS feed
  • Atom feed

Founded & Maintained by François Planque