创建资源服务器 - Authok管理API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

name

string

名称

必需

名称

identifier

string

唯一标识符

必需

唯一标识符, 对应 audience

scopes

array[object (Scope) {2}]

权限

必需

权限

value

string

必需

description

string

必需

signing_alg

string

签名算法

必需

签名算法

signing_secret

string

签名密钥

必需

签名密钥

allow_offline_access

boolean

是否允许离线访问

必需

是否允许离线访问

skip_consent_for_verifiable_first_party_clients

boolean

是否跳过第一方应用的授权提示

必需

是否跳过第一方应用的授权提示

token_lifetime

integer

令牌有效期

必需

令牌有效期

token_lifetime_for_web

integer

令牌有效期(web端)

必需

令牌有效期(web端)

enforce_policies

boolean

是否启用RBAC策略

必需

是否启用RBAC策略, 启用后权限会写入令牌

token_dialect

string

令牌dialect

必需

令牌dialect

示例

{
    "name": "订单API",
    "identifier": "https://order.mydomain/api/v1/",
    "scopes": [
        {
            "value": "read:orders",
            "description": "读取订单"
        },
        {
            "value": "update:orders",
            "description": "更新订单"
        },
        {
            "value": "create:orders",
            "description": "创建订单"
        },
        {
            "value": "delete:orders",
            "description": "删除订单"
        }
    ],
    "allow_offline_access": true,
    "skip_consent_for_verifiable_first_party_clients": true,
    "token_lifetime": 86400,
    "token_lifetime_for_web": 86400,
    "enforce_policies": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://..authok.cn/api/v1/resource-servers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "订单API",
    "identifier": "https://order.mydomain/api/v1/",
    "scopes": [
        {
            "value": "read:orders",
            "description": "读取订单"
        },
        {
            "value": "update:orders",
            "description": "更新订单"
        },
        {
            "value": "create:orders",
            "description": "创建订单"
        },
        {
            "value": "delete:orders",
            "description": "删除订单"
        }
    ],
    "allow_offline_access": true,
    "skip_consent_for_verifiable_first_party_clients": true,
    "token_lifetime": 86400,
    "token_lifetime_for_web": 86400,
    "enforce_policies": true
}'

返回响应

🟢200成功

application/json

Body

id

string

必需

name

string

名称

必需

名称

identifier

string

唯一标识符

必需

唯一标识符, 对应 audience

is_system

boolean

是否系统API

必需

是否系统API

scopes

array[object (Scope) {2}]

权限

必需

权限

value

string

必需

description

string

必需

signing_alg

string

签名算法

必需

签名算法

signing_secret

string

签名密钥

必需

签名密钥

allow_offline_access

boolean

是否允许离线访问

必需

是否允许离线访问

skip_consent_for_verifiable_first_party_clients

boolean

是否跳过第一方应用的授权提示

必需

是否跳过第一方应用的授权提示

token_lifetime

integer

令牌有效期

必需

令牌有效期

token_lifetime_for_web

integer

令牌有效期(web端)

必需

令牌有效期(web端)

enforce_policies

boolean

是否启用RBAC策略

必需

是否启用RBAC策略, 启用后权限会写入令牌

token_dialect

string

令牌dialect

必需

令牌dialect

示例

{
    "id": "Z9t1bqKrBSuKAtKbtCcbWGXkb3NSb-Nl",
    "name": "订单API",
    "identifier": "https://order.mydomain/api/v1/",
    "scopes": [
        {
            "value": "read:orders",
            "description": "读取订单"
        },
        {
            "value": "update:orders",
            "description": "更新订单"
        },
        {
            "value": "create:orders",
            "description": "创建订单"
        },
        {
            "value": "delete:orders",
            "description": "删除订单"
        }
    ],
    "allow_offline_access": true,
    "skip_consent_for_verifiable_first_party_clients": true,
    "token_lifetime": 86400,
    "token_lifetime_for_web": 86400,
    "enforce_policies": true
}