Certificate Manager
  • 23 minutos de leitura
  • Tema escuro
    Tema claro
  • Pdf

Certificate Manager

  • Tema escuro
    Tema claro
  • Pdf

Resumo do artigo

Cuidado

Para utilizar esses métodos o recurso Certificados deve ser selecionado na autorização da aplicação.

Introdução

O senhasegura Certificate Manager fornece gerenciamento centralizado do ciclo de vida do certificado digital dentro da organização, desde o Discovery através da verificação automática de sites, diretórios e servidores da web, até a renovação automática do Certificado por meio de Autoridades Certificadoras externa ou interna .

O objetivo desse documento é prover um guia para usuários utilizando o Certificate Manager como administradores, e explicar sobre detalhes de uso, benefícios e procedimentos.

Como o Certificate Manager funciona

O senhasegura Certificate Manager gerencia todo o ciclo de vida dos certificados digitais, trabalhando com certificados através de geração por requisições, importação manual de certificados existentes, ou Discovery de certificados em dispositivos, domínios ou containers. Além de monitorar a validade dos certificados e possibilitar a renovação de maneira facilitada, o Certificate Manager permite também a visualização de logs e relatórios sobre todas as operações realizadas através da solução.

Definições

O senhasegura utiliza uma terminologia específica para suas funções e funcionalidades. Assim, alguns termos devem ser compreendidos antes de iniciar o uso da solução:

  • Usuário: Funcionários próprios, estagiários ou terceiros que usam ou podem precisar de acesso aos sistemas da empresa;

  • Certificado Digital: Certificados digitais são arquivos que contêm informações, além de chaves, públicas e privadas, usadas para comunicação segura pela Internet. Na presente versão deste manual o senhasegura realiza o gerenciamento de certificados digitais utilizados em webservices.

  • Autoridade Certificadora (CA): É uma empresa ou organização que valida a identidade de pessoas, empresas, endereços de e-mail, websites e emite os certificados digitais relacionados a essas identidades para garantir a autenticidade e integridade das comunicações.

Atividades

Nesta seção, serão abordadas as seguintes funções do senhasegura: realizar requisições, receber respostas e métodos do senhasegura Certificate Manager.

Métodos

O webservice de integração senhasegura possui alguns métodos para realizar operações na aplicação.

Criar/Modificar Request

POST https://vault_url/iso/certificate/request/\[request_code\] 

O método Criar/Modificar Request cria ou modifica um request de certificado no senhasegura .

Parâmetros

CampoTipoDescriçãoObrig.
code_requestIntCódigo de um Request já criado. Caso o código não seja incluído no parâmetro, um novo Request será criado.Não
certificate_typeIntTipo do certificado. Os possíveis valores são: 1 = DV SSL - Domain SSL; 2 = OV SSL - Organization SSL; 3 = EV SSL - Extended SSLSim
domain_typeStringTipo do domínio do certificado. Os possíveis valores são: SING = Single domain; MULT = Multiple domains; WILD = WildcardSim
organizationIntCódigo da organização. Deverá ser informado o código de uma organização cadastrada no senhasegura .Sim
common_nameStringNome comum do certificado.Sim
sanArraySubject Alternative Name. Será preenchido com o nome_comum caso o san não seja informado.Não.
tagsArrayTags de identificação do certificado. Será cadastrada novas tags caso as informadas não existam.Não.
encryptionStringAlgoritmo de criptografia. Os possíveis valores são: RSA; DSASim
encryption_key_sizeIntTamanho da chave de criptografia. Os possíveis valores são: 4096; 2048; 1024Sim
certificate_algorithmStringAlgoritmo de assinatura Os possíveis valores são: SHA256; SHA384; SHA512. Se a criptografia escolhida for DSA, será permitido apenas o uso de SHA256.Sim
validityIntTempo de validade do certificado, em dias.Sim
key_passwordStringSenha da chave do certificado.Não
senha_revogacaoStringSenha de revogação do certificado.Não
environmentsArrayAmbientes do certificado. Serão cadastrados novos ambientes de certificado caso os informados não existam.Não
systemsArraySistemas do certificado. Serão cadastrados novos sistemas de certificado caso os informados não existam.Não
projectStringProjeto do certificado no request.Não
external_ipStringIP externo do certificado no request.Não
hostname_ipStringIP ou hostname do certificado no request.Não
justificationStringJustificativa do request com até 1024 caracteres.Não
responsibleIntCódigo do responsável pelo request e pelo certificado. Deverá ser um usuário cadastrado no senhasegura.Não
descriptionStringDescrição do request com até 512 caracteres.Não

