Pular para o conteúdo principal
Version: 3.24

Certificate Management - Integração

caution

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

Introdução

O senhasegura Certificate Management 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 Management como administradores, e explicar sobre detalhes de uso, benefícios e procedimentos.

Como o Certificate Management funciona

O senhasegura Certificate Management 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 Management 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 Management.

Métodos

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

Criar/Modificar Request

POST https://url_do_cofre/iso/certificado/request/\[codigo_request\] 

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

Parâmetros

CampoTipoDescriçãoObrig.
codigo_requestInteiroCó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
tipo_certificadoInteiroTipo do certificado. Os possíveis valores são: 1 = DV SSL - Domain SSL;
2 = OV SSL - Organization SSL;
3 = EV SSL - Extended SSLSim
tipo_domínioTextoTipo do domínio do certificado. Os possíveis valores são:
SING = Single domain
MULT = Multiple domains
WILD = WildcardSim
organizaçãoInteiroCódigo da organização. Deverá ser informado o código de uma organização cadastrada no senhasegura .Sim
nome_comumTextoNome 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
criptografiaTextoAlgoritmo de criptografia. Os possíveis valores são:
RSA
DSASim
tamanho_chave_criptografiaInteiroTamanho da chave de criptografia. Os possíveis valores são:
4096
2048
1024Sim
algoritmo_certificadoTextoAlgoritmo 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
validadeInteiroTempo de validade do certificado, em dias.Sim
senha_chaveTextoSenha da chave do certificado.Não
senha_revogacaoTextoSenha de revogação do certificado.Não
ambientesArrayAmbientes do certificado.
Serão cadastrados novos ambientes de certificado caso os informados não existam.Não
sistemasArraySistemas do certificado.
Serão cadastrados novos sistemas de certificado caso os informados não existam.Não
projetoTextoProjeto do certificado no request.Não
ip_externoTextoIP externo do certificado no request.Não
ip_hostnameTextoIP ou hostname do certificado no request.Não
justificativaTextoJustificativa do request com até 1024 caracteres.Não
responsavelInteiroCódigo do responsável pelo request e pelo certificado.
Deverá ser um usuário cadastrado no senhasegura .Não
descricaoTextoDescriçã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
statusInteiro, para a criação de certificados
200, para a edição de certificados4xx
messagemTextoCreated, para a criação de certificados
OK, para a edição de certificadosNão foi possível criar o request.
erroBooleanfalsetrue
codigo_requestInteiroCódigo do request.O código de request informado é inválido
tipo_certificadoInteiroTipo do certificado informado.O tipo de certificado informado é inválido.
tipo_domínioTextoTipo do domínio do certificado informado.O tipo do domínio do certificado informado é inválido.
organizacaoInteiroCódigo da organização informado.O código da organização informado é inválido
nome_comumTextoNome comum informado.O nome comum do certificado não foi informado.
sanArraySAN informado(s).N/A
tagsArrayTags informadas.N/A
criptografiaTextoAlgoritmo de criptografia informado.O algoritmo de criptografia informado é inválido.
tamanho_chave_criptografiaInteiroTamanho da chave de criptografia informado.O tamanho da chave de criptografia informado é inválido.
algoritmo_certificadoTextoAlgoritmo de assinatura informado.O algoritmo de assinatura informado é inválido.
validadeInteiroTempo de validade do certificado informado.O tempo de validade do certificado informado é inválido.
senha_chaveTextoInformação sensível.A senha da chave do certificado informada é inválida.
senha_revogacaoTextoInformação sensível.A senha da chave do certificado informada é inválida.
ambientesArrayAmbientes informados.N/A
sistemasArraySistemas informados.N/A
projetoTextoProjeto informado.N/A
ip_externoTextoIP informado.N/A
ip_hostnameTextoIP ou hostname informado.N/A
justificativaTextoJustificativa informada.A justificativa deve ter no máximo 1024 caracteres.
responsavelInteiroCódigo do responsável informado.O código do responsável informado é inválido.
descricaoTextoDescrição informada.A descrição deve ter no máximo 512 caracteres.

