Vai al contenuto principale
PUT
/
api
/
v1
/
organizations
/
{id}
Update organization
curl --request PUT \
  --url https://app.aegister.com/api/v1/organizations/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "number_employees": 123,
  "website": "<string>",
  "logo": "<string>",
  "sectors": [],
  "industries": [],
  "compliance_frameworks": [
    {
      "fields": {
        "extensions": []
      }
    }
  ],
  "contacts": [
    {
      "name": "<string>",
      "role": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "email_report": true
    }
  ],
  "domains": [
    "<string>"
  ],
  "ips": [
    "127.0.0.1"
  ]
}
'
{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "ips": [
      "127.0.0.1"
    ],
    "logo": "<string>",
    "domains": [
      "<string>"
    ],
    "website": "<string>",
    "sectors": [],
    "industries": [],
    "compliance_frameworks": [
      {
        "fields": {
          "extensions": []
        }
      }
    ],
    "number_employees": 123,
    "contacts": [
      {
        "name": "<string>",
        "role": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "email_report": true
      }
    ]
  }
}

Autorizzazioni

​
X-Aegister-Token
string
header
obbligatorio

Parametri del percorso

​
id
integer
obbligatorio

Corpo

​
name
string

Organization common name.

Esempi:

"Sample Organization"

"My Organization"

​
description
string

Organization description

Esempio:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."

​
number_employees
number

Organization number of employees

Esempi:

10

20

30

​
website
string

Full URL of the Organization website

Esempi:

"https://sample.com"

"https://my.organization.com"

Full URL reference to Organization Logo file

Esempi:

"https://sample.com/logo.svg"

"https://my.organization.com/logo.png"

​
sectors
enum<string>[]

Sectors in which the Organization operates.

Opzioni disponibili:
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
enum<string>[]

Industries in which the Organization operates.

Opzioni disponibili:
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
​
nis2_sector
enum<string>

NIS 2 directive sector slug (Annex I or II) the Organization falls under. Optional.

Opzioni disponibili:
,
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
object[]

Compliance frameworks required by the Organization and framework-specific metadata. Metadata-only; does not alter V-CISO workflow associations.

Esempio:
[
  {
    "value": "ISO 27001:2023",
    "fields": { "extensions": ["ISO 27017:2021"] }
  },
  {
    "value": "NIS2",
    "fields": { "entity_type": "important" }
  }
]
​
infrastructure
enum<string>

Organization infrastructure in-use.

Opzioni disponibili:
cloud,
on-prem,
hybrid
​
contacts
object[]

Points of contact for the Organization.

​
domains
string<hostname>[]

Organization owned domains.

​
ips
string<ipv4>[]

Organization public IPs.

Public IPv4 address.

Risposta

​
error
integer

Any value different from 0 indicates an error.
More details can be found in messages.

Intervallo richiesto: 0 <= x <= 0
Esempio:

0

​
messages
array

If error is 1, contains zero or more details on the error.

Esempio:
[]
​
data
object