API

Once a handle is established, CVE services may be requested on behalf of the active user by calling the apppropriate API methods.

Each method returns a Promise resolving to the API return value upon success.

CVE IDs

Retrieve the current organisation's reserved CVE IDs

client.getCveIds()
    .then(ids => console.log(ids));

Update a CVE-ID record

await client.updateCveId('CVE-ABCD-EFGH', {...schema});

Reserve CVE IDs - full options

client.reserveCveIds({
    amount: 100,
    cve_year: 2021,
    short_name: "my_org_name",
    batch_type: "sequential"
})
.then(res => console.log(res));

Reserve a single CVE ID

Reserves a CVE ID for the current year (as determined by the browser local time).

await client.reserveCveId();

Alternatively, the caller may specify the year in which to reserve.

await client.reserveCveId(2012);

Reserve n sequential CVE IDs

Reserve a number of sequential IDs for a given year.

await client.reserveSeqCveIds(12, 2006);

Reserve a number of sequential IDs for the current year.

await client.reserveSeqCveIds(99);

Reserve n nonsequential CVE IDs

Reserve a number of sequential IDs for a given year.

await client.reserveNonSeqCveIds(12, 2009);

Reserve a number of nonsequential IDs for the current year.

await client.reserveNonSeqCveIds(27182818284);

Retrieve a specific CVE ID

client.getCveId("2021-2222-1111")
    .then(cve => console.log(cve));

CVEs

Get all CVE records

await client.getCves();

Get a single CVE record

await client.getCve();

Update a CVE record

await client.updateCve('CVE-ABCD-EFGH', schema);

Create a new CVE record from a reserved ID

await client.createCve('CVE-ABCD-EFGH', {...schema});

Create a new CVE record in reject status

await client.createRejectCve('CVE-ABCD-EFGH', {...schema});

Update a CVE record in reject status

await client.updateRejectCve('CVE-ABCD-EFGH', {...schema});

Organisations

Get organisation info

await client.getOrgInfo()
    .then(org => console.log(org));

Update organisation info

await client.updateOrgInfo({...orgInfo});

Create new user in current organisation

await client.createOrgUser({...userInfo});

Update existing organisation user

await client.updateOrgUser('username', {...newUserInfo});

Get organisation users

await client.getOrgUsers()
    .then(users => console.log(users));

Get organisation's allocation quota

await client.getOrgIdQuota()
    .then(quota => console.log(quota));

Get organisation user record

await client.getOrgUser("user1")
    .then(user => console.log(user));