Resposta para certificados

Se o método for executado com sucesso ou com erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível criar o request.
errorBooleanfalsetrue
code_requestIntCódigo do request.O código de request informado é inválido
type_certificateIntTipo do certificado informado.O tipo de certificado informado é inválido.
type_domainStringTipo do domínio do certificado informado.O tipo do domínio do certificado informado é inválido.
organizationIntCódigo da organização informado.O código da organização informado é inválido
common_nameStringNome comum informado.O nome comum do certificado não foi informado.
sanArraySAN informado(s).
tagsArrayTags informadas.
encryptionStringAlgoritmo de criptografia informado.O algoritmo de criptografia informado é inválido.
encryption_key_sizeIntTamanho da chave de criptografia informado.O tamanho da chave de criptografia informado é inválido.
certificate_algorithmStringAlgoritmo de assinatura informado.O algoritmo de assinatura informado é inválido.
validityIntTempo de validade do certificado informado.O tempo de validade do certificado informado é inválido.
password_keyStringInformação sensível.A senha da chave do certificado informada é inválida.
password_revocationStringInformação sensível.A senha da chave do certificado informada é inválida.
environmentsArrayAmbientes informados.
systemsArraySistemas informados.
designStringProjeto informado.
ip_externalStringIP informado.
ip_hostnameStringIP ou hostname informado.
justificationStringJustificativa informada.A justificativa deve ter no máximo 1024 caracteres.
responsibleIntCódigo do responsável informado.O código do responsável informado é inválido.
descriptionStringDescrição informada.A descrição deve ter no máximo 512 caracteres.

Consultar/Listar Request

GET https://vault_url/iso/certificate/request/list\[request_code\] 

O método Consultar/Listar Request consulta uma ou mais requests de certificado no senhasegura .

Parâmetros

CampoTipoDescriçãoObrig.
code_requestIntCódigo de um Request já criado.Não
status_requestIntCódigo de um status de um request.Não
type_certificateIntTipo do certificado. As opções serão: 1 = DV SSL - Domain SSL; 2 = OV SSL - Organization SSL; 3 = EV SSL - Extended SSLNão
type_domainStringTipo do domínio do certificado. As opções serão: SING = Single domain; MULT = Multiple domains; WILD = WildcardNão
organizationIntCódigo da organização cadastrada no senhasegura.Não
common_nameStringNome comum do certificado.Não
sanStringSubject Alternative Names, separados por vírgulaNão
tagsStringTags de identificação do certificado, separados por vírgulaNão
encryptionStringAlgoritmo de criptografia. As opções serão: RSA; DSANão
encryption_key_sizeIntTamanho da chave de criptografia. As opções serão: 4096; 2048; 1024Não
algorithm_certifiedStringAlgoritmo de assinatura As opções serão: SHA256; SHA384; SHA512Não
validityIntTempo de validade do certificado em dias.Não
password_keyStringSenha da chave do certificado.Não
password_revocationStringSenha de revogação do certificado.Não
environmentsStringAmbientes do certificado, separados por vírgulaNão
systemsStringSistemas do certificado, separados por vírgulaNão
designStringProjeto do certificado no request.Não
ip_externalStringIP externo do certificado no request.Não
ip_hostnameStringIP ou hostname do certificado no request.Não
responsibleIntCódigo do responsável pelo request e pelo certificado.Não
offsetIntNúmero base da contagem de registros pela paginação.Não
limitIntNúmero de registros na paginação.Não

Resposta para certificados

