Skip to main content
POST
Create Connection Invite Token

Authorizations

X-API-KEY
string
header
required

Path Parameters

organization_id
string<uuid>
required

Body

application/json
connection_id
string<uuid> | null

Connection ID for the connection to be updated

expiry_secs
integer | null
default:1800

Connection token expiry in seconds, default 30 minutes

identifier
string | null

Identifier for the connection to be created or updated with this token

options
AikidoConnectionOptions · object

Connection options, ONLY used for Oauth2 URL overrides for Snyk and MS Defender Endpoint, and auth_type for AWS connectors, Snyk, MS Defender Endpoint and MS Defender Vulnerability Management

source_connection_id
string<uuid> | null

For a destination vendor only (pull or push): binds this token to a specific SOURCE connection, so the resulting connection can only be created with a matching source_connection_id. Distinct from connection_id, which means 'update this existing connection' — never both set.

vendor
enum<string> | null

Vendor for which the connection token is being created

Available options:
AIKIDO,
ARNICA,
AWS_ACCESS_ANALYSER,
AWS_GUARDDUTY,
AWS_INSPECTOR2,
AWS_SECURITYHUB,
BIT_SIGHT,
BLACK_DUCK_COVERITY,
BLACK_DUCK_SCA,
BLACK_KITE,
CHECKMARX,
CROWDSTRIKE,
CROWDSTRIKE_SPOTLIGHT,
GITHUB,
GITLAB,
HEELER,
INSIGHTVM,
JIRA,
LACEWORK_CSPM,
MEND,
MS_DEFENDER_CLOUD,
MS_DEFENDER_ENDPOINT,
MS_DEFENDER_VMS,
MS_DEFENDER_VMS_GCC_HIGH,
MS_ENTRA,
MS_INTUNE,
OKTA_IDP,
ORCA,
PROCESSUNITY,
PROOFPOINT_TAP,
QUALYS,
SECURITY_SCORECARD,
SEMGREP,
SENTINELONE,
SENTINELONE_VMS,
SERVICENOW,
SERVICENOW_ITSM,
SERVICENOW_VR,
SNYK,
SOCKET,
SONARQUBE,
TANIUM_VMS,
TENABLE,
UPWIND,
WIZ_CODE,
WIZ_CSPM,
WIZ_VMS

Response

Successful Response

token
string
required

The token to hand to whoever will authorise the connection. Shown once, at creation; it cannot be read back afterwards.