Cria um perímetro na estrutura organizacional.
URL
{RMUrl}/api/organization/perimeters
MÉTODO DE SOLICITAÇÃO
POST
PARÂMETROS DA URL
Essa funcionalidade não possui parâmetros.
CONTEÚDO DO FORMULÁRIO
Name (obrigatório): nome do perímetro que será criado. O limite é de 400 caracteres.
Path (opcional caso exista ParentPerimeter): caminho na estrutura organizacional onde o perímetro será criado. O limite é de 400 caracteres para cada perímetro do caminho.
ParentPerimeter (opcional caso exista Path): ID do perímetro pai do perímetro criado.
Description (opcional): descrição do perímetro que será criado.
AdditionalInformation (opcional): informações adicionais sobre o perímetro que será criado.
Responsible (opcional): pessoa responsável pelo perímetro que será criado.
Latitude (opcional; obrigatório caso o campo "Longitude" esteja preenchido): latitude da localização do perímetro que será criado. Valores válidos: de -90.0 a +90.0. A marcação decimal deve ser representada por um ponto e não por uma vírgula.
Longitude (opcional; obrigatório caso o campo "Latitude" esteja preenchido): longitude da localização do perímetro que será criado. Valores válidos: de -180.0 a +180.0. A marcação decimal deve ser representada por um ponto e não por uma vírgula.
GeolocationDescription (opcional): descrição da localização geográfica do perímetro que será criado. O limite é de 1.000 caracteres.
ZoomLevel (opcional): nível de zoom no mapa da localização do perímetro que será criado. Valores válidos: números inteiros entre 0 e 21.
CustomAttributes (opcional): lista de objetos com informações sobre os atributos de perímetros. Cada atributo é referenciado através do nome da variável. Os atributos do tipo Relacionamento podem ser referenciados pelo campo Id, pelo campo Caption (nome que identifica o objeto) ou pelos dois campos. Caso os dois campos sejam fornecidos, eles devem referenciar o mesmo objeto. É recomendado que, sempre que possível, seja dada preferência ao campo Id. Para obter a lista de formatos dos campos Id e Caption, veja o tópico Apêndice 2: Formato de preenchimento dos atributos.
MappingCriteria
NetbiosName (opcional): utilizado para indicar como deverá ser feito o mapeamento de vulnerabilidades de todos os ativos do perímetro. Nesse caso, por padrão, os nomes NetBIOS identificados por um scanner serão mapeados com ativos através do valor selecionado. Valores válidos: Inherited, Disabled, AssetName, HostAddress ou atributos do tipo Texto criados para ativos tecnológicos.
IPAddress (opcional): utilizado para indicar como deverá ser feito o mapeamento de vulnerabilidades de todos os ativos do perímetro. Nesse caso, por padrão, os endereços IP identificados por um scanner serão mapeados com ativos através do valor selecionado. Valores válidos: Inherited, Disabled, AssetName, HostAddress ou atributos do tipo Texto criados para ativos tecnológicos.
DNSName (opcional): utilizado para indicar como deverá ser feito o mapeamento de vulnerabilidades de todos os ativos do perímetro. Nesse caso, por padrão, os nomes DNS identificados por um scanner serão mapeados com ativos através do valor selecionado. Valores válidos: Inherited, Disabled, AssetName, HostAddress ou atributos do tipo Texto criados para ativos tecnológicos.
EXEMPLOS DO CONTEÚDO DO FORMULÁRIO
Criar um perímetro utilizando o campo Path:
{
"Name":"API 123",
"Path":"API"
}
Criar um perímetro utilizando o campo ParentPerimeter:
"Name":"API 123",
"ParentPerimeter": {
"Id": "bc1f6287-6264-4fd7-8b95-db60fae887a3",
"Caption": "API"
}
Criar um perímetro com todos os campos preenchidos:
{
"Name":"Subdepartamento de Banco de Dados",
"Path":"Departamento de TI",
"Description":"Subdepartamento de Banco de Dados da Empresa Ficticia",
"AdditionalInformation":"Bancos de dados Microsoft",
"Responsible":{"Name":"Alexandre Ferreira"},
"Latitude":-23.761163,
"Longitude":-53.299314,
"GeolocationDescription":"Matriz da empresa",
"ZoomLevel":15,
"MappingCriteria":
{
"DnsName": { "Type": "Disabled" },
"IpAddress": { "Type": "AssetName" },
"NetbiosName": { "Type": "Attribute", "AttributeVariableName": "custom_texto" }
},
"CustomAttributes": {
"atributo_datahora":"\/Date(1320335183486)\/",
"atributo_email":"info@exemplo.com.br",
"atributo_link":"http://www.exemplo.com.br",
"atributo_numero":"999",
"atributo_paragrafo":"Informação importante",
"atributo_texto":"conteudo do atributo",
"atributo_singleselection":"opcaounica",
"atributo_multipleselection":["opcao1","opcao2"],
"atributo_outline":["opcao1","opcao2"],
"atributo_relacionamentomultiplo_grupo":[{"Caption":"Diretoria"},{"Caption":"Informatica"},{"Caption":"Financeiro"},{"Caption":"Recursos Humanos"}]
}
}
Para criar um perímetro na raiz da estrutura organizacional, o campo Path deve ser enviado com conteúdo vazio:
{
"Name":"Departamento de Recursos Humanos",
"Path":"",
"Description":"Departamento de Recursos Humanos da Empresa Ficticia",
"Responsible":{"Name":"José Silva"},
}
}
RESPOSTA DE SUCESSO
O código do novo perímetro criado. Retorna uma string.