Connectors (`risksense_api.subject.connectors.__connectors`)¶

Connector module defined for different connector related api endpoints.

class risksense_api.__subject.__connectors.__connectors.Connectors(profile)[source]¶

Bases: Subject

Class for connector function definitions.

Parameters:: profile (object) – Profile Object

To utlise group function:

Usage:: self.{risksenseobjectname}.connectors.{function}

Examples

To update a connector using update() function

>>> self.{risksenseobjectname}.connectors.update(args)

class Type[source]¶

Bases: object

Connectors.Type class

NESSUS = 'NESSUS'¶

QUALYS_VULN = 'QUALYS_VULN_FILE_PICKUP'¶

QUALYS_VMDR = 'QUALYS_API_VULNERABILITY'¶

QUALYS_ASSET = 'QUALYS_ASSET'¶

NEXPOSE = 'NEXPOSE_FILE_PICKUP'¶

TENEBLE_SEC_CENTER = 'TENEBLE_SECURITY_CENTER'¶

BURPSUITE = 'BURPSUITE'¶

CROWDSTRIKE = 'FALCONSPOTLIGHT'¶

QUALYS_WAS = 'QUALYS_WAS'¶

VERACODE = 'VERACODE'¶

SONAR_CLOUD = 'SONARCLOUD'¶

JIRA = 'JIRA'¶

SERVICENOW_INCIDENT = 'SERVICE_NOW'¶

SERVICENOW_SERVICEREQUEST = 'SNOW_SERVICE_REQUEST'¶

CHECKMARX_OSA = 'CHECKMARXOSA'¶

CHECKMARX_SAST = 'CHECKMARXSAST'¶

HCL_APPSCAN = 'HCL_ASOC'¶

QUALYS_PC = 'QUALYS_PC'¶

CHERWELL = 'CHERWELL'¶

SERVICENOW_CTC = 'GENERIC_SNOW'¶

AWSINSPECTOR = 'AWS_INSPECTOR'¶

EXPANDER = 'EXPANDER'¶

NEXPOSE_ASSET = 'NEXPOSE_ASSET_TAG_FILE_PICKUP'¶

PRISMA_CLOUD = 'PRISMACLOUD'¶

FORTIFY_ON_DEMAND = 'FORTIFYONDMD'¶

SONATYPE = 'SONATYPE'¶

AQUASEC = 'AQUASEC'¶

WHITEHAT = 'WHITEHAT'¶

class ScheduleFreq[source]¶

Bases: object

Connectors.ScheduleFreq class

DAILY = 'DAILY'¶

WEEKLY = 'WEEKLY'¶

MONTHLY = 'MONTHLY'¶

__init__(profile)[source]¶

Initialization of Connectors object.

Parameters:: profile (object) – Profile Object

get_single_connector(connector_id, csvdump=False, client_id=None)[source]¶

Get a connector detail based on connector id.

Parameters:

connector_id (int) – Connector Id
csvdump (bool) – Whether to dump the assessment history in a csv, true to dump and false to not dump
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_single_connector(123,client_id=123)

Note

You can also dump the data of the connector search in a csv file. Just make csvdump as True:

>>>  self.{risksenseobject}.connectors.get_single_connector(123,client_id=123,csvdump=True)

get_snow_category(snow_username, snow_password_or_token, snow_url, catalogid, client_id=None)[source]¶

Get ServiceNow Category information.

Parameters:

snow_username (str) – Service Now username
snow_password_or_token (str) – Service Now API Token/Password
snow_url (str) – Service Now Platform URL
catalogid (str) – Catalog id to get category of
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Jsonified response of category data

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_snow_category('test','xxx','https://test.com',1234,client_id=123)

get_snow_item(snow_username, snow_password_or_token, snow_url, catalogid, categoryid, client_id=None)[source]¶

Get ServiceNow item data

Parameters:

snow_username (str) – Service Now username
snow_password_or_token (str) – Service Now API Token/Password
snow_url (str) – Service Now Platform URL
catalogid (str) – Service Now catalog id
categoryid (str) – Service Now category id
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Jsonified response of item data

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_snow_item('test','xxx','https://test.com',1234,123,client_id=123)

get_snow_catalogitemvariables(snow_username, snow_password_or_token, snow_url, catalogid, categoryid, catalogitemid, client_id=None)[source]¶

Get ServiceNow fields item data from items

Parameters:

snow_username (str) – Service Now username
snow_password_or_token (str) – Service Now API Token/Password
snow_url (str) – Service Now Platform URL
catalogid (str) – Service Now catalog id
categoryid (str) – Service Now category id
catalogitemid (str) – Service Now item id
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Jsonified response of item data

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_snow_catalogitemvariables('test','xxx','https://test.com',1234,123,123,client_id=123)

run_connector(connectorid, client_id=None)[source]¶

Run connector based on connector id

Parameters:

connectorid (int) – Connector Id
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Json response of connector run

Examples

>>> apiobj = self.{risksenseobject}.connectors.run_connector(123,client_id=123)

paginate_connector(page_num=0, page_size=150, csvdump=False, client_id=None)[source]¶

