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

退役授权

分享
更新时间: 2019/10/23 GMT+08:00

功能介绍

退役授权,表示被授权用户不再具有授权密钥的操作权。

例如:用户A授权用户B可以操作密钥A/key,同时授权用户C可以撤销该授权,那么用户A、B、C均可退役该授权,退役授权后,用户B不再可以使用A/key。

可执行退役授权的主体包括:

  • 创建授权的用户;
  • 授权中retiring_principal指向的用户;
  • 当授权的操作列表中包含retire-grant时,grantee_principal指向的用户。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/retire-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

grant_id

String

授权ID,64字节,满足正则匹配“^[A-Fa-f0-9]{64}$”。

例如:7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d

sequence

String

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

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

响应消息

示例

如下以退役密钥ID为“bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e”,授权ID为“7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d”的授权为例。

  • 请求样例
    {      
        "key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
        "grant_id":"7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d"
    }
  • 响应样例
    {
    }

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

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

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区