Consultar/Listar Request

GET https://url_do_cofre/iso/certificado/request/listar/\[codigo_request\] 

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

Parâmetros

CampoTipoDescriçãoObrig.
codigo_requestInteiroCódigo de um Request já criado.Não
status_requestInteiroCódigo de um status de um request.Não
tipo_certificadoInteiroTipo do certificado. As opções serão:
1 = DV SSL - Domain SSL
2 = OV SSL - Organization SSL
3 = EV SSL - Extended SSLNão
tipo_domínioTextoTipo do domínio do certificado. As opções serão:
SING = Single domain
MULT = Multiple domains
WILD = WildcardNão
organizacaoInteiroCódigo da organização cadastrada no senhasegura .Não
nome_comumTextoNome comum do certificado.Não
sanTextoSubject Alternative Names, separados por vírgulaNão
tagsTextoTags de identificação do certificado, separados por vírgulaNão
criptografiaTextoAlgoritmo de criptografia. As opções serão:
RSA
DSANão
tamanho_chave_criptografiaInteiroTamanho da chave de criptografia. As opções serão:
4096
2048
1024Não
algoritmo_certificadoTextoAlgoritmo de assinatura As opções serão:
SHA256
SHA384
SHA512Não
validadeInteiroTempo de validade do certificado em dias.Não
senha_chaveTextoSenha da chave do certificado.Não
senha_revogacaoTextoSenha de revogação do certificado.Não
ambientesTextoAmbientes do certificado, separados por vírgulaNão
sistemasTextoSistemas do certificado, separados por vírgulaNão
projetoTextoProjeto do certificado no request.Não
ip_externoTextoIP externo do certificado no request.Não
ip_hostnameTextoIP ou hostname do certificado no request.Não
responsavelInteiroCódigo do responsável pelo request e pelo certificado.Não
offsetInteiroNúmero base da contagem de registros pela paginação.Não
limitInteiroNú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
statusInteiro4xx
messagemTextoOKNão foi possível encontrar requests com as informações fornecidas
erroBooleanfalsetrue
codigo_requestInteiroCódigo do request.Não existe um request com o código informado.O código de request informado é inválido.
status_requestInteiroCódigo e nome do status do request.Não existem requests com o status informado.O código de status informado é inválido
tipo_certificadoInteiroTipo do certificado informado.Não existem requests com o tipo do certificado informado.O tipo de certificado informado é inválido.
tipo_domínioTextoTipo do domínio do certificado informado.Não existem requests com o tipo do domínio informado.O tipo do domínio do certificado informado é inválido.
organizacaoInteiroCódigo da organização informado.Não existem requests com o código da organização informado.O código da organização informado é inválido.
nome_comumTextoNome comum informado.Não existem requests com o nome comum informado.
sanArraySAN informado(s).Não existem requests com o(s) SAN(s) informado(s).
tagsArrayTags informadas.Não existem requests com a(s) Tag(s) informada(s).
criptografiaTextoAlgoritmo de criptografia informado.Não existem requests com o algoritmo de criptografia informado.O algoritmo de criptografia informado é inválido.
tamanho_chave_criptografiaInteiroTamanho da chave de criptografia informado.Não existem requests com o tamanho da chave de criptografia informado. O tamanho da chave de criptografia informado é inválido.
algoritmo_certificadoTextoAlgoritmo de assinatura informado.
Não existem requests com o algoritmo de assinatura informado. O algoritmo de assinatura informado é inválido.
validadeInteiroTempo de validade do certificado informado.Não existem requests com o tempo de validade informado. O tempo de validade do certificado informado é inválido.
senha_chaveTextoInformação sensível.Não existem requests com a senha da chave informada. A senha da chave do certificado informada é inválida.
senha_revogacaoTextoInformação sensível.Não existem requests com a senha de revogação informada. A senha de revogação do certificado informada é inválida.
ambientesArrayAmbientes informados.Não existem requests com os ambientes informados.
sistemasArraySistemas informados.Não existem requests com os sistemas informados.
projetoTextoProjeto informado.Não existem requests com o projeto informado.
ip_externoTextoIP informado.Não existem requests com o IP externo informado.
ip_hostnameTextoIP ou hostname informado.Não existem requests com o IP ou hostname informado.
justificativaTextoJustificativa informada.
responsavelInteiroCódigo e nome do responsável informado.Não existem requests com o código de responsável informado. O código do responsável informado é inválido.
descricaoTextoDescrição informada.

