View Source GitHub.SecretScanning (GitHub REST API Client v0.3.1)

Provides API endpoints related to secret scanning

Link to this section Summary

Functions

List secret scanning alerts for an enterprise

List secret scanning alerts for an organization

List secret scanning alerts for a repository

List locations for a secret scanning alert

Link to this section Functions

Link to this function

get_alert(owner, repo, alert_number, opts \\ [])

View Source
@spec get_alert(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.SecretScanning.Alert.t()} | {:error, GitHub.Error.t()}

Get a secret scanning alert

Gets a single secret scanning alert detected in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

resources

Resources

Link to this function

list_alerts_for_enterprise(enterprise, opts \\ [])

View Source
@spec list_alerts_for_enterprise(
  String.t(),
  keyword()
) ::
  {:ok, [GitHub.Organization.SecretScanningAlert.t()]}
  | {:error, GitHub.Error.t()}

List secret scanning alerts for an enterprise

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.

Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a security manager.

The authenticated user must be a member of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope or security_events scope to use this endpoint.

options

Options

  • state: Set to open or resolved to only list secret scanning alerts in a specific state.
  • secret_type: A comma-separated list of secret types to return. By default all secret types are returned. See "Secret scanning patterns" for a complete list of secret types.
  • resolution: A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
  • sort: The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
  • direction: The direction to sort the results by.
  • per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  • before: A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
  • after: A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
  • validity: A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

resources

Resources

Link to this function

list_alerts_for_org(org, opts \\ [])

View Source
@spec list_alerts_for_org(
  String.t(),
  keyword()
) ::
  {:ok, [GitHub.Organization.SecretScanningAlert.t()]}
  | {:error, GitHub.Error.t()}

List secret scanning alerts for an organization

Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

options

Options

  • state: Set to open or resolved to only list secret scanning alerts in a specific state.
  • secret_type: A comma-separated list of secret types to return. By default all secret types are returned. See "Secret scanning patterns" for a complete list of secret types.
  • resolution: A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
  • sort: The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
  • direction: The direction to sort the results by.
  • page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  • per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  • before: A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.
  • after: A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.
  • validity: A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

resources

Resources

Link to this function

list_alerts_for_repo(owner, repo, opts \\ [])

View Source
@spec list_alerts_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.SecretScanning.Alert.t()]} | {:error, GitHub.Error.t()}

List secret scanning alerts for a repository

Lists secret scanning alerts for an eligible repository, from newest to oldest.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

options

Options

  • state: Set to open or resolved to only list secret scanning alerts in a specific state.
  • secret_type: A comma-separated list of secret types to return. By default all secret types are returned. See "Secret scanning patterns" for a complete list of secret types.
  • resolution: A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
  • sort: The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
  • direction: The direction to sort the results by.
  • page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  • per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  • before: A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.
  • after: A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.
  • validity: A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

resources

Resources

Link to this function

list_locations_for_alert(owner, repo, alert_number, opts \\ [])

View Source
@spec list_locations_for_alert(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.SecretScanning.Location.t()]} | {:error, GitHub.Error.t()}

List locations for a secret scanning alert

Lists all locations for a given secret scanning alert for an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

options

Options

resources

Resources

Link to this function

update_alert(owner, repo, alert_number, body, opts \\ [])

View Source
@spec update_alert(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.SecretScanning.Alert.t()} | {:error, GitHub.Error.t()}

Update a secret scanning alert

Updates the status of a secret scanning alert in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

resources

Resources