Certificate Manager
- 22 minutos de leitura
- Imprimir
- Tema escuroTema claro
- Pdf
Certificate Manager
- 22 minutos de leitura
- Imprimir
- Tema escuroTema claro
- Pdf
Article Summary
Share feedback
Thanks for sharing your feedback!
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://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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_request | Inteiro | Có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_certificado | Inteiro | Tipo do certificado. Os possíveis valores são: 1 = DV SSL - Domain SSL; 2 = OV SSL - Organization SSL; 3 = EV SSL - Extended SSL | Sim |
| tipo_domínio | Texto | Tipo do domínio do certificado. Os possíveis valores são: SING = Single domain; MULT = Multiple domains; WILD = Wildcard | Sim |
| organização | Inteiro | Código da organização. Deverá ser informado o código de uma organização cadastrada no senhasegura . | Sim |
| nome_comum | Texto | Nome comum do certificado. | Sim |
| san | Array | Subject Alternative Name. Será preenchido com o nome_comum caso o san não seja informado. | Não. |
| tags | Array | Tags de identificação do certificado. Será cadastrada novas tags caso as informadas não existam. | Não. |
| criptografia | Texto | Algoritmo de criptografia. Os possíveis valores são: RSA; DSA | Sim |
| tamanho_chave_criptografia | Inteiro | Tamanho da chave de criptografia. Os possíveis valores são: 4096; 2048; 1024 | Sim |
| algoritmo_certificado | Texto | Algoritmo 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 |
| validade | Inteiro | Tempo de validade do certificado, em dias. | Sim |
| senha_chave | Texto | Senha da chave do certificado. | Não |
| senha_revogacao | Texto | Senha de revogação do certificado. | Não |
| ambientes | Array | Ambientes do certificado. Serão cadastrados novos ambientes de certificado caso os informados não existam. | Não |
| sistemas | Array | Sistemas do certificado. Serão cadastrados novos sistemas de certificado caso os informados não existam. | Não |
| projeto | Texto | Projeto do certificado no request. | Não |
| ip_externo | Texto | IP externo do certificado no request. | Não |
| ip_hostname | Texto | IP ou hostname do certificado no request. | Não |
| justificativa | Texto | Justificativa do request com até 1024 caracteres. | Não |
| responsavel | Inteiro | Código do responsável pelo request e pelo certificado. Deverá ser um usuário cadastrado no senhasegura. | Não |
| descricao | Texto | Descriçã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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | inteiro | OK | 4xx |
| messagem | mensagem | Criado | Não foi possível criar o request. |
| erro | Boolean | false | true |
| codigo_request | Inteiro | Código do request. | O código de request informado é inválido |
| tipo_certificado | Inteiro | Tipo do certificado informado. | O tipo de certificado informado é inválido. |
| tipo_domínio | Texto | Tipo do domínio do certificado informado. | O tipo do domínio do certificado informado é inválido. |
| organizacao | Inteiro | Código da organização informado. | O código da organização informado é inválido |
| nome_comum | Texto | Nome comum informado. | O nome comum do certificado não foi informado. |
| san | Array | SAN informado(s). | |
| tags | Array | Tags informadas. | |
| criptografia | Texto | Algoritmo de criptografia informado. | O algoritmo de criptografia informado é inválido. |
| tamanho_chave_criptografia | Inteiro | Tamanho da chave de criptografia informado. | O tamanho da chave de criptografia informado é inválido. |
| algoritmo_certificado | Texto | Algoritmo de assinatura informado. | O algoritmo de assinatura informado é inválido. |
| validade | Inteiro | Tempo de validade do certificado informado. | O tempo de validade do certificado informado é inválido. |
| senha_chave | Texto | Informação sensível. | A senha da chave do certificado informada é inválida. |
| senha_revogacao | Texto | Informação sensível. | A senha da chave do certificado informada é inválida. |
| ambientes | Array | Ambientes informados. | |
| sistemas | Array | Sistemas informados. | |
| projeto | Texto | Projeto informado. | |
| ip_externo | Texto | IP informado. | |
| ip_hostname | Texto | IP ou hostname informado. | |
| justificativa | Texto | Justificativa informada. | A justificativa deve ter no máximo 1024 caracteres. |
| responsável | Inteiro | Código do responsável informado. | O código do responsável informado é inválido. |
| descricao | Texto | Descriçã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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_request | Inteiro | Código de um Request já criado. | Não |
| status_request | Inteiro | Código de um status de um request. | Não |
| tipo_certificado | Inteiro | Tipo do certificado. As opções serão: 1 = DV SSL - Domain SSL; 2 = OV SSL - Organization SSL; 3 = EV SSL - Extended SSL | Não |
| tipo_domínio | Texto | Tipo do domínio do certificado. As opções serão: SING = Single domain; MULT = Multiple domains; WILD = Wildcard | Não |
| organizacao | Inteiro | Código da organização cadastrada no senhasegura. | Não |
| nome_comum | Texto | Nome comum do certificado. | Não |
| san | Texto | Subject Alternative Names, separados por vírgula | Não |
| tags | Texto | Tags de identificação do certificado, separados por vírgula | Não |
| criptografia | Texto | Algoritmo de criptografia. As opções serão: RSA; DSA | Não |
| tamanho_chave_criptografia | Inteiro | Tamanho da chave de criptografia. As opções serão: 4096; 2048; 1024 | Não |
| algoritmo_certificado | Texto | Algoritmo de assinatura As opções serão: SHA256; SHA384; SHA512 | Não |
| validade | Inteiro | Tempo de validade do certificado em dias. | Não |
| senha_chave | Texto | Senha da chave do certificado. | Não |
| senha_revogacao | Texto | Senha de revogação do certificado. | Não |
| ambientes | Texto | Ambientes do certificado, separados por vírgula | Não |
| sistemas | Texto | Sistemas do certificado, separados por vírgula | Não |
| projeto | Texto | Projeto do certificado no request. | Não |
| ip_externo | Texto | IP externo do certificado no request. | Não |
| ip_hostname | Texto | IP ou hostname do certificado no request. | Não |
| responsavel | Inteiro | Código do responsável pelo request e pelo certificado. | Não |
| offset | Inteiro | Número base da contagem de registros pela paginação. | Não |
| limit | Inteiro | Nú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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível encontrar requests com as informações fornecidas |
| erro | Boolean | false | true |
| codigo_request | Inteiro | Código do request. | Não existe um request com o código informado. O código de request informado é inválido. |
| status_request | Inteiro | Código e nome do status do request. | Não existem requests com o status informado. O código de status informado é inválido |
| tipo_certificado | Inteiro | Tipo do certificado informado. | Não existem requests com o tipo do certificado informado. O tipo de certificado informado é inválido. |
| tipo_domínio | Texto | Tipo 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. |
| organizacao | Inteiro | Có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_comum | Texto | Nome comum informado. | Não existem requests com o nome comum informado. |
| san | Array | SAN informado(s). | Não existem requests com o(s) SAN(s) informado(s). |
| tags | Array | Tags informadas. | Não existem requests com a(s) Tag(s) informada(s). |
| criptografia | Texto | Algoritmo de criptografia informado. | Não existem requests com o algoritmo de criptografia informado.O algoritmo de criptografia informado é inválido. |
| tamanho_chave_criptografia | Inteiro | Tamanho 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_certificado | Texto | Algoritmo de assinatura informado. | Não existem requests com o algoritmo de assinatura informado. O algoritmo de assinatura informado é inválido. |
| validade | Inteiro | Tempo 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_chave | Texto | Informação sensível. | Não existem requests com a senha da chave informada. A senha da chave do certificado informada é inválida. |
| senha_revogacao | Texto | Informação sensível. | Não existem requests com a senha de revogação informada. A senha de revogação do certificado informada é inválida. |
| ambientes | Array | Ambientes informados. | Não existem requests com os ambientes informados. |
| sistemas | Array | Sistemas informados. | Não existem requests com os sistemas informados. |
| projeto | Texto | Projeto informado. | Não existem requests com o projeto informado. |
| ip_externo | Texto | IP informado. | Não existem requests com o IP externo informado. |
| ip_hostname | Texto | IP ou hostname informado. | Não existem requests com o IP ou hostname informado. |
| justificativa | Texto | Justificativa informada. | |
| responsavel | Inteiro | Có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. |
| descricao | Texto | Descriçã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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_request | Inteiro | Código do request a ser assinado.. | Sim |
| auto_assinado | Inteiro | Indica se é auto-assinado. As opções serão: 1 = true; 0 = false | Sim |
| ca | Inteiro | Código da CA responsável pela assinatura request. Obrigatório, caso auto_assinado seja falso. | Condicional |
| justificativa | Texto | Texto de até 1024 caracteres para justificativa. | Não |
| motivo | Inteiro | Código do motivo da assinatura. Deverá informar um código de um motivo cadastrado no senhasegura*. | Sim |
| gmud | Texto | Caracteres 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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível assinar o request. |
| erro | Boolean | false | true |
| codigo_request | Inteiro | Código da request. | Informe um código de request. O código da request informado é inválido. |
| auto_assinado | Inteiro | Valor informado. | Não existem requests para este valor de auto-assinado informado. O valor para auto-assinado informado é inválido. |
| ca | Inteiro | Có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 |
| justificativa | Texto | Justificativa informada. | A justificativa deve ter no máximo 1024 caracteres. |
| motivo | Inteiro | Código e nome do motivo informado. | O código do motivo informado é inválido. |
| gmud | Texto | Có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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_certificado | Inteiro | Código de um certificado já criado no senhasegura. | Não |
| status_certificado | Inteiro | Có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 |
| ativo | Inteiro | Estado do certificado no senhasegura. As opções serão: 1 = Ativo; 0 = Inativo | Não |
| inicio_validade | Texto | Data de início da validade. | Não |
| fim_validade | Texto | Data de fim da validade. | Não |
| origem_certificado | Inteiro | Origem do certificado no senhasegura. As opções serão: SCAN = Scan e Discovery; REQU = Request; IMPO = Importado manualmente | Não |
| tipo_certificado | Inteiro | Tipo do certificado. As opções serão: 1 = DV SSL - Domain SSL; 2 = OV SSL - Organization SSL; 3 = EV SSL - Extended SSL | Não |
| tipo_domínio | Texto | Tipo do domínio do certificado. As opções serão: SING = Single domain; MULT = Multiple domains; WILD = Wildcard | Não |
| organizacao | Inteiro | Código da organização. | Não |
| nome_comum | Texto | Nome comum do certificado. | Não |
| san | Texto | Subject Alternative Name. Poderá informar mais de 1 separados por vírgula. | Não |
| tags | Texto | Tags de identificação do certificado. Poderá informar mais de 1 separados por vírgula. | Não |
| criptografia | Texto | Algoritmo de criptografia. As opções serão: RSA; DSA | Não |
| tamanho_chave_criptografia | Inteiro | Tamanho da chave de criptografia. As opções serão: 4096; 2048; 1024 | Não |
| algoritmo_certificado | Texto | Algoritmo de assinatura. As opções serão: sha256; sha384; sha512 | Não |
| validade | Inteiro | Tempo de validade do certificado em quantidade de dias. | Não |
| senha_chave | Texto | Senha da chave do certificado. | Não |
| senha_revogacao | Texto | Senha de revogação do certificado. | Não |
| ambientes | Texto | Ambientes do certificado. Poderá informar mais de 1 separados por vírgula. | Não |
| sistemas | Texto | Sistemas do certificado. Poderá informar mais de 1 separados por vírgula.** | Não |
| projeto | Texto | Projeto do certificado no request. | Não |
| ip_externo | Texto | IP externo do certificado no request. | Não |
| ip_hostname | Texto | IP ou hostname do certificado no request. | Não |
| auto_assinado | Inteiro | Indica se é auto-assinado. As opções serão: 1 = true; 0 = false | Não |
| ca | Inteiro | Código da CA responsável pela assinatura request. | Não |
| responsável | Inteiro | Código do responsável pelo request e pelo certificado. | Não |
| offset | Inteiro | Número base da contagem de registros pela paginação. | Não |
| limit | Inteiro | Nú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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível encontrar certificados com as informações fornecidas. |
| erro | Boolean | false | true |
| codigo_certificado | Inteiro | Código da request. | Não existe um certificado com o código informado. O código do certificado informado é inválido. |
| status_certificado | Inteiro | Código e nome do status do certificado. | Não existem certificados com o status informado. O código de status informado é inválido. |
| ativo | Inteiro | Có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_validade | Texto | Data 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_validade | Texto | Data 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_certificado | Inteiro | Origem do certificado no senhasegura. | Não existem certificados com a origem informada. A origem informada é inválida. |
| tipo_certificado | Inteiro | Tipo do certificado | Não existem certificados com o tipo informado. O tipo de certificado informado é inválido. |
| tipo_domínio | Texto | Tipo do domínio do certificado | Não existem certificados com o tipo do domínio informado. O tipo do domínio do certificado informado é inválido. |
| organizacao | Inteiro | Código e nome da organização informado | Não existem certificados com o código da organização informado. O código da organização informado é inválido. |
| nome_comum | Texto | Nome comum do certificado | Não existem certificados com o nome comum informado. |
| san | Texto | SAN do certificado | Não existem certificados com o(s) SAN(s) informado(s). |
| tags | Texto | Tags do certificado | Não existem certificados com a(s) Tag(s) informada(s). |
| criptografia | Texto | Algoritmo de criptografia do certificado | Não existem certificados com o algoritmo de criptografia informado.O algoritmo de criptografia informado é inválido. |
| tamanho_chave_criptografia | Inteiro | Tamanho da chave de criptografia do certificado | Não existem certificados com o tamanho da chave de criptografia informado. O tamanho da chave de criptografia informado é inválido. |
| algoritmo_certificado | Texto | Algoritmo de assinatura do certificado | Não existem certificados com o algoritmo de assinatura informado. O algoritmo de assinatura informado é inválido. |
| validade | Inteiro | Tempo de validade do certificado | Não existem certificados com o tempo de validade informado. O tempo de validade do certificado informado é inválido. |
| senha_chave | Texto | Senha da chave do certificado. | Não existem certificados com a senha da chave informada. A senha da chave do certificado informada é inválida. |
| senha_revogacao | Texto | Senha 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. |
| ambientes | Texto | Ambientes do certificado | Não existem certificados com o(s) ambiente(s) informado(s). |
| sistemas | Texto | Sistemas do certificado | Não existem certificados com o(s) sistema(s) informado(s). |
| projeto | Texto | Projeto do certificado | Não existem certificados com o projeto informado. |
| ip_externo | Texto | IP externo do certificado | Não existem certificados com o IP externo informado. |
| ip_hostname | Texto | IP ou hostname do certificado | Não existem certificados com o IP ou hostname informado. |
| auto_assinado | Inteiro | Informação se o certificado é auto-assinado | Não existem certificados para este valor de auto-assinado informado. O valor para auto-assinado informado é inválido. |
| ca | Inteiro | Código e nome da CA informado | Não existem certificados com o código da CA informado.O código da CA informado é inválido. |
| responsavel | Inteiro | Código e nome do responsável informado | Não existem certificados com o código de responsável informado.O código do responsável informado é inválido. |
| descricao | Texto | Descrição do certificado | |
| informacoes_publicacao | Array | Informações adicionais para publicação | |
| dispositivos | Array | Có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
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| codigo_certificado | Inteiro | Código do certificado a ser publicado. | Sim |
| codigo_perfil_publicacao | Inteiro | Código do perfil de publicação. Será utilizado um perfil de publicação previamente cadastrado no senhasegura . | Sim |
| justificativa | Texto | Justificativa da publicação com até 1024 caracteres. | Não |
| motivo | Inteiro | Código do motivo da publicação. Deverá informar um código de um motivo cadastrado no senhasegura . | Sim |
| gmud | Texto | caracteres 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 |
| dispositivos | Array | Array com os códigos dos dispositivos onde o certificado deverá ser publicado | Sim |
Resposta para certificados
Se a funcionalidade for executado com sucesso ou erro, a resposta consiste em um bloco certificado com os campos:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Código de certificado inválido. |
| erro | Boolean | false | true |
| codigo_publicação | Inteiro | Código do agendamento da publicação | |
| motivo | Inteiro | Código e nome do motivo da publicação | O código do motivo informado é inválido. |
| gmud | Texto | Có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. |
| dispositivos | Array | Có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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_publicacao | Inteiro | Código da publicação. | Não |
| codigo_certificado | Inteiro | Código do certificado a ser Publicado. | Não |
| codigo_perfil_publicacao | Inteiro | Código do perfil de publicação. | Não |
| data_criacao | Texto | Data de cadastro da publicação | Não |
| processado | Inteiro | Status do processamento da publicação. As opções serão: 1 = Sim; 0 = Não | Não |
| erro | Inteiro | Status de erro da publicação. As opções serão: 1 = Sim; 0 = Não | Não |
| motivo | Inteiro | Código do motivo da publicação. | Não |
| gmud | Texto | Texto da GMUD informada. | Não |
| dispositivo | Inteiro | Código do dispositivo da publicação. | Não |
| offset | Inteiro | Número base da contagem de registros pela paginação. | Não |
| limit | Inteiro | Nú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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível encontrar publicações com as informações fornecidas. |
| erro | Boolean | false | true |
| codigo_publicação | Inteiro | Código do agendamento da publicação | Não existe uma publicação com o código informado. O código da publicação informado é inválido. |
| processado | Inteiro | Status do processamento da publicação | |
| erro | Inteiro | Status de erro da publicação | |
| motivo | Inteiro | Código e nome do motivo da publicação | O código do motivo informado é inválido. |
| gmud | Texto | Có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. |
| codigo_credencial | Inteiro | Código da credencial para publicação | O código da credencial informado é inválido. |
| username | Texto | Username para busca de credenciais | |
| qtd_dispostivos | Inteiro | Quantidade de dispositivos da publicação | |
| dispositivos | Array | Có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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_perfil | Inteiro | Có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_perfil | Texto | Nome do perfil a ser criado. | Sim |
| site | Texto | Site onde o certificado deverá ser instalado. Se não for informado, o certificado será instalado no site padrão do Apache. | Não |
| config_path | Texto | Endereço da configuração. Padrão: /etc/apache2/sites-available/default.com.conf | Não |
| porta | Inteiro | Porta. | |
| Padrão: 443 | Não | ||
| codigo_credencial | Inteiro | Có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 |
| username | Texto | Username 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 |
| dispositivos | Array | Array 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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível criar o perfil. |
| erro | Boolean | false | true |
| codigo_perfil | Inteiro | Código do perfil de publicação | O código do perfil informado é inválido. |
| nome_perfil | Texto | Nome do perfil. | |
| site | Texto | Site informado | |
| config_path | Texto | Endereço da configuração | |
| porta | Inteiro | Porta | |
| codigo_credencial | Inteiro | Código da credencial para publicação | O código da credencial informado é inválido. |
| username | Texto | Username para busca de credenciais | |
| dispositivos | Array | Có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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_perfil | Inteiro | Có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_perfil | Texto | Nome do perfil a ser criado. | Sim |
| site | Texto | Site onde o certificado deverá ser instalado. Se não for informado, o certificado será instalado no site padrão do IIS. | Não |
| cert_store | Texto | Repositório de gerenciamento de certificados do IIS. Padrão: MY | Não |
| porta | Inteiro | Porta. Padrão: 443 | Não |
| codigo_credencial | Inteiro | Có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 |
| username | Texto | Username 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 |
| dispositivos | Array | Array com os códigos dos dispositivos onde o certificado deverá ser publicado. Os dispositivos devem existir no senhasegura | Sim |
Resposta para certificados
Se a funcionalidade for executada com sucesso, a resposta consiste em um bloco certificado com os campos:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível criar o perfil. |
| erro | Boolean | false | true |
| codigo_perfil | Inteiro | Código do perfil de publicação | O código do perfil informado é inválido. |
| nome_perfil | Texto | Nome do perfil | |
| site | Texto | Site informado | |
| cert_store | Texto | Repositório de gerenciamento de certificados do IIS | |
| porta | Inteiro | Porta | |
| codigo_credencial | Inteiro | Código da credencial para publicação | O código da credencial informado é inválido. |
| username | Texto | Username para busca de credenciais | |
| dispositivos | Array | Có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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_perfil | Inteiro | Có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_perfil | Texto | Nome do perfil a ser criado. | Sim |
| nome_particao | Texto | Nome da partição. | Não |
| nome_certificado | Texto | Nome do certificado. Se já existir um certificado com o mesmo nome configurado, na publicação ele será substituído. | Não |
| perfis_client_vips | Array | Array de Perfis SSL Client e seus VIPs | Não |
| perfis_server_vips | Array | Array de Perfis SSL Server e seus VIPs. | Não |
| codigo_credencial | Inteiro | Có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 |
| username | Texto | Username 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 |
| dispositivos | Array | Array com os códigos dos dispositivos onde o certificado deverá ser publicado | Sim |
Resposta para certificados
Se a funcionalidade for executada com sucesso, a resposta consiste em um bloco certificado com os campos:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível criar o perfil. |
| erro | Boolean | false | true |
| codigo_perfil | Inteiro | Código do perfil de publicação | O código do perfil informado é inválido. |
| nome_perfil | Texto | Nome do perfil | |
| nome_particao | Texto | Nome da partição | |
| nome_certificado | Texto | Nome do certificado que será exibido na aplicação web | |
| perfis_client | Array | Nome completo do perfil. | |
| perfis_server | Array | Nome completo do perfil. | |
| codigo_credencial | Inteiro | Código da credencial para publicação | O código da credencial informado é inválido. |
| username | Texto | Username para busca de credenciais | |
| dispositivos | Array | Có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
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigo_perfil | Inteiro | Có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_perfil | Texto | Nome do perfil a ser criado. | Sim |
| key_db_path | Texto | Endereço e nome da Key Database. | Sim |
| key_db_password | Texto | Senha do servidor. | Sim |
| label | Texto | Label do servidor. | Sim |
| codigo_credencial | Inteiro | Có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 |
| username | Texto | Username 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 |
| dispositivos | Array | Array 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:
| Campo | Tipo | Sucesso | Erro |
|---|---|---|---|
| status | Inteiro | OK | 4xx |
| messagem | Texto | Criado | Não foi possível criar o perfil. |
| erro | Boolean | false | true |
| codigo_perfil | Inteiro | Código do perfil de publicação | O código do perfil informado é inválido. |
| nome_perfil | Texto | Nome do perfil | |
| key_db_path | Texto | Endereço e nome da Key Database | |
| key_db_password | Texto | Senha do servidor | |
| label | Texto | Label do servidor. | |
| codigo_credencial | Inteiro | Código da credencial para publicação. | O código da credencial informado é inválido. |
| username | Texto | Username para busca de credenciais. | |
| dispositivos | Array | Códigos de dispositivos para publicação. |
Este artigo foi útil?
