CTIX
Network live
CTIXPOST

Create Identity SDO

Source docs
POSThttps://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/identity/

Adds an Identity SDO in the initiated detailed STIX form submission.

Path Parameters

NameTypeRequiredDescription
intel-idstringoptional

Pass the unique ID of the intel submission.

Body Parameters

NameTypeRequiredDescription
created_by_refobjectoptional

Pass the list of IDs and names of the identity SDO being referred.

revokedbooleanoptional

Pass true if the SDO object is revoked, else pass false.

labelsarrayoptional

Pass the list of IDs and names of the labels attached to the SDO.

custom_propertiesarrayoptional

Pass the list of the unique identifiers for the custom property, type, name, and the value to add for the same.

tlpobjectoptional

Pass the list of UI labels and values of TLP.

namestringrequired

Pass the name of the SDO.

descriptionstringoptional

Pass the description of the SDO.

identity_classobjectoptional

Pass the list of types of entities that this Identity describes.

rolesarrayoptional

Pass the list of roles for this identity.

sectorsarrayoptional

Pass the list of industry sectors to which the identity belongs.

contact_informationstringoptional

Pass the contact information, such as email address, phone number, and more for this identity.

Run it

Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).

Playground

Request parameters

Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.

CTIXConnect to Intel ExchangeRequired to change data
Credentials required for POST

Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.

Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.

Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.

Path Parameters
Request body (JSON)Valid JSON
cURL
curl --request POST \
  --url "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/identity/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
  --data '{
  "created_by_ref": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "tlp": {},
  "name": "identity 1",
  "description": "identity desc",
  "identity_class": {},
  "roles": [
    "tester"
  ],
  "sectors": [
    {}
  ],
  "contact_information": "del"
}'

View-only example — running live API calls requires a role with snippet testing access.

JavaScript
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/identity/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";

const response = await fetch(url, {
  method: "POST",
  headers: {},
  body: JSON.stringify({
    "created_by_ref": {},
    "revoked": false,
    "labels": [
      {}
    ],
    "custom_properties": [
      {}
    ],
    "tlp": {},
    "name": "identity 1",
    "description": "identity desc",
    "identity_class": {},
    "roles": [
      "tester"
    ],
    "sectors": [
      {}
    ],
    "contact_information": "del"
  }),
});

const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);

View-only example — running live API calls requires a role with snippet testing access.

Python
import requests

url = "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/identity/"
params = {
    "AccessID": "<your access id>",
    "Signature": "<your signature>",
    "Expires": "<your expires>"
}
headers = {}
payload = {
  "created_by_ref": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "tlp": {},
  "name": "identity 1",
  "description": "identity desc",
  "identity_class": {},
  "roles": [
    "tester"
  ],
  "sectors": [
    {}
  ],
  "contact_information": "del"
}
response = requests.request("POST", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)

View-only example — running live API calls requires a role with snippet testing access.

Request Body
{
  "created_by_ref": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "tlp": {},
  "name": "identity 1",
  "description": "identity desc",
  "identity_class": {},
  "roles": [
    "tester"
  ],
  "sectors": [
    {}
  ],
  "contact_information": "del"
}

View-only example — running live API calls requires a role with snippet testing access.

Example Response
{
  "created_by_ref": {},
  "tlp": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "name": "identity 1",
  "description": "identity desc",
  "roles": [
    "tester"
  ],
  "identity_class": {},
  "sectors": [
    {}
  ],
  "contact_information": "del",
  "id": "identity--a11fbeaf-0311-4e68-8e3c-fcacb124ea75"
}

View-only example — running live API calls requires a role with snippet testing access.