Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Body

application/json

Connect a ServiceNow instance. Send client_id and client_secret for auth_method oauth_client_credentials, or username and password for auth_method basic. When auth_method is omitted, Strix uses basic if username is present and client_id is not, otherwise oauth_client_credentials.

instance_url
string<uri>
required

URL or hostname of the ServiceNow instance, for example https://acme.service-now.com or acme.service-now.com. Strix uses HTTPS. Other schemes are rejected.

auth_method
enum<string>
default:oauth_client_credentials

How Strix authenticates to the instance. oauth_client_credentials uses an OAuth API endpoint from the Application Registry with the Client Credentials grant and an OAuth Application User. basic uses the username and password of a dedicated integration user.

Available options:
oauth_client_credentials,
basic
client_id
string

Client ID of the OAuth API endpoint. Required for auth_method oauth_client_credentials.

client_secret
string<password>

Client secret of the OAuth API endpoint. Required for auth_method oauth_client_credentials. Strix stores it encrypted and never returns it.

username
string

User name of the ServiceNow integration user. Required for auth_method basic.

password
string<password>

Password of the ServiceNow integration user. Required for auth_method basic. Strix stores it encrypted and never returns it.

record_type
enum<string>
default:incident

ServiceNow table that Strix writes vulnerability records to. Defaults to incident, which the itil role can create on a standard instance. The task table needs a create ACL that requires the itil role. A ServiceNow admin must add that ACL before Strix can create Task records. You can change the record type later in the ServiceNow integration settings or by connecting again. A change of record type clears the existing ticket links.

Available options:
incident,
task

Response

Connected.

success
boolean
required
provider
enum<string>
required
Available options:
servicenow
instance_url
string
required

Normalized instance URL that Strix stored.

auth_method
enum<string>
required

Authentication method that Strix stored.

Available options:
oauth_client_credentials,
basic
record_type
enum<string>
required

ServiceNow table that Strix writes vulnerability records to.

Available options:
incident,
task