Se o método for executado com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível criar o request.
errorBooleanfalsetrue
code_requestIntCódigo do request.O código de request informado é inválido
status_requestStringCódigo e nome do status da requisição.There are no requests with the status entered. The status code you entered is invalid.
type_certificateIntTipo do certificado informado.O tipo de certificado informado é inválido.
type_domainStringTipo do domínio do certificado informado.O tipo do domínio do certificado informado é inválido.
organizationIntCódigo da organização informado.O código da organização informado é inválido
common_nameStringNome comum informado.O nome comum do certificado não foi informado.
sanArraySAN informado(s).
tagsArrayTags informadas.
encryptionStringAlgoritmo de criptografia informado.O algoritmo de criptografia informado é inválido.
encryption_key_sizeIntTamanho da chave de criptografia informado.O tamanho da chave de criptografia informado é inválido.
certificate_algorithmStringAlgoritmo de assinatura informado.O algoritmo de assinatura informado é inválido.
validityIntTempo de validade do certificado informado.O tempo de validade do certificado informado é inválido.
password_keyStringInformação sensível.A senha da chave do certificado informada é inválida.
password_revocationStringInformação sensível.A senha da chave do certificado informada é inválida.
environmentsArrayAmbientes informados.
systemsArraySistemas informados.
designStringProjeto informado.
ip_externalStringIP informado.
ip_hostnameStringIP ou hostname informado.
justificationStringJustificativa informada.A justificativa deve ter no máximo 1024 caracteres.
responsibleIntCódigo do responsável informado.O código do responsável informado é inválido.
descriptionStringDescrição informada.A descrição deve ter no máximo 512 caracteres.

Assinar Request

GET https://vault_url/iso/certificate/request/sign\[request_code\] 

O método Assinar Request assina um request existente no senhasegura .

Parâmetros

CampoTipoDescriçãoObrig.
code_requestIntCódigo do request a ser assinado..Sim
self_signedIntIndica se é auto-assinado. As opções serão: 1 = true; 0 = falseSim
caIntCódigo da CA responsável pela assinatura request. Obrigatório, caso auto_assinado seja falso.Condicional
justificationStringTexto de até 1024 caracteres para justificativa.Não
reasonIntCódigo do motivo da assinatura. Deverá informar um código de um motivo cadastrado no senhasegura*.Sim
itsm_codeStringCaracteres para determinar o código do ITSM. Obrigatório caso no grupo de acesso do certificado o parâmetro "Código de governança obrigatório ao justificar" esteja habilitado. Realizar as validações no ITSM da mesma forma que é feito na interface web.Condicional

Resposta para certificados

Se o método for executado com sucesso, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível assinar o request.
errorBooleanfalsetrue
code_requestIntCódigo da request.Informe um código de request. O código da request informado é inválido.
self_signedIntValor informado.Não existem requests para este valor de auto-assinado informado. O valor para auto-assinado informado é inválido.
caIntCódigo e nome da CA informado.Não existem requests com o código da CA informado. O código da CA informado é inválido
justificationStringJustificativa informada.A justificativa deve ter no máximo 1024 caracteres.
reasonIntCódigo e nome do motivo informado.O código do motivo informado é inválido.
itsm_codeStringCódigo da GMUD informado.Informe o código da GMUD.

Consultar/Listar Certificados

GET https://vault_url/iso/certificate/list/\[request_code\] 

O método Consultar/Listar Certificados consulta uma ou mais certificados no senhasegura.

Parameters

CampoTipoDescriçãoObrig.
code_ certificateIntCódigo de um certificado já criado no senhasegura.Não
status_certificateIntCódigo de um status de um certificado. As opções serão: 1 = Válido; 2 = Revogado; 3 = Renovação pendente; 4 = Expirado**Não
activeIntEstado do certificado no senhasegura. As opções serão: 1 = Ativo; 0 = InativoNão
start_validityStringData de início da validade.Não
end_validityStringData de fim da validade.Não
origin_certificateIntOrigem do certificado no senhasegura. As opções serão: SCAN = Scan e Discovery; REQU = Request; IMPO = Importado manualmenteNão
type_certificateIntTipo do certificado. As opções serão: 1 = DV SSL - Domain SSL; 2 = OV SSL - Organization SSL; 3 = EV SSL - Extended SSLNão
type_domainStringTipo do domínio do certificado. As opções serão: SING = Single domain; MULT = Multiple domains; WILD = WildcardNão
organizationIntCódigo da organização.Não
common_nameStringNome comum do certificado.Não
sanStringSubject Alternative Name. Poderá informar mais de 1 separados por vírgula.Não
tagsStringTags de identificação do certificado. Poderá informar mais de 1 separados por vírgula.Não
encryptionStringAlgoritmo de criptografia. As opções serão: RSA; DSANão
encryption_key_sizeIntTamanho da chave de criptografia. As opções serão: 4096; 2048; 1024Não
algorithm_certifiedStringAlgoritmo de assinatura. As opções serão: sha256; sha384; sha512Não
validityIntTempo de validade do certificado em quantidade de dias.Não
password_keyStringSenha da chave do certificado.Não
password_revocationStringSenha de revogação do certificado.Não
environmentsStringAmbientes do certificado. Poderá informar mais de 1 separados por vírgula.Não
systemsStringSistemas do certificado. Poderá informar mais de 1 separados por vírgula.**Não
projectStringProjeto do certificado no request.Não
ip_externalStringIP externo do certificado no request.Não
ip_hostnameStringIP ou hostname do certificado no request.Não
self_signedIntIndica se é auto-assinado. As opções serão: 1 = true; 0 = falseNão
caIntCódigo da CA responsável pela assinatura request.Não
responsibleIntCódigo do responsável pelo request e pelo certificado.Não
offsetIntNúmero base da contagem de registros pela paginação.Não
limitIntNúmero de registros na paginação.Não

