文档首页 > > API参考> API说明> 管理加密密钥> 创建授权

创建授权

分享
更新时间: 2020/06/01 GMT+08:00

功能介绍

创建授权,被授权用户可以对授权密钥进行操作。

服务默认主密钥(密钥别名后缀为“/default”)不可以授权。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/create-grant

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

key_id

String

密钥ID,36字节,满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如:0d0466b0-e727-4d9c-b35d-f84bb474a37f

grantee_principal

String

被授权用户ID,1~64字节,满足正则匹配“^[a-zA-Z0-9]{1,64}$”。

例如:0d0466b00d0466b00d0466b00d0466b0

operations

Array of strings

授权允许的操作列表。

有效的值:“create-datakey”“create-datakey-without-plaintext”“encrypt-datakey”“decrypt-datakey”“describe-key”“create-grant”“retire-grant”“encrypt-data”“decrypt-data”

有效值不能仅为“create-grant”

name

String

授权名称,取值1到255字符,满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”。

retiring_principal

String

可退役授权的用户ID,1~64字节,满足正则匹配“^[a-zA-Z0-9]{1,64}$”。

例如:0d0466b00d0466b00d0466b00d0466b0

grantee_principal_type

String

授权类型。

有效值:“user”“domain”。默认值为“user”

sequence

String

请求消息序列号,36字节序列号。

例如:919c82d4-8046-4722-9094-35c3c6524cff

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

grant_id

String

授权ID,64字节。

示例

如下将密钥ID为“bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e”“describe-key”“create-datakey”“encrypt-datakey”操作权限授予用户ID为“13gg44z4g2sglzk0egw0u726zoyzvrs8”的用户,授权名称为“my_grant”,可退役授权的用户ID为“13gg44z4g2sglzk0egw0u726zoyzvrs8”为例。

  • 请求样例
    {      
        "key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
        "operations": [
           "describe-key",
           "create-datakey",
           "encrypt-datakey"
         ],
         "grantee_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
         "grantee_principal_type":"user",
         "name":"my_grant",
         "retiring_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8"
    }
  • 响应样例
    {
        "grant_id": "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d"
    }

    {
        "error": {
            "error_code": "KMS.XXXX",
            "error_msg": "XXX"
        }
    }

状态码

表4描述的是API返回的正常状态码。
表4 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码,请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问