private_vulnerability_reporting

Creates, updates, deletes, gets or lists a private_vulnerability_reporting resource.

Overview

Name	private_vulnerability_reporting
Type	Resource
Id	github.repos.private_vulnerability_reporting

Fields

The following fields are returned by SELECT queries:

check_private_vulnerability_reporting

Private vulnerability reporting status

Name	Datatype	Description
enabled	boolean	Whether or not private vulnerability reporting is enabled for the repository.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_private_vulnerability_reporting	select	owner, repo		Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "Evaluating the security settings of a repository".
enable_private_vulnerability_reporting	exec	owner, repo		Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "Privately reporting a security vulnerability."
disable_private_vulnerability_reporting	exec	owner, repo		Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "Privately reporting a security vulnerability".

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

check_private_vulnerability_reporting

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "Evaluating the security settings of a repository".

SELECT
enabled
FROM github.repos.private_vulnerability_reporting
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;

Lifecycle Methods

enable_private_vulnerability_reporting

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "Privately reporting a security vulnerability."

EXEC github.repos.private_vulnerability_reporting.enable_private_vulnerability_reporting 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required
;

disable_private_vulnerability_reporting

Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "Privately reporting a security vulnerability".

EXEC github.repos.private_vulnerability_reporting.disable_private_vulnerability_reporting 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required
;