Assinar Request

GET https://url_do_cofre/iso/certificado/request/assinar/\[codigo_request\] 

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

Parâmetros

CampoTipoDescriçãoObrigatório
codigo_requestInteiroCódigo do request a ser assinado..Sim
auto_assinadoInteiroIndica se é auto-assinado.
As opções serão:
1 = true
0 = falseSim
caInteiroCódigo da CA responsável pela assinatura request.
Obrigatório, caso auto_assinado seja false.Condicional
justificativaTextoTexto de até 1024 caracteres para justificativa.Não
motivoInteiroCódigo do motivo da assinatura.
Deverá informar um código de um motivo cadastrado no senhaseguraSim
gmudTextocaracteres 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
statusInteiro4xx
messagemTextoOKNão foi possível assinar o request.
erroBooleanfalsetrue
codigo_requestInteiroCódigo da request.Informe um código de request. O código da request informado é inválido.
auto_assinadoInteiroValor informado.Não existem requests para este valor de auto-assinado informado. O valor para auto-assinado informado é inválido.
caInteiroCó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
justificativaTextoJustificativa informada.A justificativa deve ter no máximo 1024 caracteres.
motivoInteiroCódigo e nome do motivo informado.O código do motivo informado é inválido.
gmudTextoCódigo da GMUD informado.Informe o código da GMUD.

Consultar/Listar Certificados

GET https://url_do_cofre/iso/certificado/listar/\[codigo_certificado\] 

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

Parameters