Get a paginated list of connectors associated with the client.

Parameters:

page_num (int) – The page number of results to be returned
page_size (int) – The number of results to return per page
csvdump (bool) – Whether to dump the connector data in a csv, true to dump and false to not dump
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.paginate_connector(page_num=0,page_size=100,client_id=123)

Note

You can also dump the data of the connector search in a csv file. Just make csvdump as True:

>>>  self.{risksenseobject}.connectors.paginate_connector(page_num=0,page_size=100,client_id=123,csvdump=True)

connector_populate(body, client_id=None)[source]¶

Populate data of connector.

Parameters:

body (dict) – Populate body
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.connector_populate({"type":"JIRA","username":"test@xyz.com","password":"test","url":"https://test.atlassian.net","projection":"internal","connectorId":1234},client_id=123)

Note

Intercept this API endpoint /client/{clientId}/connector/populate in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

create_scanning_connector(conn_name, conn_type, conn_url, schedule_freq, network_id, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new scanning connector.

Parameters:

conn_name (str) – The connector name
conn_type (str) – The connector type
conn_url (str) – The URL for the connector to communicate with.
schedule_freq (str) – The frequency for the connector to run. Options:
Connectors.ScheduleFreq.DAILY –
Connectors.ScheduleFreq.WEEKLY –
Connectors.ScheduleFreq.MONTHLY –
network_id (int) – The network ID
username_or_access_key (str) – The username to use for connector authentication
password_or_secret_key (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
template (str) – Template data
create_asset (bool) – Create asset data
reportnameprefix (str) – Report Name Prefix
authmechanism (str) – Auth mechanism
ingestionfindingstype (list) – Ingestion finding type
folder_id (int) – Nessus scanner folder id

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_scanning_connector('test','JIRA','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0,folder_id=1)

Note

Intercept this API endpoint /client/{clientId}/connector in UI to better understand the argument values that need to be sent using this function. Then, use this function in your automation.

create_expander(conn_name, conn_url, schedule_freq, network_id, username, apikey, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new expander connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Option: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
apikey (str) – The password/api token to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[bool]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_expander('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

Note

Intercept this API endpoint /client/{clientId}/connector in UI to better understand the argument values that need to be sent using this function. Then, use this function in your automation.

cherwellincident_connector_populate(body, client_id=None)[source]¶

Populates cherwell incident connector data based on body

Parameters:

body (dict) – Body for connector populate
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned

Note

Intercept this API endpoint /client/{clientId}/connector/populate/ticketType/Incident in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

cherwellproblem_connector_populate(body, client_id=None)[source]¶

Populates cherwell problem connector data based on body

Parameters:

body (dict) – Body for connector populate
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned

Note

Intercept this API endpoint /client/{clientId}/connector/populate/ticketType/Problem in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

cherwellmakerequest_connector_populate(body, client_id=None)[source]¶

Populates cherwell make request connector data based on body

Parameters:

body (dict) – Body for connector populate
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned

Note

Intercept this API endpoint /client/{clientId}/connector/populate/ticketType/ChangeRequest in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

create_cherwell_incident_connector(cw_name, cw_username, cw_password, clientid_key, cw_url, autourba=False, client_id=None)[source]¶

Creates cherwell incident type connector

Parameters:

cw_name (str) – Cherwell connector name
cw_username (str) – Cherwell connector username
cw_password (str) – Cherwell connector password
clientid_key (str) – Cherwell connector client id key
cw_url (str) – Cherwell connector url
autourba (bool) – Switch to enable auto urba
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

int

Returns:

Id of connector

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_cherwell_incident_connector('test','test','pass','xxxx','https://test.com',autourba=True,client_id=123)

create_cherwell_problem_connector(cw_name, cw_username, cw_password, clientid_key, cw_url, autourba=False, client_id=None)[source]¶

Creates cherwell problem typpe connector

Parameters:

cw_name (str) – Cherwell connector name
cw_username (str) – Cherwell connector username
cw_password (str) – Cherwell connector password
clientid_key (str) – Cherwell connector client id key
cw_url (str) – Cherwell connector url
autourba (bool) – Switch to enable auto urba
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

int

Returns:

Connector id

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_cherwell_problem_connector('test','test','pass','xxxx','https://test.com',autourba=True,client_id=123)

create_cherwell_makerequest_connector(cw_name, cw_username, cw_password, clientid_key, cw_url, autourba=False, client_id=None)[source]¶

Creates cherwell change request type connector

Parameters:

cw_name (str) – Cherwell connector name
cw_username (str) – Cherwell connector username
cw_password (str) – Cherwell connector password
clientid_key (str) – Cherwell connector client id key
cw_url (str) – Cherwell connector url
autourba (bool) – Switch to enable auto urba
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

int

Returns:

Connector id

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_cherwell_makerequest_connector('test','test','pass','xxxx','https://test.com',autourba=True,client_id=123)

create_qualyspc(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new qualys pc connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_qualyspc('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_hclappscan(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new hcl appscan connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_hclappscan('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_veracode(conn_name, conn_url, schedule_freq, network_id, access_key, secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new veracode connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
access_key (str) – The access key to use for connector authentication
secret_key (str) – The secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_veracode('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_sonar_cloud(conn_name, conn_url, schedule_freq, network_id, access_key, secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new sonar cloud connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
access_key (str) – The access key to use for connector authentication
secret_key (str) – The secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_sonar_cloud('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_nessus(conn_name, conn_url, schedule_freq, network_id, access_key, secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Nessus connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
access_key (str) – The access key to use for connector authentication
secret_key (str) – The secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
folder_id (int) – Nessus scanner folder id. Integer

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_nessus('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_tenableio(conn_name, conn_url, schedule_freq, network_id, access_key, secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new tenable io connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
access_key (str) – The access key to use for connector authentication
secret_key (str) – The secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_tenableio('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_awsinspector(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new aws inspector connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_awsinspector('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_burpsuite(conn_name, conn_url, schedule_freq, network_id, username, apikey, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new burpsuite connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
apikey (str) – The api key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_burpsuite('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_whitehat(conn_name, conn_url, schedule_freq, network_id, username, apikey, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Whitehat sentinel dynamic connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
apikey (str) – The api key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_burpsuite('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_aquasec(conn_name, conn_url, schedule_freq, network_id, username, apikey, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new burpsuite connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
apikey (str) – The api key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_burpsuite('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_crowdstrike(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new crowdstrike connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_crowdstrike('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_snow_customtableconfig(conn_name, conn_url, username, password, tablename, statusfield, ticketidfield, enabletagremoval=False, enableuploadattachment=True, client_id=None)[source]¶

Create a new snow custom table configuration connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
tablename (str) – Table name
statusfield (str) – Status field
ticketidfield (str) – Ticket Id field
enabletagremoval (bool) – Enable Tag removal
enableuploadattachment (bool) – Enable upload attachment
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_snow_customtableconfig('test','https://test.com','xxxx','xxxx','test','open','123',client_id=123)

get_jira_project(username, password_or_api_token, jira_url, client_id=None)[source]¶

Get JIRA Projects

Parameters:

username (str) – JIRA username
password_or_api_token (str) – JIRA API Token/Password
jira_url (str) – JIRA Platform URL
client_id (typing.Optional[int]) – RS Client ID

Return type:

tuple

Returns:

JIRA Project Name
JIRA Project Key
Description field enabled list

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_jira_project('test','test','https://test.com',client_id=123)

get_jira_issuetype(username, password_or_api_token, jira_url, project_key, client_id=None)[source]¶

Get JIRA Issue Types

Parameters:

username (str) – JIRA username
password_or_api_token (str) – JIRA API Token/Password
jira_url (str) – JIRA Platform URL
project_key (str) – JIRA Project Key
client_id (typing.Optional[int]) – RS Client ID

Return type:

tuple

Returns:

JIRA Issue Type Name
JIRA Issue Type Key

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_jira_issuetype('test','test','https://test.com','test',client_id=123)

get_jira_issuetypefields(username, password_or_api_token, jira_url, project_key, issuetypeid, client_id=None)[source]¶

Get JIRA Issue Type Field key and value

Parameters:

username (str) – JIRA username
password_or_api_token (str) – JIRA API Token/Password
jira_url (str) – JIRA Platform URL
project_key (str) – JIRA Project Key
issuetypeid (str) – JIRA Issue type id
client_id (typing.Optional[int]) – RS Client ID

Return type:

tuple

Returns:

JIRA Issue Type Name
JIRA Issue Type Key

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_jira_issuetypefields('test','test','https://test.com','test',client_id=123)

get_jira_tagtype_ticketstatus(username, password_or_api_token, jira_url, project_key, issue_type_key, client_id=None)[source]¶

Get JIRA Tag Type and Ticket Status options

Parameters:

username (str) – JIRA username
password_or_api_token (str) – JIRA API Token/Password
jira_url (str) – JIRA Platform URL
project_key (str) – JIRA Project Key
issue_type_key (str) – JIRA Issue Type Key
client_id (typing.Optional[int]) – RS Client ID

Return type:

tuple

Returns:

Tag Type Name
JIRA Closed status name
JIRA Closed status Key
JIRA Ticket sync string

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_jira_issuetypefields('test','test','https://test.com','test','due_date',client_id=123)

create_jira_connector(jira_connector_name, username, password_or_api_token, jira_url, project_name, project_key, issue_type_name, issue_type_key, tag_type_name, closed_status_key, closed_status_value, ticket_sync_string, supporteddescription, client_id=None)[source]¶

Create a JIRA Connector

Parameters:

jira_connector_name (str) – JIRA Connector Name
username (str) – JIRA username
password_or_api_token (str) – JIRA API Token/Password
jira_url (str) – JIRA Platform URL
project_name (str) – JIRA Project Name
project_key (str) – JIRA Project Key
issue_type_name (str) – JIRA Issue Type Name
issue_type_key (str) – JIRA Issue Type Key
client_id (typing.Optional[int]) – RS Client ID
tag_type_name (str) – Tag Type Name
closed_status_value (str) – JIRA Closed status name
closed_status_key (str) – JIRA Closed status Key
ticket_sync_string (str) – JIRA Ticket sync string
supporteddescription (list) – Supported description

Return type:

int

Returns:

Created JIRA connector ID

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_jira_connector('test','test','test project','TP','bug','bug','CUSTOM','Closed','closed','Open,In Progress','test',client_id=123)

get_snow_fields(snow_username, snow_password_or_token, snow_url, client_id=None)[source]¶

Get Service Now Incident type connector for Tag Type and Ticket Status options

Parameters:

snow_username (str) – Service Now username
snow_password_or_token (str) – Service Now API Token/Password
snow_url (str) – Service Now Platform URL
client_id (typing.Optional[int]) – RS Client ID

Return type:

tuple

Returns:

Tag Type Name
Service Now Closed status name
Service Now Closed status Key
Service Now Ticket sync string

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_snow_fields('test','test','https://test.com','DAILY',client_id=123)

get_snow_catalog(snow_username, snow_password_or_token, snow_url, client_id=None)[source]¶

Get Service Now connector data

Parameters:

snow_username (str) – Service Now username
snow_password_or_token (str) – Service Now API Token/Password
snow_url (str) – Service Now Platform URL
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Catalog,category,item information,close status key etc in populate data

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_snow_catalog('test','test','https://test.com',client_id=123)

populate_editform_cmdb(filters, client_id=None)[source]¶

Populate editform cmdb data

Parameters:

filters (list) – Connector populate filters
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Jsonified response of editform populate data

Examples

>>> apiobj = self.{risksenseobject}.connectors.populate_editform_cmdb([{"field": "id","exclusive": False,"operator": "IN","value": "1223"}],client_id=123)

populate_lockform_cmdb(filters, client_id=None)[source]¶

Populate lockform cmdb data

Parameters:

filters (str) – Connector populate filters
client_id (typing.Optional[int]) – RS Client ID

Returns:

Jsonified response of lockform populate data

Examples

>>> apiobj = self.{risksenseobject}.connectors.populate_lockform_cmdb([{"field": "id","exclusive": False,"operator": "IN","value": "1223"}],client_id=123)

list_cmdb_custom_fields(client_id=None)[source]¶

Populate cmdb custom field data

Parameters:: client_id (typing.Optional[int]) – RS Client ID
Return type:: dict
Returns:: Jsonified response

Examples

>>> api = self.{risksenseobject}.connectors.list_cmdb_custom_fields(client_id=123)

add_cmdb_custom_fields(cmdbcustomfields, client_id=None)[source]¶

Add cmdb custom fields label

Parameters:

cmdbcustomfields (list) – Connector populate filters
client_id (typing.Optional[int]) – RS Client ID

Return type:

bool

Returns:

True/False sucess status

Examples

>>> api = self.{risksenseobject}.connectors.add_cmdb_custom_fields( [{"value": "test","key": "cf_1"}],client_id=123)

get_multiplematches(subject, assetid, client_id=None)[source]¶

Get list of assets that have multiple matches

Parameters:

subject (str) – Subject specified information of the asset id
assetid (int) – Asset id to check for multiple matches
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Jsonified response of multiple matches

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_multiplematches('hostFinding',123,client_id=123)

get_multiplematches_connector(subject, assetid, connectorid, hostid, sysid, table, client_id=None)[source]¶

Get list of assets that multiple matches of cmdb data

Parameters:

subject (str) – Subject specified information of the asset id
assetid (int) – Asset id to check for multiple matches
connectorid (int) – Connector id
hostid (int) – Host id
sysid (int) – Sys id
table (str) – Table information

Return type:

dict

Returns:

Json data

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_multiplematches_connector('hostFinding',123,123,123,123,'test',client_id=123)

Parameters:: client_id (typing.Optional[int]) –

create_asset_snowcmdb(subject, assetid, connectorid, client_id=None)[source]¶

Create an asset in snow cmdb

Parameters:

subject (str) – Subject specified information of the asset id
assetid (int) – Asset id to check for multiple matches
connectorid (int) – Connector id
client_id (typing.Optional[int]) – RS Client ID,if none takes the default client id

Return type:

dict

Returns:

Json data

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_asset_snowcmdb('hostFinding',123,123,client_id=123)

sync_asset_snowcmdb(subject, assetid, connectorid, client_id=None)[source]¶

Sync asset in snow cmdb

Parameters:

subject (str) – Subject specified information of the asset id
assetid (int) – Asset id to check for multiple matches
connectorid (int) – Connector id
client_id (typing.Optional[int]) – RS Client ID

Return type:

dict

Returns:

Json data

Examples

>>> apiobj = self.{risksenseobject}.connectors.sync_asset_snowcmdb('hostFinding',123,123,client_id=123)

create_snow_connector(snow_connector_name, snow_username, snow_password_or_token, snow_url, tag_type_name, closed_status_value, closed_status_key, ticket_sync_string, supporteddescriptionfields, selected_optional_fields, client_id=None)[source]¶

Create a Service Now Incident type Connector

Parameters:

snow_connector_name (str) – SNOW Connector Name
snow_username (str) – SNOW username
snow_password_or_token (str) – SNOW API Token/Password
snow_url (str) – SNOW Platform URL
tag_type_name (str) – Tag Type Name
closed_status_value (str) – SNOW Closed status name
closed_status_key (str) – SNOW Closed status Key
ticket_sync_string (str) – SNOW Ticket sync string
supporteddescriptionfields (list) – Supported Description fields
selected_optional_fields (list) – Selected optional fields
client_id (typing.Optional[int]) – RS Client ID

Return type:

int

Returns:

Created SNOW connector ID

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_snow_connector('test','test','pass','https://test.com','CUSTOM','Closed','closed','Open,In Progress',[],[],client_id=123)

create_snow_service_connector(snow_connector_name, snow_username, snow_password_or_token, snow_url, ticket_description='false', client_id=None)[source]¶

Create a Service Now Service Request type Connector

Parameters:

snow_connector_name (str) – SNOW Connector Name
snow_username (str) – SNOW username
snow_password_or_token (str) – SNOW API Token/Password
snow_url (str) – SNOW Platform URL
ticket_description (str) – Ticket description
client_id (typing.Optional[int]) – RS Client ID

Return type:

int

Returns:

Created SNOW connector ID

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_snow_service_connector('test','test','pass','https://test.com',client_id=123)

create_prisma_network_connector(conn_name, conn_url, username, password, conn_status, schedule_freq, network_id, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Checkmarx OSA scanning connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (bool) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_checkmarx_osa_connector('test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

create_fortify_ondemand_connector(conn_name, conn_url, username, password, conn_status, schedule_freq, network_id, sdlcstatus, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Checkmarx OSA scanning connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (bool) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_checkmarx_osa_connector('test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

Parameters:: sdlcstatus (str) –

create_sonatype_connector(conn_name, network_id, conn_url, username, password, conn_status, schedule_freq, taginfopull=True, createassetifvulnfound=True, nexusapipullapplicationfilter=True, nexusapipullstagefilter=True, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Checkmarx OSA scanning connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (bool) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_checkmarx_osa_connector('test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

Parameters:

taginfopull (bool) –
createassetifvulnfound (bool) –
nexusapipullapplicationfilter (bool) –
nexusapipullstagefilter (bool) –

create_checkmarx_osa_connector(conn_name, conn_url, username, password, conn_status, schedule_freq, network_id, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Checkmarx OSA scanning connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (bool) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_checkmarx_osa_connector('test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

create_checkmarx_sast_connector(conn_name, conn_url, username, password, conn_status, schedule_freq, network_id, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Checkmarx SAST scanning connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (str) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_checkmarx_sast_connector('test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

create_qualys_was(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Qualys Web application connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_qualys_was('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_qualys_vuln(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Qualys Vulnerability connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_qualyspc('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_qualys_asset(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Qualys Asset connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_qualys_asset('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_nexpose_asset_tag(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Nexpose Asset connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_nexpose_asset_tag('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_qualys_vmdr(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new qualys vmdr connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_qualys_vmdr('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_nexpose(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Nexpose connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_nexpose('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

create_teneble(conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Create a new Teneble Security Center connector.

Parameters:

conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.create_teneble('test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

get_connector_detail(connector_id, client_id=None)[source]¶

Get the details associated with a specific connector.

Parameters:

connector_id (int) – The connector ID.
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_connector_detail(123,client_id=123)

update(connector_id, conn_type, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing connector

Parameters:

connector_id (int) – Connector ID to update
conn_type (str) – Type of Connector
conn_name (str) – The name for the connector
conn_url (str) – The URL for the connector to communicate with.
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to be used
password_or_secret_key (str) – The password or secret key to be used
auto_urba (bool) – Indicates whether URBA should be automatically run after connector runs.
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update(123,'NESSUS','test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_expander(conn_id, conn_name, conn_url, schedule_freq, network_id, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update expander connector.

Parameters:

conn_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_expander(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_crowdstrike(conn_id, conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Update crowdstrike connector.

Parameters:

conn_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_crowdstrike(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_qualys_vmdr(connector_id, conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Update qualys vm connector.

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_qualys_vmdr(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_nessus_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing Nessus connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_nessus_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_sonarcloud(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing Sonarcloud connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_sonarcloud(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_veracode(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing Veracode connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_veracode(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_tenableio(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing Tenable io connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_tenableio(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_teneble(connector_id, conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing Teneble Security Center connector.

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_teneble(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_hclappscan(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing hclappscan connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_hclappscan(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_awsinspector(connector_id, conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing aws inspector connector.

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_awsinspector(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_burpsuite(connector_id, conn_name, conn_url, schedule_freq, network_id, username, apikey, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing burpsuite connector.

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
apikey (str) – The apikey to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_burpsuite(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_nexpose(connector_id, conn_name, conn_url, schedule_freq, network_id, username, password, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing Nexpose connector.

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_nexpose(123,'test','https://test.com','DAILY',123,'xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_qualys_vm_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing QUALYS VM connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_qualys_vm_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_qualys_pc_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing QUALYS PC connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_qualys_pc_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_nexpose_asset(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing QUALYS PC connector

Parameters:

connector_id (int) – Connector id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_nexpose_asset(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

search_query_parameter(body, client_id=None)[source]¶

Get option drop down fields based on search query parameters

Parameters:

body (dict) – The body that contains connector information
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned

Note

Intercept this API endpoint /client/{clientId}/connector/field/option in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

update_jira_connector(connector_id, jira_connector_name, username, password_or_api_token, jira_url, project_name, project_key, issue_type_name, issue_type_key, tag_type_name, closed_status_key, closed_status_value, ticket_sync_string, client_id=None)[source]¶

Updates a JIRA Connector

Parameters:

connector_id (int) – The Connector Id
jira_connector_name (str) – JIRA Connector Name
username (str) – JIRA username
password_or_api_token (str) – JIRA API Token/Password
jira_url (str) – JIRA Platform URL
project_name (str) – JIRA Project Name
project_key (str) – JIRA Project Key
issue_type_name (str) – JIRA Issue Type Name
issue_type_key (str) – JIRA Issue Type Key
tag_type_name (str) – JIRA Issue Type Name
closed_status_key (str) – JIRA Closed status Key
closed_status_value (str) – JIRA Closed status name
ticket_sync_string (str) – JIRA Ticket sync string
client_id (typing.Optional[int]) – RS Client ID

Return type:

int

Returns:

Created JIRA connector ID

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_jira_connector(123,'test','xxxx','xxxx','https://test.com','test project','TP','bug','bug','CUSTOM','closed','Closed','Open,In Progress',client_id=123)

update_snow_connector(connector_id, snow_connector_name, snow_username, snow_password_or_token, snow_url, tag_type_name, closed_status_value, closed_status_key, ticket_sync_string, client_id=None)[source]¶

Update a Service Now Incident type Connector

Parameters:

connector_id (int) – The Connector Id
snow_connector_name (str) – SNOW Connector Name
snow_username (str) – SNOW username
snow_password_or_token (str) – SNOW API Token/Password
snow_url (str) – SNOW Platform URL
tag_type_name (str) – SNOW Issue Type Name
closed_status_value (str) – SNOW Closed status name
closed_status_key (str) – SNOW Closed status Key
ticket_sync_string (str) – SNOW Ticket sync string
client_id (typing.Optional[int]) – RS Client ID

Return type:

int

Returns:

Created SNOW connector ID

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_snow_connector(123,'test','xxxx','xxxx','https://test.com','CUSTOM','Closed','closed','Open,In Progress',client_id=123)

update_snow_customtableconfig(connector_id, conn_name, conn_url, username, password, tablename, statusfield, ticketidfield, enabletagremoval=False, enableuploadattachment=True, client_id=None)[source]¶

Update an existing snow custom table configuration connector.

Parameters:

connector_id (int) – The Connector Id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
tablename (str) – Name of the table
statusfield (str) – status field
ticketidfield (str) – Ticket id field
enabletagremoval (bool) – Enable tag removal switch
enableuploadattachment (bool) – Enable upload attachment switch
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_snow_customtableconfig(123,'test','https://test.com','xxxx','xxxx','test','new','123',enabletagremoval=True,client_id=123,enableuploadattachment=True)

update_snow_service_connector(snow_connectorid, snow_connector_name, snow_username, snow_password_or_token, snow_url, ticket_description='false', client_id=None)[source]¶

Update existing Service Now Service Request type Connector

Parameters:

snow_connectorid (int) – The Connector Id
snow_connector_name (str) – SNOW Connector Name
snow_username (str) – SNOW username
snow_password_or_token (str) – SNOW API Token/Password
snow_url (str) – SNOW Platform URL
ticket_description (str) – To provide ticket description or not,’true’ to provide,’false’ to not provide
client_id (typing.Optional[int]) – RS Client ID

Return type:

int

Returns:

Created SNOW Service request connector ID

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_snow_service_connector(123,'test','xxxx','xxxx','https://test.com',client_id=123)

update_cherwell_incident_connector(cw_id, cw_name, cw_username, cw_password, clientid_key, cw_url, autourba=False, client_id=None)[source]¶

Update cherwell incident type connector

Parameters:

cw_id (int) – The Connector Id
cw_name (str) – Cherwell connector name.
cw_username (str) – Cherwell connector username.
cw_password (str) – Cherwell connector password.
clientid_key (str) – Cherwell connector client id key.
cw_url (str) – Cherwell connector url
autourba (bool) – Switch to enable auto urba
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_cherwell_incident_connector(123,'test','xxxx','xxxx','xxxx','https://test.com',auto_urba=True,client_id=123)

update_cherwell_problem_connector(cw_id, cw_name, cw_username, cw_password, clientid_key, cw_url, autourba=False, client_id=None)[source]¶

Update cherwell problem type connector

Parameters:

cw_id (int) – The Connector Id
cw_name (str) – Cherwell connector name.
cw_username (str) – Cherwell connector username.
cw_password (str) – Cherwell connector password.
clientid_key (str) – Cherwell connector client id key.
cw_url (str) – Cherwell connector url
autourba (bool) – Switch to enable auto urba
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_cherwell_problem_connector(123,'test','xxxx','xxxx','xxxx','https://test.com',auto_urba=True,client_id=123)

update_cherwell_makerequest_connector(cw_id, cw_name, cw_username, cw_password, clientid_key, cw_url, autourba=False, client_id=None)[source]¶

Updates an existing cherwell change request type connector

Parameters:

cw_id (int) – The Connector Id
cw_name (str) – Cherwell connector name.
cw_username (str) – Cherwell connector username.
cw_password (str) – Cherwell connector password.
clientid_key (int) – Cherwell connector client id key.
cw_url (str) – Cherwell connector url
autourba (bool) – Switch to enable auto urba
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_cherwell_makerequest_connector(123,'test','xxxx','xxxx','xxxx','https://test.com',auto_urba=True,client_id=123)

update_checkmarx_osa_connector(connector_id, conn_name, conn_url, username, password, conn_status, schedule_freq, network_id, auto_urba=True, client_id=None, **kwargs)[source]¶

Update a new Checkmarx OSA scanning connector.

Parameters:

connector_id (int) – The connector ID.
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (bool) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_checkmarx_osa_connector(123,'test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

update_checkmarx_sast_connector(connector_id, conn_name, conn_url, username, password, conn_status, schedule_freq, network_id, auto_urba=True, client_id=None, **kwargs)[source]¶

Update a new Checkmarx SAST scanning connector.

Parameters:

connector_id (int) – The connector ID.
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
username (str) – The username to use for connector authentication
password (str) – The password to use for connector authentication
conn_status (bool) – Whether enabled or disabled
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
network_id (int) – The network ID
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run, Type : Str, Available values : 1-7
day_of_month (int) – The day of the month the connector should run, Type : Str, Available values : 1-31
createAssetsIfZeroVulnFoundInFile (bool) – Create assets if zero vulnerability found in file. Type : Bool, Available values : True or False
maxDaysToRetrieve (int) – Max days to retrieve scan data. Type : Integer, Available values : 30,60,90,180,365

Return type:

int

Returns:

The connector ID from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_checkmarx_sast_connector(123,'test','https://test.com','xxxx','xxxx',True,'DAILY',123,auto_urba=True,client_id=123,hour_of_day=0)

update_qualys_was_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing QUALYS was connector

Parameters:

connector_id (int) – The connector Id
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba – Automatically run URBA after connector runs?
client_id – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_qualys_was_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_qualys_vuln_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing QUALYS VULN connector

Parameters:

connector_id (int) – Connector ID to update
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31
reportnameprefix (str) – Report Name Prefix

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_qualys_vuln_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_qualys_asset_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing QUALYS ASSET connector

Parameters:

connector_id (int) – Connector ID to update
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_qualys_asset_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_nexpose_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing NEXPOSE connector

Parameters:

connector_id (int) – Connector ID to update
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_nexpose_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

update_teneble_connector(connector_id, conn_name, conn_url, network_id, schedule_freq, username_or_access_key, password_or_secret_key, auto_urba=True, client_id=None, **kwargs)[source]¶

Update an existing TENEBLE SECURITY CENTER connector

Parameters:

connector_id (int) – Connector ID to update
conn_name (str) – The connector name
conn_url (str) – The URL for the connector to communicate with
network_id (int) – The network ID
schedule_freq (str) – The frequency for the connector to run. Options: Connectors.ScheduleFreq.DAILY, Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
username_or_access_key (str) – The username or access key to use for connector authentication
password_or_secret_key (str) – The password or secret key to use for connector authentication
auto_urba (bool) – Automatically run URBA after connector runs?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Keyword Arguments:

ssl_cert (str) – Optional SSL certificate.
hour_of_day (int) – The time the connector should run. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Integer. 1-31

Return type:

int

Returns:

The connector ID from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_teneble_connector(123,'test','https://test.com',123,'DAILY','xxxx','xxxx',auto_urba=True,client_id=123,hour_of_day=0)

delete(connector_id, delete_tag=True, client_id=None)[source]¶

Delete a connector.

Parameters:

connector_id (int) – The connector ID
delete_tag (bool) – Force delete tag associated with connector?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Returns:

Indicator reflecting whether or not the operation was successful.

Return type:

bool

Examples

>>> apiobj = self.{risksenseobject}.connectors.delete(123,delete_tag=True,client_id=123)

get_jobs(connector_id, page_num=0, page_size=150, csvdump=False, client_id=None)[source]¶

Get the jobs associated with a connector.

Parameters:

connector_id (int) – The connector ID
page_num (int) – The page number of results to be returned
page_size (int) – The number of results to return per page
csvdump (bool) – Whether to dump the assessment history in a csv, true to dump and false to not dump
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned.

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_jobs(123,0,100,client_id=123)

Note

You can also dump the data of the connector jobs in a csv file. Just make csvdump as True:

>>>  self.{risksenseobject}.connectors.get_jobs(123,0,100,client_id=123,csvdump=True)

get_logs(connector_id, page_num=0, page_size=150, csvdump=False, client_id=None)[source]¶

Get the jobs associated with a connector.

Parameters:

connector_id (int) – The connector ID
page_num (int) – The page number of results to be returned
page_size (int) – The number of results to return per page
csvdump (bool) – Whether to dump the assessment history in a csv, true to dump and false to not dump
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned

Examples

>>> apiobj = self.{risksenseobject}.connectors.get_logs(123,0,100,client_id=123)

Note

You can also dump the data of the connector jobs in a csv file. Just make csvdump as True:

>>>  self.{risksenseobject}.connectors.get_logs(123,0,100,client_id=123,csvdump=True)

update_schedule(connector_id, schedule_freq, enabled, client_id=None, **kwargs)[source]¶

Update the schedule of an existing Connector.

Parameters:

connector_id (int) – Connector ID
schedule_freq (str) – The frequency for the connector to run. Connectors.ScheduleFreq.DAILY,Connectors.ScheduleFreq.WEEKLY, Connectors.ScheduleFreq.MONTHLY
enabled (bool) – Enable connector?
client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Keyword Arguments:

hour_of_day (int) – The time the connector should run. Req. for DAILY, WEEKLY, and MONTHLY. Integer. 0-23.
day_of_week (int) – The day of the week the connector should run. Req. for WEEKLY. Integer. 1-7
day_of_month (int) – The day of the month the connector should run. Req. for MONTHLY. Integer. 1-31

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.connectors.update_schedule(123,'DAILY',True,client_id=123,hour_of_day=0)

itsm_get_fields_for_ticket_type(ticket_type, connector_url, connector_name, api_key, username='admin', client_id=None)[source]¶

Get fields available for ticket type of a connector

Parameters:

ticket_type (str) – Ticket type
connector_url (str) – ITSM Connector URL
connector_name (str) – ITSM Connector Name
api_key (str) – ITSM API Key
username (str) – ITSM Username, defaults to ‘admin’
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.connectors.itsm_get_fields_for_ticket_type('incident','https://test.com','test','xxxx',client_id=123)

ivanti_itsm_fetch_customers(itsm_url, itsm_api_key, client_id=None)[source]¶

Fetch ITSM available customers

Parameters:

itsm_url (str) – ITSM Connector URL
itsm_api_key (str) – ITSM API Key
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.connectors.ivanti_itsm_fetch_customers('https://test.com','xxxx',client_id=123)

ivanti_itsm_fetch_fieldValue_wrt_dependentField(ticket_type, itsm_url, itsm_api_key, current_field, dependent_field, dependent_field_value, client_id=None)[source]¶

Fetch value for a ITSM connector field with respect to dependent field

Parameters:

ticket_type (str) – Ticket type
itsm_url (str) – ITSM Connector URL
itsm_api_key (str) – ITSM API Key
current_field (str) – Field that should be queried for available options
dependent_field (str) – Dependent field
dependent_field_value (str) – Dependent field value
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.connectors.ivanti_itsm_fetch_fieldValue_wrt_dependentField('incident','https://test.com','xxxx','category','status','test',client_id=123)

ivanti_itsm_fetch_validation(body, ticket_type, client_id=None)[source]¶

ITSM Connector field form validation

Parameters:

body (str) – Form validation request body
ticket_type (str) – Ticket type
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Note

Intercept this API endpoint /client/{clientId}/connector/ivanti/formValidation/ticketType/{ticket_type} in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

ivanti_itsm_fetch_releaseLink(itsm_url, itsm_api_key, client_id=None)[source]¶

Fetch available options for Release Link field

Parameters:

itsm_url (str) – ITSM Connector URL
itsm_api_key (str) – ITSM API Key
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.connectors.ivanti_itsm_fetch_releaseLink('https://test.com','xxxx',client_id=123)

ivanti_itsm_fetch_requestorLink(itsm_url, itsm_api_key, client_id=None)[source]¶

Fetch available options for Requestor Link field

Parameters:

itsm_url (str) – ITSM Connector URL
itsm_api_key (str) – ITSM API Key
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.connectors.ivanti_itsm_fetch_requestorLink('https://test.com','xxxx',client_id=123)

create_ivanti_itsm_connector(body, client_id=None)[source]¶

Create ITSM Connector

Parameters:

body (dict) – Ticket request body
client_id (typing.Optional[int]) – RS Client Id, defaults to None

Return type:

dict

Returns:

Jsonified response

Note

Intercept this API endpoint /client/{clientId}/connector in UI for ITSM connector to better understand the body that need to be sent using this function. Then, use this function in your automation.

Connectors (risksense_api.__subject.__connectors.__connectors)¶

Connectors (`risksense_api.subject.connectors.__connectors`)¶