用户注册 - ujcms

请求参数

Body 参数application/json

注册参数

integer <int64>

用户ID

必需

groupId

integer <int64>

用户组ID

必需

orgId

integer <int64>

组织ID

必需

username

string

用户名

必需

string

电子邮箱

可选

mobile

string

手机号码

可选

alias

string

博客地址

可选

nickname

string

昵称

可选

realName

string

真实姓名

可选

gender

integer <int32>

必需

性别(0:保密,1:男,2:女)

avatar

string

头像URL

可选

passwordModified

string <date-time>

密码修改时间

必需

rank

integer <int32>

等级

必需

type

integer <int32>

必需

类型(1:系统管理员,2:安全管理员,3:审计管理员,4:常规管理员,5:前台会员)

status

integer <int32>

必需

状态(0:正常,1:未激活,2:已锁定,3:已注销)

group

object (Group)

用户组实体类

可选

integer <int64>

用户组ID

必需

name

string

名称

必需

description

string

描述

可选

allAccessPermission

boolean

全部浏览权限

必需

type

integer <int32>

必需

类型(1:系统,2:常规,3:IP组)

order

integer <int32>

排列顺序

必需

accessPermissions

array[integer <int64>]

可选

访问权限，栏目ID列表。非数据库属性，用于接收前台请求。

org

object (Org)

组织实体类

可选

integer <int64>

组织ID

必需

parentId

integer <int64>

上级组织ID

可选

name

string

名称

必需

phone

string

电话

可选

address

string

地址

可选

contacts

string

联系人

可选

depth

integer <int32>

层级

必需

order

integer <int32>

排列顺序

必需

hasChildren

boolean

是否有子组织

可选

names

array[string]

名称层级列表

可选

paths

array[object (Org) {11}]

可选

组织层级。从一级组织到当前组织的列表。只有在单独查询组织对象时，才有此属性；查询组织列表时，此属性只包含当前组织

roleList

array[object (Role) {19}]

角色列表

可选

integer <int64>

角色ID

必需

siteId

integer <int64>

站点ID

可选

name

string

名称

必需

description

string

描述

可选

allPermission

boolean

所有功能权限

必需

allGrantPermission

boolean

所有授权权限

必需

globalPermission

boolean

全局数据权限

必需

allArticlePermission

boolean

所有文章权限

必需

allChannelPermission

boolean

所有栏目权限

必需

dataScope

integer <int32>

必需

数据权限范围(1:全部,2:有权限的组织,2:所属组织,3:自身)

allStatusPermission

boolean

所有状态权限

必需

rank

integer <int32>

等级

必需

type

integer <int32>

必需

类型(1:系统管理员,2:安全管理员,3:审计管理员,4:常规角色)

scope

integer <int32>

必需

共享范围(0:本站私有,1:子站点共享,2:全局共享)

order

integer <int32>

排列顺序

必需

permission

string

功能权限

可选

grantPermission

string

授权权限

可选

site

object (Site)

站点实体类

可选

global

boolean

是否全局共享

可选

orgList

array[object (Org) {11}]

扩展组织列表

可选

integer <int64>

组织ID

必需

parentId

integer <int64>

上级组织ID

可选

name

string

名称

必需

phone

string

电话

可选

address

string

地址

可选

contacts

string

联系人

可选

depth

integer <int32>

层级

必需

order

integer <int32>

排列顺序

必需

hasChildren

boolean

是否有子组织

可选

names

array[string]

名称层级列表

可选

paths

array[object (Org) {11}]

可选

组织层级。从一级组织到当前组织的列表。只有在单独查询组织对象时，才有此属性；查询组织列表时，此属性只包含当前组织

captchaToken

string

验证码Token

可选

captcha

string

验证码

可选

emailMessageId

integer <int64>

邮件短信ID

可选

emailMessageValue

string

邮件验证码

可选

mobileMessageId

integer <int64>

手机短信ID

可选

mobileMessageValue

string

短信验证码

可选

name

string

可选

用户名和用户真实姓名

location

string

居住地

可选

created

string <date-time>

创建日期

可选

enabled

boolean

是否正常状态

可选

root

boolean

可选

是否超级管理员。ID为1的用户为超级管理员

loginDate

string <date-time>

最后登录日期

必需

loginCount

integer <int32>

登录次数

必需

loginIp

string

最后登录IP

必需

largeAvatar

string

大头像

可选

mediumAvatar

string

中头像

可选

birthday

string <date-time>

出生日期

可选

bio

string

自我介绍

可选

homepage

string

个人主页

可选

smallAvatar

string

小头像

可选

示例