Resposta para certificados

Se o método for executado com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível encontrar certificados com as informações fornecidas.
errorBooleanfalsetrue
code_requestIntCódigo da request.Não existe um certificado com o código informado. O código do certificado informado é inválido.
status_certifiedIntCódigo e nome do status do certificado.Não existem certificados com o status informado. O código de status informado é inválido.
activeIntCódigo e nome do estado do certificado no senhasegura.Não existe nenhum certificado com o estado informado. O código do estado informado é inválido.
start_validityStringData de início da validade.Não existem certificados com a data de início da validade informada. A data de início da validade informada é inválida.
end_validityStringData de fim da validade.Não existem certificados com a data de fim da validade informada. A data de fim da validade informada é inválida.
origin_certificateIntOrigem do certificado no senhasegura.Não existem certificados com a origem informada. A origem informada é inválida.
type_certificateIntTipo do certificadoNão existem certificados com o tipo informado. O tipo de certificado informado é inválido.
type_domainStringTipo do domínio do certificadoNão existem certificados com o tipo do domínio informado. O tipo do domínio do certificado informado é inválido.
organizationIntCódigo e nome da organização informadoNão existem certificados com o código da organização informado. O código da organização informado é inválido.
common_nameStringNome comum do certificadoNão existem certificados com o nome comum informado.
encryption_key_sizeIntTamanho da chave de criptografia do certificadoNão existem certificados com o tamanho da chave de criptografia informado. O tamanho da chave de criptografia informado é inválido.
algorithm_certifiedStringAlgoritmo de assinatura do certificadoNão existem certificados com o algoritmo de assinatura informado. O algoritmo de assinatura informado é inválido.
validityIntTempo de validade do certificadoNão existem certificados com o tempo de validade informado. O tempo de validade do certificado informado é inválido.
password_keyStringSenha da chave do certificado.Não existem certificados com a senha da chave informada. A senha da chave do certificado informada é inválida.
password_revocationStringSenha de revogação do certificado.Não existem certificados com a senha de revogação informada. A senha de revogação do certificado informada é inválida.
environmentsStringAmbientes do certificadoNão existem certificados com o(s) ambiente(s) informado(s).
systemsStringSistemas do certificadoNão existem certificados com o(s) sistema(s) informado(s).
projectStringProjeto do certificadoNão existem certificados com o projeto informado.
ip_externalStringIP externo do certificadoNão existem certificados com o IP externo informado.
ip_hostnameStringIP ou hostname do certificadoNão existem certificados com o IP ou hostname informado.
self_signedIntInformação se o certificado é auto-assinadoNão existem certificados para este valor de auto-assinado informado. O valor para auto-assinado informado é inválido.
caIntCódigo e nome da CA informadoNão existem certificados com o código da CA informado.O código da CA informado é inválido.
responsibleIntCódigo e nome do responsável informadoNão existem certificados com o código de responsável informado.O código do responsável informado é inválido.
descriptionStringDescrição do certificado
publish_infoArrayInformações adicionais para publicação
deviceArrayCódigo dos dispositivos atrelados ao certificado

Funcionalidades

