Inativar ou ativar uma chave SSH

Este documento apresenta como inativar ou ativar uma chave SSH no PAM Core via API, os endpoints disponíveis, os parâmetros necessários, exemplos de requisições e as respostas em caso de sucesso ou em caso de erros.

Autorização

Para começar, certifique-se de que o PAM Core esteja listado em Recursos autorizados no seu módulo A2A. Para mais informações sobre a autorização de um aplicativo, acesse a documentação sobre como Como criar uma autorização para uma aplicação.

Autenticação

Cada requisição nas APIs deve conter a OAuth Consumer Key e o OAuth Token do cliente. Para mais informações sobre a autenticação, acesse a documentação sobre Como autenticar uma aplicação.

Métodos

Inativar uma chave SSH

Requisição

Para inativar uma chave SSH registrada no PAM Core, envie uma requisição para o seguinte endpoint:

DELETE /iso/pam/key/[id]

Parâmetros de requisição

Path

Retorno

Inativa uma chave SSH registrada no PAM Core baseado em seu id e retorna uma mensagem com informações sobre o processo de inativação.

Resposta esperada

HTTP/1.1200OK

{

    "code": 200,
    "response":  {
        "status": 200,
        "message": "Key successfully deactivated",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Key successfully deactivated",
        "erro": false,
        "cod_erro": 0
    }
}

Em caso de erro - chave SSH já está inativa

HTTP/1.1 400 Bad Request

{
    "code": 400,
    "response": {
        "status": 400,
        "message": "1017: Key inactive",
        "error": true,
        "error_code": 1,
        "detail": "",
        "mensagem": "1017: Key inactive",
        "erro": true,
        "cod_erro": 1
    },
    "exception": {
        "code": 1017,
        "message": "1017: Key inactive",
        "detail": null
    }
}

Em caso de erro - usuário não possui acesso a essa chave SSH

HTTP/1.1 400 Bad Request

{
    "code": 400,
    "response": {
        "status": 400,
        "message": "1009: No access to credential",
        "error": true,  
        "error_code": 1,    
        "detail": "",
        "mensagem": "1009: No access to credential",
        "erro": true,
        "cod_erro": 1
    },
    "exception": {
        "code": 1009,
        "message": "1009: No access to credential",
        "detail": null
    }
}

Ativar uma chave SSH

Requisição

Para ativar uma chave SSH registrada no PAM Core, envie uma requisição para o seguinte endpoint:

PUT /iso/pam/key/[id]

Parâmetros de requisição

Path

Retorno

Ativa uma chave SSH registrada no PAM Core baseado em seu id e retorna uma mensagem com informações sobre o processo de ativação.

Resposta esperada

{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Key successfully activated",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Key successfully activated",
        "erro": false,
        "cod_erro": 0
    }
}

Em caso de erro - a chave SSH já está ativa

HTTP/1.1 400 Bad Request

 {
    "code": 400,
    "response": {
        "status": 400,
        "message": "1045: Ssh key is already activated",
        "error": true,
        "error_code": 1,
        "detail": "",
        "mensagem": "1045: Ssh key is already activated",
        "erro": true,
        "cod_erro": 1
    },
    "exception": {
        "code": 1045,
        "message": "1045: Ssh key is already activated",
        "detail": ""
    }
}

Erros possíveis

Aqui está uma lista de códigos de erro HTTP e seus respectivos motivos:

• 1009: No access to credential (Sem acesso à credencial)
• 1013: The public key was not informed (Chave pública não informada).
• 1014: The private key was not informed (Chave privada não informada).
• 1016: The item is not a ssh key (O item não é uma chave SSH).