{"command":{"effect":"read","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth 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.","properties":{"path":{"type":"object","properties":{"org":{"type":"string","description":"The organization name. The name is not case sensitive."}},"required":["org"],"additionalProperties":false},"query":{"type":"object","properties":{"state":{"type":"string","enum":["open","resolved"],"description":"Set to `open` or `resolved` to only list secret scanning alerts in a specific state."},"secret_type":{"type":"string","description":"A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types."},"exclude_secret_types":{"type":"string","description":"A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types."},"exclude_providers":{"type":"string","description":"A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter."},"providers":{"type":"string","description":"A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter."},"resolution":{"type":"string","description":"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`."},"assignee":{"type":"string","description":"Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user."},"sort":{"type":"string","enum":["created","updated"],"default":"created","description":"The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved."},"direction":{"type":"string","enum":["asc","desc"],"default":"desc","description":"The direction to sort the results by."},"page":{"type":"integer","default":1,"description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""},"per_page":{"type":"integer","default":30,"description":"The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""},"before":{"type":"string","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). 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":{"type":"string","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). 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":{"type":"string","description":"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`."},"is_publicly_leaked":{"type":"boolean","default":false,"description":"A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present."},"is_multi_repo":{"type":"boolean","default":false,"description":"A boolean value representing whether or not to filter alerts by the multi-repo tag being present."},"hide_secret":{"type":"boolean","default":false,"description":"A boolean value representing whether or not to hide literal secrets in the results."},"is_bypassed":{"type":"boolean","description":"A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned."},"included_metadata":{"type":"string","description":"A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`."},"owner_email_hash":{"type":"string","description":"Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned."}},"required":[],"additionalProperties":false}},"required":["path"],"additionalProperties":false},"name":"List secret scanning alerts for an organization","id":"github.secret-scanning.list-alerts-for-org","example":{"path":{"org":"example"}},"maxRequests":1,"summary":false}}