# 认证管理

# 查看用户名认证信息

# URI

GET /auth_username

# 请求消息

无

# 响应消息

名称	类型	描述
code	Integer	0
data	Array of Objects	所有认证数据
data[].username	String	登录用户名
meta	Object	分页信息
meta.page	Integer	页码
meta.limit	Integer	每页显示的数据条数
meta.count	Integer	数据总条数

# 请求示例

curl -u app_id:app_secret -X GET {api}/auth_username

# 响应示例

{
  "meta": {
    "page": 1,
    "limit": 10,
    "count": 3
  },
  "data": [
    {
      "username": "api_user2"
    },
    {
      "username": "api_user1"
    },
    {
      "username": "test"
    }
  ],
  "code": 0
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 查看指定用户名的认证信息

# URI

GET /auth_username/{username}

参数：

参数	类型	描述
username	String	username

# 请求消息

无

# 响应消息

名称	类型	描述
code	Integer	0
data	Object	所有认证数据
data[].username	String	username
data[].password	String	使用 sha256 加密后的密码

# 请求示例

curl -u app_id:app_secret -X GET {api}/auth_username/user1

# 响应示例

{
    "data": {
        "username": "user1"
    },
    "code": 0
}

1
2
3
4
5
6

# 创建用户名认证信息

# URI

POST /auth_username

# 请求消息

名称	类型	描述
username	String	认证用户名
password	String	认证密码

# 响应消息

名称	类型	描述
code	Integer	0

# 请求示例

curl -u app_id:app_secret -X POST -d '{"username": "user_test", "password": "password"}' {api}/auth_username

# 响应示例

{
  "code": 0
}

1
2
3

# 批量创建用户名认证信息

# URI

POST /auth_username

# 请求消息

名称	类型	描述
[].username	String	认证用户名
[].password	String	认证密码

# 响应消息

名称	类型	描述
code	Integer	0
data	Array of Objects	创建结果，key 为 username，value 为请求结果， ok 表示创建成功

# 请求示例

curl -u app_id:app_secret -X POST -d '[{"username": "api_user1", "password": "password"},{"username": "api_user2", "password": "password"}]' {api}/auth_username

# 响应示例

{
  "data": {
    "api_user1": "ok",
    "api_user2": "ok"
  },
  "code": 0
}

1
2
3
4
5
6
7

# 更新用户名认证密码

# URI

PUT /auth_username/{username}

参数：

名称	类型	描述
username	String	更新的 username

# 请求消息

名称	类型	描述
password	String	认证密码

# 响应消息

名称	类型	描述
code	Integer	0

# 请求示例

curl -u app_id:app_secret -X PUT  -d '{"password": "new_password"}' {api}/auth_username/api_user1

# 响应示例

{
  "code": 0
}

1
2
3

# 删除用户名认证信息

# URI

DELETE /auth_username/{username}

参数：

名称	类型	描述
username	String	删除的用户名

# 请求消息

无

# 响应消息

名称	类型	描述
code	Integer	0

# 请求示例

curl -u app_id:app_secret -X DELETE {api}/auth_username/api_user1

# 响应示例

{
  "code": 0
}

1
2
3

# 查看客户端认证信息

# URI

GET /auth_clientid

# 请求消息

无

# 响应消息

名称	类型	描述
code	Integer	0
data	Array of Objects	所有认证数据
data[].clientid	String	clientid
meta	Object	分页信息
meta.page	Integer	页码
meta.limit	Integer	每页显示的数据条数
meta.count	Integer	数据总条数

# 请求示例

curl -u app_id:app_secret -X GET {api}/auth_clientid

# 响应示例

{
  "meta": {
    "page": 1,
    "limit": 10,
    "count": 3
  },
  "data": [
    {
      "clientid": "api_user2"
    },
    {
      "clientid": "api_user1"
    },
    {
      "clientid": "test"
    }
  ],
  "code": 0
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 查看指定客户端的认证信息

# URI

GET /auth_clientid/{clientid}

参数：

参数	类型	描述
clientid	String	clientid

# 请求消息

无

# 响应消息

名称	类型	描述
code	Integer	0
data	Object	所有认证数据
data[].clientid	String	clientid

# 请求示例

curl -u app_id:app_secret -X GET {api}/auth_clientid/clientid_1

# 响应示例

{
  "data": {
     "clientid": "clientid_1"
  },
  "code": 0
}

1
2
3
4
5
6

# 创建客户端认证信息

# URI

POST /auth_clientid

# 请求消息

名称	类型	描述
clientid	String	clientid
password	String	认证密码

# 响应消息

名称	类型	描述
code	Integer	0

# 请求示例

curl -u app_id:app_secret -X POST -d '{"clientid": "test", "password": "password"}' {api}/auth_clientid

# 响应示例

{
  "code": 0
}

1
2
3

# 批量创建客户端认证信息

# URI

POST /auth_clientid

# 请求消息

名称	类型	描述
[].clientid	String	认证 clientid
[].password	String	认证密码

# 响应消息

名称	类型	描述
code	Integer	0
data	Array of Objects	创建结果，key 为 clientid，value 为请求结果， ok 表示创建成功

# 请求示例

curl -u app_id:app_secret -X POST -d '[{"clientid": "test1", "password": "password"},{"clientid": "test2", "password": "password"}]' {api}/auth_clientid

# 响应示例

{
  "data": {
    "test1": "ok",
    "test2": "ok"
  },
  "code": 0
}

1
2
3
4
5
6
7

# 更新客户端认证密码

# URI

PUT /auth_clientid/{clientid}

参数：

名称	类型	描述
clientid	String	更新的 clientid

# 请求消息

名称	类型	描述
password	String	认证密码

# 响应消息

名称	类型	描述
code	Integer	0

# 请求示例

curl -u app_id:app_secret -X PUT -d '{"password": "new_password"}' {api}/auth_clientid/test1

# 响应示例

{
  "code": 0
}

1
2
3

# 删除客户端认证信息

# URI

DELETE /auth_clientid/{clientid}

参数：

名称	类型	描述
clientid	String	删除的 clientid

# 请求消息

无

# 响应消息

名称	类型	描述
code	Integer	0

# 请求示例

curl -u app_id:app_secret -X DELETE {api}/auth_clientid/test1

# 响应示例

{
  "code": 0
}

1
2
3

← 场景案例：物模型管理应用访问控制管理 →