POST | Atualizar segredo de API
  • 2 minutos de leitura
  • Tema escuro
    Tema claro
  • Pdf

POST | Atualizar segredo de API

  • Tema escuro
    Tema claro
  • Pdf

Resumo do artigo

Atualize um segredo de API no MySafe.

Requisitos

  • Permissão de edição do segredo de API.

Requisição

PUT api/mysafe/secretapi/update/[identifier]

Parâmetros de requisição

Envie os parâmetros que deseja atualizar no body da requisição.

  • name - string - obrigatório - Nome atribuído ao segredo de API.


  • url - string - obrigatório - URL do site onde o segredo de API está sendo usado.


  • client_id - string - obrigatório - ID da aplicação cliente.


  • client_secret - string - O segredo de API usado para autenticar a aplicação.


  • identifier_code - string - String única definida pelo usuário para identificar o segredo de API.


  • tags - string - Palavras-chave associadas ao segredo de API.


  • notes - string - Observações sobre o segredo da API.


  • method - string - O método HTTP a ser usado na chamada de API.


  • users_allowed - array de objetos - Dados dos usuários com acesso ao segredo de API.


    →username - string - Nome do usuário com permissão de acesso ao segredo de API


    →can_edit - boolean - Permissão de edição.    Nota: Se deixado vazio, usuários terão apenas permissão de visualização.


Atenção

Usuários com permissão can_edit = true podem inativar o segredo de API.


  • groups_allowed - array de objetos - Dados dos grupos com permissão de acesso ao segredo de API.


    →name - string - Nome do grupo com permissão de acesso ao segredo de API.


    →can_edit - boolean - Permissão de edição.    Nota: Se deixado vazio, membros do grupo terão apenas permissão de visualização.


Atenção

Membros de grupos com permissão can_edit = true podem inativar o segredo de API.

Exemplo de requisição

PUT `{{url}}api/mysafe/secretapi/update/43

{
    "name": "GCP1",
    "url": "https://gcp1.com",
    "client_id": "hb455f7g8fg9dfg8yt845bxxku",
    "client_secret": "hy746**********t4tr",
    "identifier_code": "gcp7852",
    "tags": "Cloud1",
    "notes": "Access details for this API secret",
     "users_allowed": [
        {
            "username" : "alices",
            "can_edit" : true
        }
    ],
    "groups_allowed": []
}

Resposta

HTTP/1.1 200 OK 
{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Api secret updated successfully",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Api secret updated successfully",
        "erro": false,
        "cod_erro": 0
    },
    "api_entity": {
        "identifier": "5",
        "name": "GCP1",
        "url": "https://gcp1.com",
        "client_secret": "hy746**********t4tr",
        "client_id": "hb455f7g8fg9dfg8yt845bxxku",
        "identifier_code": "gcp7852",
        "method": "get",
        "tags": "Cloud1",
        "notes": "Access details for this API secret",
        "users_allowed": [
            {
                "username": "alices",
                "can_edit": true
            }
        ],
        "groups_allowed": [],
        "shared_error": []
    }
}

Erros

400 - Bad Request.

Mensagem: "1005: Api secret not found"

Possível causa: o parâmetro identifier informado não retornou nenhum segredo de API.

Solução: informe um identifier válido e envie a requisição novamente.
500 - Internal Server Error.

Mensagem: "Unexpected error."

Possível causa: o erro está no servidor senhasegura.

Solução: contate o time de suporte para mais informações.


No route matched with those values.

Mensagem: "No route matched with those values.."

Possíveis causas: falha na autenticação da sua aplicação com o servidor senhasegura ou URL incorreta.

Solução: verifique os parâmetros de autenticação como Access Token URL, Client ID e Client Secret e solicite um novo token de acesso ou verifique e corrija a URL.


An invalid response was received from the upstream server .

Mensagem: "An invalid response was received from the upstream server

Possível causa: o servidor upstream pode estar demorando muito para responder, levando a um erro de timeout que é interpretado como uma resposta inválida pelo servidor proxy/gateway.

Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.


The upstream server is timing out.

Mensagem: "The upstream server is timing out"

Possível causa: o tempo da requisição se esgotou.

Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.



Este artigo foi útil?