角色列表 - Authing 开放 API

请求参数

Query 参数

page

string

当前页码

可选

示例值:

1

limit

string

每页条数

可选

示例值:

10

sortBy

string

可选

枚举值：CREATEDAT_DESC、CREATEDAT_ASC、UPDATEDAT_DESC

示例值:

CREATEDAT_DESC

Header 参数

Authorization

string

Token

必需

示例值:

Bearer token

x-authing-userpool-id

string

用户池 ID

必需

示例值:

61b95d6c96d42670da568408

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://core.authing.cn/api/v2/roles' \
--header 'Authorization: Bearer token' \
--header 'x-authing-userpool-id: 61b95d6c96d42670da568408'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

list

array [object {9}]

必需

totalCount

integer

必需

示例

{
  "code": 200,
  "message": "查询成功",
  "data": {
    "list": [
      {
        "id": "61deb6782853c945436b6495",
        "createdAt": "2022-01-12T11:07:36.546Z",
        "updatedAt": "2022-01-12T11:07:36.546Z",
        "userPoolId": "61b95d6c96d42670da568408",
        "code": "admin",
        "description": "role of admin",
        "parentCode": null,
        "isSystem": false,
        "namespaceId": 5
      },
      {
        "id": "61dbfc73b8a893aa18e34f17",
        "createdAt": "2022-01-10T09:29:23.290Z",
        "updatedAt": "2022-01-10T09:29:23.290Z",
        "userPoolId": "61b95d6c96d42670da568408",
        "code": "default-code",
        "description": "默认分组角色",
        "parentCode": null,
        "isSystem": false,
        "namespaceId": 5
      }
    ],
    "totalCount": 2
  }
}