O webservice de integração senhasegura possui algumas funcionalidades para realizar operações na aplicação.

Publicar Certificado

POST https://vault_url/iso/cert/publish 

A funcionalidade Publicar Certificado solicita a publicação de um certificado em um ou mais dispositivos

Parâmetros

CampoTipoDescriçãoObrigatório
code_certificateIntCódigo do certificado a ser publicado.Sim
code_profile_publicationIntCódigo do perfil de publicação. Será utilizado um perfil de publicação previamente cadastrado no senhasegura .Sim
justificationStringJustificativa da publicação com até 1024 caracteres.Não
reasonIntCódigo do motivo da publicação. Deverá informar um código de um motivo cadastrado no senhasegura .Sim
itms_codeStringcaracteres para determinar o código do ITSM. Obrigatório caso no grupo de acesso do certificado o parâmetro "Código de governança obrigatório ao justificar" esteja habilitado. Realizar as validações no ITSM da mesma forma que é feito na interface web.Condicional
devicesArrayArray com os códigos dos dispositivos onde o certificado deverá ser publicadoSim

Resposta para certificados

Se a funcionalidade for executado com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoCódigo de certificado inválido.
errorBooleanfalsetrue
code_publishingIntCódigo do agendamento da publicação
reasonIntCódigo e nome do motivo da publicaçãoO código do motivo informado é inválido.
itms_codeStringCódigo da GMUD informado.Informe o código da GMUD. Código de GMUD não existe no sistema de ITSM integrado ao senhasegura . O código deve ter no máximo 30 caracteres.
devicesArrayCódigos de dispositivos para publicação

Consultar/Listar Publicações

GET https://vault_url/iso/cert/publish/\[code_request\] 

A funcionalidade Consultar/Listar Publicações consulta uma ou mais publicações no senhasegura .

Parâmetros

CampoTipoDescriçãoObrig.
code_publicationIntCódigo da publicação.Não
code_certifiedIntCódigo do certificado a ser Publicado.Não
code_profile_publicationIntCódigo do perfil de publicação.Não
creation_dateStringData de cadastro da publicaçãoNão
processedIntStatus do processamento da publicação. As opções serão: 1 = Sim; 0 = NãoNão
errorIntStatus de erro da publicação. As opções serão: 1 = Sim; 0 = NãoNão
reasonIntCódigo do motivo da publicação.Não
itms_codeStringTexto da GMUD informada.Não
deviceIntCódigo do dispositivo da publicação.Não
offsetIntNúmero base da contagem de registros pela paginação.Não
limitIntNúmero de registros na paginação.Não

Resposta para certificados

Se a funcionalidade for executado com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível encontrar publicações com as informações fornecidas.
errorBooleanfalsetrue
code_publishingIntCódigo do agendamento da publicaçãoNão existe uma publicação com o código informado. O código da publicação informado é inválido.
reasonIntCódigo e nome do motivo da publicaçãoO código do motivo informado é inválido.
itms_codeStringCódigo da GMUD informadoInforme o código da GMUD. Código de GMUD não existe no sistema de ITSM integrado ao senhasegura . O código deve ter no máximo 30 caracteres.
code_credentialIntCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameStringUsername para busca de credenciais
quantity_devicesIntQuantidade de dispositivos da publicação

Criar/Editar Perfil de Publicação Apache

POST https://vault_url/iso/cert/profile/apache 

A funcionalidade Criar/Editar Perfil de Publicação Apache cria ou edita um perfil de publicação do plugin Apache.

Parâmetros

CampoTipoDescriçãoObrig.
code_profileIntCódigo de um perfil já criado. Caso o código não seja passado, o sistema interpretará como a criação de um perfil.Não
name_profileStringNome do perfil a ser criado.Sim
siteStringSite onde o certificado deverá ser instalado. Se não for informado, o certificado será instalado no site padrão do Apache.Não
config_pathStringEndereço da configuração. Padrão: /etc/apache2/sites-available/default.com.confNão
portIntPorta.Padrão: 443
code_credentialIntCódigo da credencial a ser utilizada na publicação. Será utilizada uma credencial previamente cadastrada o cofre. Esta informação será obrigatória caso não seja informado um username.Condicional
usernameStringUsername que será utilizado para localizar credenciais para a publicação. Esta informação será obrigatória caso não seja informado um codigo_credencialCondicional
devicesArrayArray com os códigos dos dispositivos onde o certificado deverá ser publicadoSim

