repository_advisories

Overview

Name	repository_advisories
Type	Resource
Id	github.security_advisories.repository_advisories

Fields

Name	Datatype	Description
description	string	A detailed description of what the advisory entails.
author	null	The author of the advisory.
closed_at	string	The date and time of when the advisory was closed, in ISO 8601 format.
collaborating_teams	array	A list of teams that collaborate on the advisory.
collaborating_users	array	A list of users that collaborate on the advisory.
created_at	string	The date and time of when the advisory was created, in ISO 8601 format.
credits	array
credits_detailed	array
cve_id	string	The Common Vulnerabilities and Exposures (CVE) ID.
cvss	object
cwe_ids	array	A list of only the CWE IDs.
cwes	array
ghsa_id	string	The GitHub Security Advisory ID.
html_url	string	The URL for the advisory.
identifiers	array
private_fork	null	A temporary private fork of the advisory's repository for collaborating on a fix.
published_at	string	The date and time of when the advisory was published, in ISO 8601 format.
publisher	null	The publisher of the advisory.
severity	string	The severity of the advisory.
state	string	The state of the advisory.
submission	object
summary	string	A short summary of the advisory.
updated_at	string	The date and time of when the advisory was last updated, in ISO 8601 format.
url	string	The API URL for the advisory.
vulnerabilities	array
withdrawn_at	string	The date and time of when the advisory was withdrawn, in ISO 8601 format.

Methods

Name	Accessible by	Required Params	Description
get_repository_advisory	SELECT	ghsa_id, owner, repo	Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. You can access any published security advisory on a public repository. You must authenticate using an access token with the repo scope or repository_advisories:read permission in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on the security advisory.
list_org_repository_advisories	SELECT	org	Lists repository security advisories for an organization. To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or repository_advisories:write permission.
list_repository_advisories	SELECT	owner, repo	Lists security advisories in a repository. You must authenticate using an access token with the repo scope or repository_advisories:read permission in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.
create_repository_advisory	INSERT	owner, repo, data__description, data__summary, data__vulnerabilities	Creates a new repository security advisory. You must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint. In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.
create_private_vulnerability_report	EXEC	owner, repo, data__description, data__summary	Report a security vulnerability to the maintainers of the repository. See "Privately reporting a security vulnerability" for more information about private vulnerability reporting.
create_repository_advisory_cve_request	EXEC	ghsa_id, owner, repo	If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "Requesting a CVE identification number." You may request a CVE for public repositories, but cannot do so for private repositories. You must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint. In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.
update_repository_advisory	EXEC	ghsa_id, owner, repo	Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. You must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint. In order to update any security advisory, you must be a security manager or administrator of that repository, or a collaborator on the repository security advisory.