更改字段的访问权限

aki发表于:2016年12月08日 15:15:10更新于:2019年01月31日 15:01:59

更改字段的访问权限。

URI

更新正式环境的应用时所使用的URL跟更新测试环境时不一样。

更新正式环境的应用时

https://(子域名).cybozu.cn/k/v1/field/acl.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/field/acl.json

执行该API时,不单应用的访问权限,连测试环境的应用内的所有设置都会应用到正式环境的应用中。

更新测试环境的应用时

https://(子域名).cybozu.cn/k/v1/preview/field/acl.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/field/acl.json

HTTP 方法

PUT

访问权限

需要有应用的管理权限。

请求

参数

以下是要指定的参数一览。省略参数时,其设置不会被更改。

参数名称要指定的值必须说明
app数值或字符串必须

指定应用ID。使用“app”及“id”的其中一个参数。如果两个都指定,“id”优先。

id


revision数值或字符串
指定应用的设置更改之前的修订号。如指定的修订号不是最新的,请求将报错。
如果省略或指定“-1”,将不对修订号进行验证。
rights数组必须用于存放访问权限设置对象的数组。从优先度高到低排列。但是,不管这里如果指定,对“Everyone”(所有用户)的设置的优先度一直都是最低的。
rights[].code字符串必须指定要设置访问权限的字段的代码。
rights[].entities数组必须用于存放访问权限的设置对象的数组。排列顺序按设置的优先度从高到低排列。
rights[].entities[].accessibility字符串必须对字段指定可执行的操作。
  • 仅可查看:READ

  • 可查看及编辑:WRITE

  • 不可查看也不可编辑:NONE

rights[].entities[].entity对象必须用于存放设置了访问权限的用户的对象。
rights[].entities[].entity.code字符串必须指定访问权限的设置对象的代码。
如果访问权限的设置对象没有指定“Everyone”(所有用户),“Everyone”不可执行任何操作。
如果要指定来宾用户,登录名称前面加“guest/”。
rights[].entities[].entity.type字符串必须指定访问权限的设置对象的种类。
  • 用户时:USER

  • 组时:GROUP

  • 组织时:ORGANIZATION

  • 用户字段:FIELD_ENTITY

rights[].entities[].includeSubs布尔值或字符串
是否将设置继承给其下级组织。
  • 继承:true

  • 不继承(初始设置):false

 不可使用API令牌来执行该API。

请求的范例

头部

PUT /k/v1/field/acl.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

{
  "app": 1,
  "rights": [
    {
      "code": "单行文本框",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          }
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          }
        }
      ]
    },
    {
      "code": "数值",
      "entities": [
        {
          "accessibility": "NONE",
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "includeSubs": true
        }
      ]
    }
  ],
  "revision": 2
}



应答

参数

参数名称值的类型说明
revision字符串应用的设置更改之后的修订号。

应答的范例

{
  "revision": "3"
}

JavaScript 范例

kintone REST API

var body ={
    "app": 1,
    "rights": [
        {
            "code": "单行文本框",
            "entities": [
                {
                    "accessibility": "WRITE",
                    "entity": {
                        "type": "USER",
                        "code": "user1"
                    }
                },
                {
                    "accessibility": "READ",
                    "entity": {
                        "type": "GROUP",
                        "code": "everyone"
                    }
                }
            ]
        },
        {
            "code": "数值",
            "entities": [
                {
                    "accessibility": "NONE",
                    "entity": {
                        "type": "ORGANIZATION",
                        "code": "销售部"
                    },
                    "includeSubs": true
                }
            ]
        }
    ]
};
kintone.api(kintone.api.url('/k/v1/field/acl', true), 'PUT', body, function(resp) {
    // success
    console.log(resp);
}, function(error) {
    // error
    console.log(error);
});

XMLHttpRequest

var body = {
    "app": 1,
    "rights": [
        {
            "code": "单行文本框",
            "entities": [
                {
                    "accessibility": "WRITE",
                    "entity": {
                        "type": "USER",
                        "code": "user1"
                    }
                },
                {
                    "accessibility": "READ",
                    "entity": {
                        "type": "GROUP",
                        "code": "everyone"
                    }
                }
            ]
        },
        {
            "code": "数值",
            "entities": [
                {
                    "accessibility": "NONE",
                    "entity": {
                        "type": "ORGANIZATION",
                        "code": "销售部"
                    },
                    "includeSubs": true
                }
            ]
        }
    ],
    // CSRF TOKEN: 在kintone中执行API(POST, PUT, DELETE)时需要设置
    "__REQUEST_TOKEN__": kintone.getRequestToken()
};
var url = 'https://{subdomain}.cybozu.cn/k/v1/field/acl.json';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
    if (xhr.status === 200) {
        // success
        console.log(JSON.parse(xhr.responseText));
    } else {
        // error
        console.log(JSON.parse(xhr.responseText));
    }
};
xhr.send(JSON.stringify(body));


    您需要登录后才可以回复