Retiração de uma concessão
Função
Essa API permite que os usuários retirem uma concessão. Por exemplo, o usuário A concede permissões de operação na CMK A/chave ao usuário B e autoriza o usuário C a retirar a concessão. Ao fazer isso, os usuários A, B e C todos podem cancelar as permissões. Após o cancelamento, o usuário B não tem mais permissões na CMK A/chave.
Restrições
A seguir, é permitido chamar essa API:
- O usuário que concedeu as permissões
- O usuário indicado pelo parâmetro retiring_principal
- O usuário indicado pelo parâmetro grantee_principal quando retire-grant foi selecionada
URI
POST /v1.0/{project_id}/kms/retire-grant
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta). |
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
key_id |
Sim |
String |
ID de CMK. Deve ter 36 bytes e corresponder à expressão regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Exemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f |
|
grant_id |
Sim |
String |
ID da concessão, que contém 64 bytes e corresponde à expressão regular ^[A-Fa-f0-9]{64}$. Exemplo: 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d |
|
sequence |
Não |
String |
Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parâmetros de resposta
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Object |
Mensagem de erro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Informação de erro. |
Código de status: 403
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Object |
Mensagem de erro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Informação de erro. |
Código de status: 404
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Object |
Mensagem de erro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Informação de erro. |
Exemplo de solicitações
{
"key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"grant_id" : "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d"
}
Exemplo de respostas
Código de status: 400
Parâmetros de solicitação inválidos.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
}
Código de status: 403
Autenticação falhou.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
}
Código de status: 404
O recurso solicitado não existe ou não foi encontrado.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Processamento da solicitação bem-sucedido. |
|
400 |
Parâmetros de solicitação inválidos. |
|
403 |
Autenticação falhou. |
|
404 |
O recurso solicitado não existe ou não foi encontrado. |
Códigos de erro
Consulte Códigos de erro.