Resposta para certificados

Se a funcionalidade for executada com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível criar o perfil.
errorBooleanfalsetrue
code_requestIntCódigo do perfil de publicaçãoO código do perfil informado é inválido.
name_profileStringNome do perfil.
siteStringSite informado
config_pathStringEndereço da configuração
portIntPorta
code_credentialIntCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameStringUsername para busca de credenciais
devicesArrayCódigos de dispositivos para publicação

Criar/Editar Perfil de Publicação IIS

POST https://vault_url/iso/cert/profile/iis 

A funcionalidade Criar/Editar Perfil de Publicação IIS cria ou edita um perfil de publicação do plugin IIS.

Parâmetros

CampoTipoDescriçãoObrig.
code_profileIntCódigo de um perfil já criado. Caso o código não seja passado, o sistema interpretará como a criação de um perfil.Não
name_profileStringNome do perfil a ser criado.Sim
siteStringSite onde o certificado deverá ser instalado. Se não for informado, o certificado será instalado no site padrão do IIS.Não
cert_storeStringRepositório de gerenciamento de certificados do IIS. Padrão: MYNão
portIntPorta. Padrão: 443Não
code_credentialIntCódigo da credencial a ser utilizada na publicação. Será utilizada uma credencial previamente cadastrada o cofre. Esta informação será obrigatória caso não seja informado um username.Condicional
usernameStringUsername que será utilizado para localizar credenciais para a publicação. Esta informação será obrigatória caso não seja informado um codigo_credencial.Condicional
devicesArrayArray com os códigos dos dispositivos onde o certificado deverá ser publicado. Os dispositivos devem existir no senhaseguraSim

Resposta para certificados

Se a funcionalidade for executada com sucesso, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível criar o perfil.
errorBooleanfalsetrue
code_profileIntCódigo do perfil de publicaçãoO código do perfil informado é inválido.
name_profileStringNome do perfil
siteStringSite informado
cert_storeStringRepositório de gerenciamento de certificados do IIS
portIntPorta
code_credentialIntCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameStringUsername para busca de credenciais
devicesArrayCódigos de dispositivos para publicação

Criar/Editar Perfil de Publicação F5 BigIP

POST https://vault_url/iso/cert/profile/bigip 

A funcionalidade Criar/Editar Perfil de Publicação F5 BigIP cria ou edita um perfil de publicação do plugin F5 BigIP.

Parâmetros

CampoTipoDescriçãoObrig.
code_profileIntCódigo de um perfil já criado. Caso o código não seja passado, o sistema interpretará como a criação de um perfil.Não
name_profileStringNome do perfil a ser criado.Sim
name_partitionStringNome da partição.Não
name_certStringNome do certificado. Se já existir um certificado com o mesmo nome configurado, na publicação ele será substituído.Não
profile_client_vipsArrayArray de Perfis SSL Client e seus VIPsNão
profile_server_vipsArrayArray de Perfis SSL Server e seus VIPs.Não
code_credentialIntCódigo da credencial a ser utilizada na publicação. Será utilizada uma credencial previamente cadastrada o cofre. Esta informação será obrigatória caso não seja informado um username.Condicional
usernameStringUsername que será utilizado para localizar credenciais para a publicação. Esta informação será obrigatória caso não seja informado um codigo_credencial.Condicional
devicesArrayArray com os códigos dos dispositivos onde o certificado deverá ser publicadoSim

Resposta para certificados

Se a funcionalidade for executada com sucesso, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível criar o perfil.
errorBooleanfalsetrue
code_profileIntCódigo do perfil de publicaçãoO código do perfil informado é inválido.
name_profileStringNome do perfil
name_partitionStringNome da partição
name_certificateTextoNome do certificado que será exibido na aplicação web
profile_clientArrayNome completo do perfil.
profile_serverArrayNome completo do perfil.
code_credentialIntCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameStringUsername para busca de credenciais
devicesArrayCódigos de dispositivos para publicação

Criar/Editar Perfil de Publicação WebSphere WAS

POST https://vault_url/iso/cert/profile/was

A funcionalidade Criar/Editar Perfil de Publicação WebSphere Was cria ou edita um perfil de publicação do plugin WebSphere WAS.