CampoTipoDescriçãoObrig.
codigo_certificadoInteiroCódigo de um certificado já criado no senhasegura.Não
status_certificadoInteiroCódigo de um status de um certificado.
As opções serão:
1 = Válido
2 = Revogado
3 = Renovação pendente
4 = ExpiradoNão
ativoInteiroEstado do certificado no senhasegura.
As opções serão:
1 = Ativo
0 = InativoNão
inicio_validadeTextoData de início da validade.Não
fim_validadeTextoData de fim da validade.Não
origem_certificadoInteiroOrigem do certificado no senhasegura .
As opções serão:
SCAN = Scan e Discovery
REQU = Request
IMPO = Importado manualmenteNão
tipo_certificadoInteiroTipo do certificado.
As opções serão:
1 = DV SSL - Domain SSL
2 = OV SSL - Organization SSL
3 = EV SSL - Extended SSLNão
tipo_domínioTextoTipo do domínio do certificado. As opções serão:
SING = Single domain
MULT = Multiple domains
WILD = WildcardNão
organizacaoInteiroCódigo da organização.Não
nome_comumTextoNome comum do certificado.Não
sanTextoSubject Alternative Name.
Poderá informar mais de 1 separados por vírgula.Não
tagsTextoTags de identificação do certificado.
Poderá informar mais de 1 separados por vírgula.Não
criptografiaTextoAlgoritmo de criptografia.
As opções serão:
RSA
DSANão
tamanho_chave_criptografiaInteiroTamanho da chave de criptografia.
As opções serão:
4096
2048
1024Não
algoritmo_certificadoTextoAlgoritmo de assinatura
As opções serão:
sha256
sha384
sha512Não
validadeInteiroTempo de validade do certificado em quantidade de dias.Não
senha_chaveTextoSenha da chave do certificado.Não
senha_revogacaoTextoSenha de revogação do certificado.Não
ambientesTextoAmbientes do certificado.
Poderá informar mais de 1 separados por vírgula.Não
sistemasTextoSistemas do certificado.
Poderá informar mais de 1 separados por vírgula.Não
projetoTextoProjeto do certificado no request.Não
ip_externoTextoIP externo do certificado no request.Não
ip_hostnameTextoIP ou hostname do certificado no request.Não
auto_assinadoInteiroIndica se é auto-assinado.
As opções serão:
1 = true
0 = falseNão
caInteiroCódigo da CA responsável pela assinatura request.Não
responsávelInteiroCódigo do responsável pelo request e pelo certificado.Não
offsetInteiroNúmero base da contagem de registros pela paginação.Não
limitInteiroNú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
statusInteiro4xx
messagemTextoOKNão foi possível encontrar certificados com as informações fornecidas.
erroBooleanfalsetrue
codigo_certificadoInteiroCódigo da request.Não existe um certificado com o código informado. O código do certificado informado é inválido.
status_certificadoInteiroCódigo e nome do status do certificado.Não existem certificados com o status informado. O código de status informado é inválido.
ativoInteiroCó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.
inicio_validadeTextoData 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.
fim_validadeTextoData 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.
origem_certificadoInteiroOrigem do certificado no senhasegura.Não existem certificados com a origem informada. A origem informada é inválida.
tipo_certificadoInteiroTipo do certificadoNão existem certificados com o tipo informado. O tipo de certificado informado é inválido.
tipo_domínioTextoTipo 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.
organizacaoInteiroCó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.
nome_comumTextoNome comum do certificadoNão existem certificados com o nome comum informado.
sanTextoSAN do certificadoNão existem certificados com o(s) SAN(s) informado(s).
tagsTextoTags do certificadoNão existem certificados com a(s) Tag(s) informada(s).
criptografiaTextoAlgoritmo de criptografia do certificadoNão existem certificados com o algoritmo de criptografia informado.O algoritmo de criptografia informado é inválido.
tamanho_chave_criptografiaInteiroTamanho 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.
algoritmo_certificadoTextoAlgoritmo de assinatura do certificadoNão existem certificados com o algoritmo de assinatura informado. O algoritmo de assinatura informado é inválido.
validadeInteiroTempo de validade do certificadoNão existem certificados com o tempo de validade informado. O tempo de validade do certificado informado é inválido.
senha_chaveTextoSenha da chave do certificado.Não existem certificados com a senha da chave informada. A senha da chave do certificado informada é inválida.
senha_revogacaoTextoSenha 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.
ambientesTextoAmbientes do certificadoNão existem certificados com o(s) ambiente(s) informado(s).
sistemasTextoSistemas do certificadoNão existem certificados com o(s) sistema(s) informado(s).
projetoTextoProjeto do certificadoNão existem certificados com o projeto informado.
ip_externoTextoIP externo do certificadoNão existem certificados com o IP externo informado.
ip_hostnameTextoIP ou hostname do certificadoNão existem certificados com o IP ou hostname informado.
auto_assinadoInteiroInformação se o certificado é auto-assinadoNão existem certificados para este valor de auto-assinado informado. O valor para auto-assinado informado é inválido.
caInteiroCódigo e nome da CA informadoNão existem certificados com o código da CA informado.O código da CA informado é inválido.
responsavelInteiroCó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.
descricaoTextoDescrição do certificado
informacoes_publicacaoArrayInformações adicionais para publicação
dispositivosArrayCó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://url_do_cofre/iso/cert/publicar/ 

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

Parâmetros

