修改资源

修改资源，可以设置资源的描述、定义的操作类型、URL 标识等。 ¶ 请求参数名称类型必填默认值描述示例值 code string 是 - 资源唯一标志符。 ecs description string 否 - 资源描述。服务器 actions ResourceAction[] 否 - 资源定义的操作类型。 [{"name":"ecs:Start","description":"启动

coc_Authing

52人浏览 · 2022-09-29 11:40:21

coc_Authing · 2022-09-29 11:40:21 发布

修改资源，可以设置资源的描述、定义的操作类型、URL 标识等。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
code	string	是	-	资源唯一标志符。	`ecs`
description	string	否	-	资源描述。	`服务器`
actions	ResourceAction[]	否	-	资源定义的操作类型。	`[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]`
apiIdentifier	string	否	-	API 资源的 URL 标识。	`https://my-awesome-api.com/api`
namespace	string	否	-	所属权限分组的 code。	`default`
type	string	否	-	资源类型，如数据、API、按钮、菜单。枚举值：`DATA`,`API`,`MENU`,`BUTTON`	`API`

¶ 示例代码

<?php

require 'vendor/autoload.php';

use Authing\ManagementClient;

$management = new ManagementClient(
    "AUTHING_USERPOOL_ID",
    "AUTHING_USERPOOL_SECRET"
);

$data = $management->updateResource(array(
      "code" => "ecs",
    "description" => "服务器",
    "actions" => array(
      array(
            "name" => "ecs:Start",
          "description" => "ecs:Start",
      
      )
    ),
    "apiIdentifier" => "https://my-awesome-api.com/api",
    "namespace" => "default",
    "type" => "API",

));

¶ 请求响应

类型： ResourceRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	ResourceDto	资源详情

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "code": "ecs",
    "description": "服务器",
    "type": "API",
    "actions": "[{\"name\":\"ecs:Start\",\"description\":\"启动 ECS 服务器\"},{\"name\":\"ecs:Stop\",\"description\":\"停止 ECS 服务器\"}]",
    "apiIdentifier": "https://my-awesome-api.com/api",
    "namespace": "default"
  }
}

¶ 数据结构

¶ ResourceAction

名称	类型	必填	描述
name	string	是	资源操作名称。示例值： `ecs:Start`
description	string	是	资源操作描述。示例值： `ecs:Start`

¶ ResourceDto

名称	类型	必填	描述
code	string	是	资源唯一标志符。示例值： `ecs`
description	string	否	资源描述。示例值： `服务器`
type	string	是	资源类型，如数据、API、按钮、菜单。枚举值：`DATA`,`API`,`MENU`,`BUTTON`
actions	array	否	资源定义的操作类型。嵌套类型：ResourceAction。示例值： `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]`
apiIdentifier	string	否	API 资源的 URL 标识。示例值： `https://my-awesome-api.com/api`
namespace	string	否	所属权限分组的 code。示例值： `default`