{
  "id": 0,
  "groupId": 0,
  "orgId": 0,
  "username": "string",
  "email": "string",
  "mobile": "string",
  "alias": "string",
  "nickname": "string",
  "realName": "string",
  "gender": 0,
  "avatar": "string",
  "passwordModified": "2019-08-24T14:15:22Z",
  "rank": 0,
  "type": 0,
  "status": 0,
  "group": {
    "id": 0,
    "name": "string",
    "description": "string",
    "allAccessPermission": true,
    "type": 0,
    "order": 0,
    "accessPermissions": [
      0
    ]
  },
  "org": {
    "id": 0,
    "parentId": 0,
    "name": "string",
    "phone": "string",
    "address": "string",
    "contacts": "string",
    "depth": 0,
    "order": 0,
    "hasChildren": true,
    "names": [
      "string"
    ],
    "paths": [
      {}
    ]
  },
  "roleList": [
    {
      "id": 0,
      "siteId": 0,
      "name": "string",
      "description": "string",
      "allPermission": true,
      "allGrantPermission": true,
      "globalPermission": true,
      "allArticlePermission": true,
      "allChannelPermission": true,
      "dataScope": 0,
      "allStatusPermission": true,
      "rank": 0,
      "type": 0,
      "scope": 0,
      "order": 0,
      "permission": "string",
      "grantPermission": "string",
      "site": {
        "id": 0,
        "parentId": 0,
        "orgId": 0,
        "modelId": 0,
        "name": "string",
        "description": "string",
        "protocol": "string",
        "domain": "string",
        "subDir": "string",
        "theme": "string",
        "mobileTheme": "string",
        "pageSize": 0,
        "logo": "string",
        "seoTitle": "string",
        "seoKeywords": "string",
        "seoDescription": "string",
        "staticFile": "string",
        "mobileStaticFile": "string",
        "editorSettings": "string",
        "status": 0,
        "depth": 0,
        "order": 0,
        "views": 0,
        "selfViews": 0,
        "todayViews": 0,
        "yesterdayViews": 0,
        "maxViews": 0,
        "maxDate": "2019-08-24T14:15:22Z",
        "mainsJson": "string",
        "clobsJson": "string",
        "customs": {
          "property1": {},
          "property2": {}
        },
        "watermark": {
          "enabled": true,
          "overlay": "string",
          "position": 0,
          "dissolve": 0,
          "minWidth": 0,
          "minHeight": 0
        },
        "html": {
          "enabled": true,
          "auto": true,
          "listPages": 0,
          "channel": "string",
          "article": "string",
          "enabledAndAuto": true
        },
        "messageBoard": {
          "enabled": true,
          "loginRequired": true
        },
        "editor": {
          "property1": {},
          "property2": {}
        },
        "copyFromId": 0,
        "copyData": [
          "string"
        ],
        "hasChildren": true,
        "parent": {},
        "org": {
          "id": 0,
          "parentId": 0,
          "name": "string",
          "phone": "string",
          "address": "string",
          "contacts": "string",
          "depth": 0,
          "order": 0,
          "hasChildren": true,
          "names": [
            "string"
          ],
          "paths": [
            {}
          ]
        },
        "model": {
          "id": 0,
          "siteId": 0,
          "name": "string",
          "type": "string",
          "scope": 0,
          "order": 0,
          "mains": "string",
          "asides": "string",
          "customs": "string"
        },
        "enabled": true,
        "url": "string",
        "filesPath": "string",
        "api": "string",
        "mobileStaticUrl": "string",
        "dynamicUrl": "string",
        "staticUrl": "string",
        "normalStaticUrl": "string",
        "dy": "string",
        "names": [
          "string"
        ],
        "template": "string",
        "staticBase": "string",
        "paths": [
          {}
        ],
        "disabled": true,
        "htmlEnabled": true,
        "title": "string",
        "targetBlank": true
      },
      "global": true
    }
  ],
  "orgList": [
    {
      "id": 0,
      "parentId": 0,
      "name": "string",
      "phone": "string",
      "address": "string",
      "contacts": "string",
      "depth": 0,
      "order": 0,
      "hasChildren": true,
      "names": [
        "string"
      ],
      "paths": [
        {}
      ]
    }
  ],
  "captchaToken": "string",
  "captcha": "string",
  "emailMessageId": 0,
  "emailMessageValue": "string",
  "mobileMessageId": 0,
  "mobileMessageValue": "string",
  "name": "string",
  "location": "string",
  "created": "2019-08-24T14:15:22Z",
  "enabled": true,
  "root": true,
  "loginDate": "2019-08-24T14:15:22Z",
  "loginCount": 0,
  "loginIp": "string",
  "largeAvatar": "string",
  "mediumAvatar": "string",
  "birthday": "2019-08-24T14:15:22Z",
  "bio": "string",
  "homepage": "string",
  "smallAvatar": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.ujcms.com/api/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 0,
    "groupId": 0,
    "orgId": 0,
    "username": "string",
    "email": "string",
    "mobile": "string",
    "alias": "string",
    "nickname": "string",
    "realName": "string",
    "gender": 0,
    "avatar": "string",
    "passwordModified": "2019-08-24T14:15:22Z",
    "rank": 0,
    "type": 0,
    "status": 0,
    "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "allAccessPermission": true,
        "type": 0,
        "order": 0,
        "accessPermissions": [
            0
        ]
    },
    "org": {
        "id": 0,
        "parentId": 0,
        "name": "string",
        "phone": "string",
        "address": "string",
        "contacts": "string",
        "depth": 0,
        "order": 0,
        "hasChildren": true,
        "names": [
            "string"
        ],
        "paths": [
            {}
        ]
    },
    "roleList": [
        {
            "id": 0,
            "siteId": 0,
            "name": "string",
            "description": "string",
            "allPermission": true,
            "allGrantPermission": true,
            "globalPermission": true,
            "allArticlePermission": true,
            "allChannelPermission": true,
            "dataScope": 0,
            "allStatusPermission": true,
            "rank": 0,
            "type": 0,
            "scope": 0,
            "order": 0,
            "permission": "string",
            "grantPermission": "string",
            "site": {
                "id": 0,
                "parentId": 0,
                "orgId": 0,
                "modelId": 0,
                "name": "string",
                "description": "string",
                "protocol": "string",
                "domain": "string",
                "subDir": "string",
                "theme": "string",
                "mobileTheme": "string",
                "pageSize": 0,
                "logo": "string",
                "seoTitle": "string",
                "seoKeywords": "string",
                "seoDescription": "string",
                "staticFile": "string",
                "mobileStaticFile": "string",
                "editorSettings": "string",
                "status": 0,
                "depth": 0,
                "order": 0,
                "views": 0,
                "selfViews": 0,
                "todayViews": 0,
                "yesterdayViews": 0,
                "maxViews": 0,
                "maxDate": "2019-08-24T14:15:22Z",
                "mainsJson": "string",
                "clobsJson": "string",
                "customs": {
                    "property1": {},
                    "property2": {}
                },
                "watermark": {
                    "enabled": true,
                    "overlay": "string",
                    "position": 0,
                    "dissolve": 0,
                    "minWidth": 0,
                    "minHeight": 0
                },
                "html": {
                    "enabled": true,
                    "auto": true,
                    "listPages": 0,
                    "channel": "string",
                    "article": "string",
                    "enabledAndAuto": true
                },
                "messageBoard": {
                    "enabled": true,
                    "loginRequired": true
                },
                "editor": {
                    "property1": {},
                    "property2": {}
                },
                "copyFromId": 0,
                "copyData": [
                    "string"
                ],
                "hasChildren": true,
                "parent": {},
                "org": {
                    "id": 0,
                    "parentId": 0,
                    "name": "string",
                    "phone": "string",
                    "address": "string",
                    "contacts": "string",
                    "depth": 0,
                    "order": 0,
                    "hasChildren": true,
                    "names": [
                        "string"
                    ],
                    "paths": [
                        {}
                    ]
                },
                "model": {
                    "id": 0,
                    "siteId": 0,
                    "name": "string",
                    "type": "string",
                    "scope": 0,
                    "order": 0,
                    "mains": "string",
                    "asides": "string",
                    "customs": "string"
                },
                "enabled": true,
                "url": "string",
                "filesPath": "string",
                "api": "string",
                "mobileStaticUrl": "string",
                "dynamicUrl": "string",
                "staticUrl": "string",
                "normalStaticUrl": "string",
                "dy": "string",
                "names": [
                    "string"
                ],
                "template": "string",
                "staticBase": "string",
                "paths": [
                    {}
                ],
                "disabled": true,
                "htmlEnabled": true,
                "title": "string",
                "targetBlank": true
            },
            "global": true
        }
    ],
    "orgList": [
        {
            "id": 0,
            "parentId": 0,
            "name": "string",
            "phone": "string",
            "address": "string",
            "contacts": "string",
            "depth": 0,
            "order": 0,
            "hasChildren": true,
            "names": [
                "string"
            ],
            "paths": [
                {}
            ]
        }
    ],
    "captchaToken": "string",
    "captcha": "string",
    "emailMessageId": 0,
    "emailMessageValue": "string",
    "mobileMessageId": 0,
    "mobileMessageValue": "string",
    "name": "string",
    "location": "string",
    "created": "2019-08-24T14:15:22Z",
    "enabled": true,
    "root": true,
    "loginDate": "2019-08-24T14:15:22Z",
    "loginCount": 0,
    "loginIp": "string",
    "largeAvatar": "string",
    "mediumAvatar": "string",
    "birthday": "2019-08-24T14:15:22Z",
    "bio": "string",
    "homepage": "string",
    "smallAvatar": "string"
}'

返回响应

🟢200成功

*/*

Body

响应对象

status

integer <int32>

可选

逻辑状态码。0:成功, -1:失败。其它状态可以根据自己的实际逻辑随意使用

result

object

数据

可选

额外字段

object

数据

可选

message

string

信息

可选

exception

string

异常类的类名

可选

示例

{
  "status": 0,
  "result": {
    "property1": {},
    "property2": {}
  },
  "message": "string",
  "exception": "string"
}