CampoTipoDescriçãoObrigatório
codigo_certificadoInteiroCódigo do certificado a ser publicado.Sim
codigo_perfil_publicacaoInteiroCódigo do perfil de publicação.
Será utilizado um perfil de publicação previamente cadastrado no senhasegura .Sim
justificativaTextoJustificativa da publicação com até 1024 caracteres.Não
motivoInteiroCódigo do motivo da publicação.
Deverá informar um código de um motivo cadastrado no senhasegura .Sim
gmudTextocaracteres 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
dispositivosArrayArray 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
statusInteiro4xx
messagemTextoCreatedCódigo de certificado inválido.
erroBooleanfalsetrue
codigo_publicaçãoInteiroCódigo do agendamento da publicação
motivoInteiroCódigo e nome do motivo da publicaçãoO código do motivo informado é inválido.
gmudTextoCó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.
dispositivosArrayCódigos de dispositivos para publicação

Consultar/Listar Publicações

GET https://url_do_cofre/iso/cert/publicar/listar/\[codigo_publicacao\] 

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

Parâmetros

CampoTipoDescriçãoObrigatório
codigo_publicacaoInteiroCódigo da publicação.Não
codigo_certificadoInteiroCódigo do certificado a ser Publicado.Não
codigo_perfil_publicacaoInteiroCódigo do perfil de publicação.Não
data_criacaoTextoData de cadastro da publicaçãoNão
processadoInteiroStatus do processamento da publicação.
As opções serão:
1 = Sim
0 = NãoNão
erroInteiroStatus de erro da publicação.
As opções serão:
1 = Sim
0 = NãoNão
motivoInteiroCódigo do motivo da publicação.Não
gmudTextoTexto da GMUD informada.Não
dispositivoInteiroCódigo do dispositivo da publicação.Não
offsetInteiroNúmero base da contagem de registros pela paginação.Não
limitInteiroNú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
statusInteiro4xx
messagemTextoOKNão foi possível encontrar publicações com as informações fornecidas.
erroBooleanfalsetrue
codigo_publicaçãoInteiroCó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.
processadoInteiroStatus do processamento da publicação
erroInteiroStatus de erro da publicação
motivoInteiroCódigo e nome do motivo da publicaçãoO código do motivo informado é inválido.
gmudTextoCó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.
codigo_credencialInteiroCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameTextoUsername para busca de credenciais
qtd_dispostivosInteiroQuantidade de dispositivos da publicação
dispositivosArrayCódigos de dispositivos da publicação

Criar/Editar Perfil de Publicação Apache

POST https://url_do_cofre/iso/cert/perfil/apache/ 

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

Parâmetros

CampoTipoDescriçãoObrigatório
codigo_perfilInteiroCó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
nome_perfilTextoNome do perfil a ser criado.Sim
siteTextoSite onde o certificado deverá ser instalado.
Se não for informado, o certificado será instalado no site padrão do Apache.Não
config_pathTextoEndereço da configuração.
Padrão:
/etc/apache2/sites-available/default.com.confNão
portaInteiroPorta.
Padrão: 443Não
codigo_credencialInteiroCó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
usernameTextoUsername que será utilizado para localizar credenciais para a publicação.
Esta informação será obrigatória caso não seja informado um codigo_credencialCondicional
dispositivosArrayArray 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
statusInteiro- Criar
200 - Editar4xx
messagemTextoCreated
OKNão foi possível criar o perfil.
erroBooleanfalsetrue
codigo_perfilInteiroCódigo do perfil de publicaçãoO código do perfil informado é inválido.
nome_perfilTextoNome do perfil.
siteTextoSite informado
config_pathTextoEndereço da configuração
portaInteiroPorta
codigo_credencialInteiroCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameTextoUsername para busca de credenciais
dispositivosArrayCódigos de dispositivos para publicação

Criar/Editar Perfil de Publicação IIS

POST https://url_do_cofre/iso/cert/perfil/iis/ 

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

Parâmetros

