Create organization
curl --request POST \
--url https://app.aegister.com/api/v1/organizations \
--header 'Content-Type: application/json' \
--header 'X-Aegister-Token: <api-key>' \
--data '
{
"name": "Sample Organization",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"number_employees": 10,
"website": "https://sample.com",
"logo": "https://sample.com/logo.svg",
"sectors": [],
"industries": [],
"compliance_frameworks": [
{
"value": "ISO 27001:2023",
"fields": {
"extensions": [
"ISO 27017:2021"
]
}
},
{
"value": "NIS2",
"fields": {
"entity_type": "important"
}
}
],
"contacts": [
{
"name": "John Doe",
"role": "Supervisor",
"email": "jdoe@mail.com",
"phone": "3333333333",
"email_report": true
}
],
"domains": [
"sample.com"
],
"ips": [
"11.22.33.44"
]
}
'import requests
url = "https://app.aegister.com/api/v1/organizations"
payload = {
"name": "Sample Organization",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"number_employees": 10,
"website": "https://sample.com",
"logo": "https://sample.com/logo.svg",
"sectors": [],
"industries": [],
"compliance_frameworks": [
{
"value": "ISO 27001:2023",
"fields": { "extensions": ["ISO 27017:2021"] }
},
{
"value": "NIS2",
"fields": { "entity_type": "important" }
}
],
"contacts": [
{
"name": "John Doe",
"role": "Supervisor",
"email": "jdoe@mail.com",
"phone": "3333333333",
"email_report": True
}
],
"domains": ["sample.com"],
"ips": ["11.22.33.44"]
}
headers = {
"X-Aegister-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sample Organization',
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
number_employees: 10,
website: 'https://sample.com',
logo: 'https://sample.com/logo.svg',
sectors: [],
industries: [],
compliance_frameworks: [
{value: 'ISO 27001:2023', fields: {extensions: ['ISO 27017:2021']}},
{value: 'NIS2', fields: {entity_type: 'important'}}
],
contacts: [
{
name: 'John Doe',
role: 'Supervisor',
email: 'jdoe@mail.com',
phone: '3333333333',
email_report: true
}
],
domains: ['sample.com'],
ips: ['11.22.33.44']
})
};
fetch('https://app.aegister.com/api/v1/organizations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.aegister.com/api/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sample Organization',
'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
'number_employees' => 10,
'website' => 'https://sample.com',
'logo' => 'https://sample.com/logo.svg',
'sectors' => [
],
'industries' => [
],
'compliance_frameworks' => [
[
'value' => 'ISO 27001:2023',
'fields' => [
'extensions' => [
'ISO 27017:2021'
]
]
],
[
'value' => 'NIS2',
'fields' => [
'entity_type' => 'important'
]
]
],
'contacts' => [
[
'name' => 'John Doe',
'role' => 'Supervisor',
'email' => 'jdoe@mail.com',
'phone' => '3333333333',
'email_report' => true
]
],
'domains' => [
'sample.com'
],
'ips' => [
'11.22.33.44'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Aegister-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.aegister.com/api/v1/organizations"
payload := strings.NewReader("{\n \"name\": \"Sample Organization\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"number_employees\": 10,\n \"website\": \"https://sample.com\",\n \"logo\": \"https://sample.com/logo.svg\",\n \"sectors\": [],\n \"industries\": [],\n \"compliance_frameworks\": [\n {\n \"value\": \"ISO 27001:2023\",\n \"fields\": {\n \"extensions\": [\n \"ISO 27017:2021\"\n ]\n }\n },\n {\n \"value\": \"NIS2\",\n \"fields\": {\n \"entity_type\": \"important\"\n }\n }\n ],\n \"contacts\": [\n {\n \"name\": \"John Doe\",\n \"role\": \"Supervisor\",\n \"email\": \"jdoe@mail.com\",\n \"phone\": \"3333333333\",\n \"email_report\": true\n }\n ],\n \"domains\": [\n \"sample.com\"\n ],\n \"ips\": [\n \"11.22.33.44\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Aegister-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/organizations")
.header("X-Aegister-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sample Organization\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"number_employees\": 10,\n \"website\": \"https://sample.com\",\n \"logo\": \"https://sample.com/logo.svg\",\n \"sectors\": [],\n \"industries\": [],\n \"compliance_frameworks\": [\n {\n \"value\": \"ISO 27001:2023\",\n \"fields\": {\n \"extensions\": [\n \"ISO 27017:2021\"\n ]\n }\n },\n {\n \"value\": \"NIS2\",\n \"fields\": {\n \"entity_type\": \"important\"\n }\n }\n ],\n \"contacts\": [\n {\n \"name\": \"John Doe\",\n \"role\": \"Supervisor\",\n \"email\": \"jdoe@mail.com\",\n \"phone\": \"3333333333\",\n \"email_report\": true\n }\n ],\n \"domains\": [\n \"sample.com\"\n ],\n \"ips\": [\n \"11.22.33.44\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aegister.com/api/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sample Organization\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"number_employees\": 10,\n \"website\": \"https://sample.com\",\n \"logo\": \"https://sample.com/logo.svg\",\n \"sectors\": [],\n \"industries\": [],\n \"compliance_frameworks\": [\n {\n \"value\": \"ISO 27001:2023\",\n \"fields\": {\n \"extensions\": [\n \"ISO 27017:2021\"\n ]\n }\n },\n {\n \"value\": \"NIS2\",\n \"fields\": {\n \"entity_type\": \"important\"\n }\n }\n ],\n \"contacts\": [\n {\n \"name\": \"John Doe\",\n \"role\": \"Supervisor\",\n \"email\": \"jdoe@mail.com\",\n \"phone\": \"3333333333\",\n \"email_report\": true\n }\n ],\n \"domains\": [\n \"sample.com\"\n ],\n \"ips\": [\n \"11.22.33.44\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": 0,
"messages": [],
"organization": 123
}{
"error": 1,
"messages": [
"Invalid data provided"
]
}Organization
Create organization
Create a new Organization. The current authenticated user becomes the Organization Owner.
POST
/
api
/
v1
/
organizations
Create organization
curl --request POST \
--url https://app.aegister.com/api/v1/organizations \
--header 'Content-Type: application/json' \
--header 'X-Aegister-Token: <api-key>' \
--data '
{
"name": "Sample Organization",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"number_employees": 10,
"website": "https://sample.com",
"logo": "https://sample.com/logo.svg",
"sectors": [],
"industries": [],
"compliance_frameworks": [
{
"value": "ISO 27001:2023",
"fields": {
"extensions": [
"ISO 27017:2021"
]
}
},
{
"value": "NIS2",
"fields": {
"entity_type": "important"
}
}
],
"contacts": [
{
"name": "John Doe",
"role": "Supervisor",
"email": "jdoe@mail.com",
"phone": "3333333333",
"email_report": true
}
],
"domains": [
"sample.com"
],
"ips": [
"11.22.33.44"
]
}
'import requests
url = "https://app.aegister.com/api/v1/organizations"
payload = {
"name": "Sample Organization",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"number_employees": 10,
"website": "https://sample.com",
"logo": "https://sample.com/logo.svg",
"sectors": [],
"industries": [],
"compliance_frameworks": [
{
"value": "ISO 27001:2023",
"fields": { "extensions": ["ISO 27017:2021"] }
},
{
"value": "NIS2",
"fields": { "entity_type": "important" }
}
],
"contacts": [
{
"name": "John Doe",
"role": "Supervisor",
"email": "jdoe@mail.com",
"phone": "3333333333",
"email_report": True
}
],
"domains": ["sample.com"],
"ips": ["11.22.33.44"]
}
headers = {
"X-Aegister-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sample Organization',
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
number_employees: 10,
website: 'https://sample.com',
logo: 'https://sample.com/logo.svg',
sectors: [],
industries: [],
compliance_frameworks: [
{value: 'ISO 27001:2023', fields: {extensions: ['ISO 27017:2021']}},
{value: 'NIS2', fields: {entity_type: 'important'}}
],
contacts: [
{
name: 'John Doe',
role: 'Supervisor',
email: 'jdoe@mail.com',
phone: '3333333333',
email_report: true
}
],
domains: ['sample.com'],
ips: ['11.22.33.44']
})
};
fetch('https://app.aegister.com/api/v1/organizations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.aegister.com/api/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sample Organization',
'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
'number_employees' => 10,
'website' => 'https://sample.com',
'logo' => 'https://sample.com/logo.svg',
'sectors' => [
],
'industries' => [
],
'compliance_frameworks' => [
[
'value' => 'ISO 27001:2023',
'fields' => [
'extensions' => [
'ISO 27017:2021'
]
]
],
[
'value' => 'NIS2',
'fields' => [
'entity_type' => 'important'
]
]
],
'contacts' => [
[
'name' => 'John Doe',
'role' => 'Supervisor',
'email' => 'jdoe@mail.com',
'phone' => '3333333333',
'email_report' => true
]
],
'domains' => [
'sample.com'
],
'ips' => [
'11.22.33.44'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Aegister-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.aegister.com/api/v1/organizations"
payload := strings.NewReader("{\n \"name\": \"Sample Organization\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"number_employees\": 10,\n \"website\": \"https://sample.com\",\n \"logo\": \"https://sample.com/logo.svg\",\n \"sectors\": [],\n \"industries\": [],\n \"compliance_frameworks\": [\n {\n \"value\": \"ISO 27001:2023\",\n \"fields\": {\n \"extensions\": [\n \"ISO 27017:2021\"\n ]\n }\n },\n {\n \"value\": \"NIS2\",\n \"fields\": {\n \"entity_type\": \"important\"\n }\n }\n ],\n \"contacts\": [\n {\n \"name\": \"John Doe\",\n \"role\": \"Supervisor\",\n \"email\": \"jdoe@mail.com\",\n \"phone\": \"3333333333\",\n \"email_report\": true\n }\n ],\n \"domains\": [\n \"sample.com\"\n ],\n \"ips\": [\n \"11.22.33.44\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Aegister-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/organizations")
.header("X-Aegister-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sample Organization\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"number_employees\": 10,\n \"website\": \"https://sample.com\",\n \"logo\": \"https://sample.com/logo.svg\",\n \"sectors\": [],\n \"industries\": [],\n \"compliance_frameworks\": [\n {\n \"value\": \"ISO 27001:2023\",\n \"fields\": {\n \"extensions\": [\n \"ISO 27017:2021\"\n ]\n }\n },\n {\n \"value\": \"NIS2\",\n \"fields\": {\n \"entity_type\": \"important\"\n }\n }\n ],\n \"contacts\": [\n {\n \"name\": \"John Doe\",\n \"role\": \"Supervisor\",\n \"email\": \"jdoe@mail.com\",\n \"phone\": \"3333333333\",\n \"email_report\": true\n }\n ],\n \"domains\": [\n \"sample.com\"\n ],\n \"ips\": [\n \"11.22.33.44\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aegister.com/api/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sample Organization\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"number_employees\": 10,\n \"website\": \"https://sample.com\",\n \"logo\": \"https://sample.com/logo.svg\",\n \"sectors\": [],\n \"industries\": [],\n \"compliance_frameworks\": [\n {\n \"value\": \"ISO 27001:2023\",\n \"fields\": {\n \"extensions\": [\n \"ISO 27017:2021\"\n ]\n }\n },\n {\n \"value\": \"NIS2\",\n \"fields\": {\n \"entity_type\": \"important\"\n }\n }\n ],\n \"contacts\": [\n {\n \"name\": \"John Doe\",\n \"role\": \"Supervisor\",\n \"email\": \"jdoe@mail.com\",\n \"phone\": \"3333333333\",\n \"email_report\": true\n }\n ],\n \"domains\": [\n \"sample.com\"\n ],\n \"ips\": [\n \"11.22.33.44\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": 0,
"messages": [],
"organization": 123
}{
"error": 1,
"messages": [
"Invalid data provided"
]
}Authorizations
ApiKeyAuthApiKeyQueryParam
Body
application/jsonmultipart/form-data
Organization common name.
Examples:
"Sample Organization"
"My Organization"
Organization description
Example:
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."
Organization number of employees
Examples:
10
20
30
Full URL of the Organization website
Examples:
"https://sample.com"
"https://my.organization.com"
Full URL reference to Organization Logo file
Examples:
"https://sample.com/logo.svg"
"https://my.organization.com/logo.png"
Sectors in which the Organization operates.
Available options:
Agriculture, Arts & Entertainment, Business Services, Construction, Consumer Discretionary, Consumer Staples, Cybersecurity & Compliance Services, Education, Energy, Financials, Health Care, Hospitality & Tourism, Information Technology, Manufacturing, Materials, Media, Professional Services, Public Sector, Real Estate, Retail, Science & Technology, Telecommunications, Transportation, Utilities, Wholesale & Distribution Industries in which the Organization operates.
Available options:
Accounting, Airlines/Aviation, Alternative Dispute Resolution, Alternative Medicine, Animation, Apparel/Fashion, Architecture/Planning, Arts/Crafts, Automotive, Aviation/Aerospace, Banking/Mortgage, Biotechnology/Greentech, Broadcast Media, Building Materials, Business / Management Consultancy, Business Supplies/Equipment, Capital Markets/Hedge Fund/Private Equity, Chemicals, Civic/Social Organization, Civil Engineering, Commercial Real Estate, Compliance & Risk Services, Computer Games, Computer Hardware, Computer Networking, Computer Software/Engineering, Computer/Network Security, Construction, Consumer Electronics, Consumer Goods, Consumer Services, Cosmetics, Cybersecurity Services (MSSP/MDR), Dairy, Defense/Space, Design, E-Learning, Education Management, Electrical/Electronic Manufacturing, Entertainment/Movie Production, Environmental Services, Events Services, Executive Office, Facilities Services, Farming, Financial Services, Fine Art, Fishery, Food & Beverage Distribution, Food Production, Food/Beverages, Fundraising, Furniture, Gambling/Casinos, Glass/Ceramics/Concrete, Government Administration, Government Relations, Graphic Design/Web Design, Health/Fitness, Higher Education/Acadamia, Hospital/Health Care, Hospitality, Human Resources/HR, IT Managed Services (MSP), Import/Export, Individual/Family Services, Industrial Automation, Information Services, Information Technology/IT, Insurance, International Affairs, International Trade/Development, Internet, Investment Banking/Venture, Investment Management/Hedge Fund/Private Equity, Judiciary, Law Enforcement, Law Practice/Law Firms, Legal Services, Legislative Office, Leisure/Travel, Library, Logistics/Procurement, Luxury Goods/Jewelry, Machinery, Maritime, Market Research, Marketing/Advertising/Sales, Mechanical or Industrial Engineering, Media Production, Medical Equipment, Medical Practice, Mental Health Care, Military Industry, Mining/Metals, Motion Pictures/Film, Museums/Institutions, Music, Nanotechnology, Newspapers/Journalism, Non-Profit/Volunteering, Oil/Energy/Solar/Greentech, Online Publishing, Other Industry, Outsourcing/Offshoring, Package/Freight Delivery, Packaging/Containers, Paper/Forest Products, Performing Arts, Pharmaceuticals, Philanthropy, Photography, Plastics, Political Organization, Primary/Secondary Education, Printing, Professional Training, Program Development, Public Relations/PR, Public Safety, Publishing Industry, Railroad Manufacture, Ranching, Real Estate/Mortgage, Recreational Facilities/Services, Religious Institutions, Renewables/Environment, Research Industry, Restaurants, Retail Industry, Security/Investigations, Semiconductors, Shipbuilding, Sporting Goods, Sports, Staffing/Recruiting, Supermarkets, Telecommunications, Textiles, Think Tanks, Tobacco, Translation/Localization, Transportation, Utilities, Venture Capital/VC, Veterinary, Warehousing, Wholesale, Wine/Spirits, Wireless, Writing/Editing NIS 2 directive sector slug (Annex I or II) the Organization falls under. Optional.
Available options:
Acqua potabile, Acque reflue, Energia - Energia elettrica, Energia - Gas, Energia - Idrogeno, Energia - Petrolio, Energia - Petrolio/Gas, Energia - Stoccaggio, Energia - Teleriscaldamento, Gestione servizi TIC (B2B), Infrastrutture digitali, Infrastrutture mercati finanziari, Settore bancario, Settore sanitario, Settore sanitario - Farmaceutico, Settore sanitario - Ricerca, Spazio, Trasporti - Aereo, Trasporti - Ferroviario, Trasporti - Marittimo, Trasporti - Porti, Trasporti - Strada, Trasporti - Vie d'acqua interne, Fabbricazione - Altri mezzi di trasporto, Fabbricazione - Apparecchiature elettriche, Fabbricazione - Autoveicoli, Fabbricazione - Dispositivi medici, Fabbricazione - Elettronica, Fabbricazione - Macchinari, Fabbricazione sostanze chimiche, Fornitori di servizi digitali, Gestione dei rifiuti, Produzione e distribuzione alimenti, Ricerca, Servizi postali e di corriere, Cultura, Istruzione e Ricerca, PA, Trasporto pubblico locale Compliance frameworks required by the Organization and framework-specific metadata. Metadata-only; does not alter V-CISO workflow associations.
Show child attributes
Show child attributes
Example:
[
{
"value": "ISO 27001:2023",
"fields": { "extensions": ["ISO 27017:2021"] }
},
{
"value": "NIS2",
"fields": { "entity_type": "important" }
}
]
Organization infrastructure in-use.
Available options:
cloud, on-prem, hybrid Points of contact for the Organization.
Show child attributes
Show child attributes
Organization owned domains.
Organization public IPs.
Public IPv4 address.