Parâmetros

CampoTipoDescriçãoObrig.
code_profileIntCódigo de um perfil já criado. Caso o código não seja passado, o sistema interpretará como a criação de um perfil.Não
name_profileStringNome do perfil a ser criado.Sim
key_db_pathStringEndereço e nome da Key Database.Sim
key_db_passwordStringSenha do servidor.Sim
labelStringLabel do servidor.Sim
code_credentialIntCódigo da credencial a ser utilizada na publicação. Será utilizada uma credencial previamente cadastrada o cofre. Esta informação será obrigatória caso não seja informado um username.Condicional
usernameStringUsername que será utilizado para localizar credenciais para a publicação. Esta informação será obrigatória caso não seja informado um codigo_credencial.**Condicional
devicesArrayArray com os códigos dos dispositivos onde o certificado deverá ser publicado.Sim

Resposta para certificados

Se a funcionalidade for executada com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:

CampoTipoSucessoErro
statusIntOK4xx
messageStringCriadoNão foi possível criar o perfil.
errorBooleanfalsetrue
code_profileIntCódigo do perfil de publicaçãoO código do perfil informado é inválido.
name_profileStringNome do perfil
key_db_pathStringEndereço e nome da Key Database
key_db_passwordStringSenha do servidor
labelTextoLabel do servidor.
code_credentialIntCódigo da credencial para publicação.O código da credencial informado é inválido.

| username | String | Username para busca de credenciais. |
| devices | Array | Códigos de dispositivos para publicação. |

Importar um certificado SSL

Requisição

Para importar um certificado SSL, envie uma requisição para o seguinte endpoint:

PUT api/certificate/upload

Parâmetros de requisição

Body

CampoTipoObrigatórioDescriçãoExemplo
certificateStringSimCódigo de um certificado já criado em senhas.Base64_encoded_certificate_file
private_keyStringNãoCaso este campo esteja vazio, a chave não estará disponível no sistema, limitando o uso do certificado, sua publicação e a possibilidade de vinculá-lo a dispositivos. Nota: A extensão .pfx já inclui uma chave privada. Portanto, mesmo que você não informe seu valor na chamada da API, ainda será possível visualizá-la na resposta..Base64_encoded_private_key_file
passwordStringNãoSenha para recuperar o certificado correspondente.null
revoke_passwordStringNãoSenha para revogar o certificado SSL associado.null
extensionStringSimcertificate_extension

Exemplo de requisição

{
    "certificate": "Base64_encoded_certificate_file",
    "private_key": "Base64_encoded_private_key_file",
    "password": null,
    "revoke_password": null,
    "extension": "certificate_extension",
}

Retorno

Importa um certificado SSL e retorna uma mensagem com informações sobre o processo de importação.

Resposta esperada

HTTP/1.1 200 OK
{
    "response": {
        "status": 200,
        "message": "1001: OK",
        "error": false,
        "error_code": 0,
        "status_certificate": 1,
        "detail": "",
        "mensagem": "1001: OK",
        "erro": false,
        "cod_erro": 0
}

Em caso de erro - certificado não encontrado

HTTP/1.1 400 BAD REQUEST
{
    "response": {
        "status": 400,
        "message": "1049: There is no certificate with the given code",
        "error": false,
        "error_code": 0,
        "status_certificate": 1,
        "detail": "",
        "mensagem": "1049: There is no certificate with the given code",
        "erro": false,
        "cod_erro": 0
},
   
    "exception": {
        "code": 1049,
        "message": "1049: There is no certificate with the given code",
        "detail": null
}

Erros possíves

Aqui está uma lista de códigos de erro HTTP e seus possíveis motivos:

  • 400 Bad Request: missing extension parameter (parâmetro extension ausente).

  • 401 UNAUTHORIZED: token expired (token expirado).

  • 404 Not Found: no token registered for the call (nenhum token registrado para a chamada).

  • 500 Internal Server Error: the certificate already exists (o certificado já existe).

  • 500 Internal Server Error: invalid or empty certificate (certificado inválido ou vazio).

  • 500 Internal Server Error: invalid private key. (private keyinválida).
    .

  • 500 Internal Server Error: empty private key (private key vazia).


Este artigo foi útil?

What's Next