CampoTipoDescriçãoObrigatório
codigo_perfilInteiroCó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
nome_perfilTextoNome do perfil a ser criado.Sim
siteTextoSite onde o certificado deverá ser instalado.
Se não for informado, o certificado será instalado no site padrão do IIS.Não
cert_storeTextoRepositório de gerenciamento de certificados do IIS.
Padrão:
MYNão
portaInteiroPorta.
Padrão:
443Não
codigo_credencialInteiroCó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
usernameTextoUsername 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
dispositivosArrayArray 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
statusInteiro- Criar
200 - Editar4xx
messagemTextoCreated
OKNão foi possível criar o perfil.
erroBooleanfalsetrue
codigo_perfilInteiroCódigo do perfil de publicaçãoO código do perfil informado é inválido.
nome_perfilTextoNome do perfil
siteTextoSite informado
cert_storeTextoRepositório de gerenciamento de certificados do IIS
portaInteiroPorta
codigo_credencialInteiroCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameTextoUsername para busca de credenciais
dispositivosArrayCódigos de dispositivos para publicação

Criar/Editar Perfil de Publicação F5 BigIP

POST https://url_do_cofre/iso/cert/perfil/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çãoObrigatório
codigo_perfilInteiroCó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
nome_perfilTextoNome do perfil a ser criado.Sim
nome_particaoTextoNome da partição.Não
nome_certificadoTextoNome do certificado.
Se já existir um certificado com o mesmo nome configurado, na publicação ele será substituído.Não
perfis_client_vipsArrayArray de Perfis SSL Client e seus VIPs
Ex: [ "MEU_CLIENT_1"=>"VIP_1",
"MEU_CLIENT_2"=>"VIP_2" ]No
perfis_server_vipsArrayArray de Perfis SSL Server e seus VIPs.
Ex: [ "MEU_SERVER_1"=>"VIP_1",
"MEU_SERVER_2"=>"VIP_2" ]Não
codigo_credencialInteiroCó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
usernameTextoUsername 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
dispositivosArrayArray 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:

CampoTipoSucessoError
statusInteiro- Criar
200 - Editar4xx
messagemTextoCreated
OKNão foi possível criar o perfil.
erroBooleanfalsetrue
codigo_perfilInteiroCódigo do perfil de publicaçãoO código do perfil informado é inválido.
nome_perfilTextoNome do perfil
nome_particaoTextoNome da partição
nome_certificadoTextoNome do certificado que será exibido na aplicação web
perfis_clientArrayNome completo do perfil. Ex:
[ "MEU_CLIENTE_1"=>"VIP_1",
"MEU_CLIENTE_2"=>"VIP_2"
]
perfis_serverArrayNome completo do perfil. Ex:
[ "MEU_SERVER_1"=>"VIP_1",
"MEU_SERVER_2"=>"VIP_2"
]
codigo_credencialInteiroCódigo da credencial para publicaçãoO código da credencial informado é inválido.
usernameTextoUsername para busca de credenciais
dispositivosArrayCódigos de dispositivos para publicação

Criar/Editar Perfil de Publicação WebSphere WAS

POST https://url_do_cofre/iso/cert/perfil/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çãoObrigatório
codigo_perfilInteiroCó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
nome_perfilTextoNome do perfil a ser criado.Sim
key_db_pathTextoEndereço e nome da Key Database.Sim
key_db_passwordTextoSenha do servidor.Sim
labelTextoLabel do servidor.Sim
codigo_credencialInteiroCó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
usernameTextoUsername 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
dispositivosArrayArray 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
statusInteiro- Criar
200 - Editar4xx
messagemTextoCreated
OKNão foi possível criar o perfil.
erroBooleanfalsetrue
codigo_perfilInteiroCódigo do perfil de publicaçãoO código do perfil informado é inválido.
nome_perfilTextoNome do perfil
key_db_pathTextoEndereço e nome da Key Database
key_db_passwordTextoSenha do servidor
labelTextoLabel do servidor.
codigo_credencialInteiroCódigo da credencial para publicação.O código da credencial informado é inválido.
usernameTextoUsername para busca de credenciais.
dispositivosArrayCódigos de dispositivos para publicação.