From ebe5a69bd924d7514bd64890a29ee25f281f58e2 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Wed, 18 May 2022 02:54:18 -0700 Subject: [PATCH] Update OpenAPI Descriptions (#27778) --- content/rest/enterprise-admin/audit-log.md | 1 + lib/rest/static/apps/enabled-for-apps.json | 6 + lib/rest/static/decorated/api.github.com.json | 132 ++- lib/rest/static/decorated/ghes-3.1.json | 20 +- lib/rest/static/decorated/ghes-3.2.json | 20 +- lib/rest/static/decorated/ghes-3.3.json | 22 +- lib/rest/static/decorated/ghes-3.4.json | 24 +- lib/rest/static/decorated/ghes-3.5.json | 24 +- lib/rest/static/decorated/github.ae.json | 820 +++++++++++++++++- .../dereferenced/api.github.com.deref.json | 126 ++- .../static/dereferenced/ghes-3.1.deref.json | 14 +- .../static/dereferenced/ghes-3.2.deref.json | 14 +- .../static/dereferenced/ghes-3.3.deref.json | 16 +- .../static/dereferenced/ghes-3.4.deref.json | 18 +- .../static/dereferenced/ghes-3.5.deref.json | 18 +- .../static/dereferenced/github.ae.deref.json | 818 ++++++++++++++++- 16 files changed, 1936 insertions(+), 157 deletions(-) diff --git a/content/rest/enterprise-admin/audit-log.md b/content/rest/enterprise-admin/audit-log.md index 7fa5096e211d..d0c27c5eb851 100644 --- a/content/rest/enterprise-admin/audit-log.md +++ b/content/rest/enterprise-admin/audit-log.md @@ -5,6 +5,7 @@ versions: fpt: '*' ghes: '>=3.3' ghec: '*' + ghae: '*' topics: - API miniTocMaxHeadingLevel: 3 diff --git a/lib/rest/static/apps/enabled-for-apps.json b/lib/rest/static/apps/enabled-for-apps.json index 5f0355ad3225..eca5606544ac 100644 --- a/lib/rest/static/apps/enabled-for-apps.json +++ b/lib/rest/static/apps/enabled-for-apps.json @@ -21181,6 +21181,12 @@ "verb": "patch", "requestPath": "/orgs/{org}" }, + { + "slug": "get-the-audit-log-for-an-organization", + "subcategory": "orgs", + "verb": "get", + "requestPath": "/orgs/{org}/audit-log" + }, { "slug": "list-organization-webhooks", "subcategory": "webhooks", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index b801eacd11c7..e92f91adc09d 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -467088,7 +467088,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -470054,7 +470054,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -473020,7 +473020,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -509618,6 +509618,7 @@ "example": [ { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -509640,7 +509641,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -509649,6 +509651,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "string" } ], @@ -509665,6 +509668,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -509754,6 +509766,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -509770,7 +509785,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -509806,6 +509822,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -509826,7 +509848,8 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } } @@ -509867,6 +509890,16 @@ "subcategory": "gpg-keys", "parameters": [], "bodyParameters": [ + { + "description": "

A descriptive name for the new key.

", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "A descriptive name for the new key.", + "isRequired": false, + "childParamsGroups": [] + }, { "description": "

A GPG key in ASCII-armored format.

", "type": "string", @@ -509893,6 +509926,7 @@ "description": "

Response

", "example": { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -509915,7 +509949,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -509924,6 +509959,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" }, "schema": { @@ -509937,6 +509973,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -510026,6 +510071,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -510042,7 +510090,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -510078,6 +510127,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -510098,7 +510153,8 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } } @@ -510169,6 +510225,7 @@ "description": "

Response

", "example": { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -510191,7 +510248,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -510200,6 +510258,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" }, "schema": { @@ -510213,6 +510272,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -510302,6 +510370,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -510318,7 +510389,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -510354,6 +510426,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -510374,7 +510452,8 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } } @@ -510525,6 +510604,7 @@ "example": [ { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -510547,7 +510627,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -510556,6 +510637,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "string" } ], @@ -510572,6 +510654,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -510661,6 +510752,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -510677,7 +510771,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -510713,6 +510808,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -510733,7 +510834,8 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } } diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 9a6877403673..6b6a3055fe16 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -153966,7 +153966,7 @@ } } ], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

\n

If you pass the hellcat-preview media type, you can also update the LDAP mapping of a child team.

", + "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

\n

If you pass the hellcat-preview media type, you can also update the LDAP mapping of a child team.

", "statusCodes": [ { "httpStatusCode": "200", @@ -159837,11 +159837,11 @@ }, { "type": "string", - "description": "

Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.

", + "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", + "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.1/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", "isRequired": false, "childParamsGroups": [] } @@ -161956,11 +161956,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.1/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -161984,7 +161984,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -162013,11 +162013,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.1/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -162041,7 +162041,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", "statusCodes": [ { "httpStatusCode": "204", @@ -362393,7 +362393,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 4d2e4e863b71..761def5f35d5 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -159686,7 +159686,7 @@ } } ], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

\n

If you pass the hellcat-preview media type, you can also update the LDAP mapping of a child team.

", + "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

\n

If you pass the hellcat-preview media type, you can also update the LDAP mapping of a child team.

", "statusCodes": [ { "httpStatusCode": "200", @@ -165564,11 +165564,11 @@ }, { "type": "string", - "description": "

Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.

", + "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", + "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", "isRequired": false, "childParamsGroups": [] } @@ -167699,11 +167699,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -167727,7 +167727,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -167756,11 +167756,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -167784,7 +167784,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", "statusCodes": [ { "httpStatusCode": "204", @@ -370879,7 +370879,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 1a97168db594..7c2969632f35 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -160311,7 +160311,7 @@ } ], "previews": [], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", + "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", "statusCodes": [ { "httpStatusCode": "200", @@ -166146,11 +166146,11 @@ }, { "type": "string", - "description": "

Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.

", + "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", + "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", "isRequired": false, "childParamsGroups": [] } @@ -168281,11 +168281,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -168309,7 +168309,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -168338,11 +168338,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -168366,7 +168366,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", "statusCodes": [ { "httpStatusCode": "204", @@ -366583,7 +366583,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -369535,7 +369535,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index ada620bdf8df..76bb02dd6c18 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -166524,7 +166524,7 @@ } ], "previews": [], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", + "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", "statusCodes": [ { "httpStatusCode": "200", @@ -172351,11 +172351,11 @@ }, { "type": "string", - "description": "

Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.

", + "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", + "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", "isRequired": false, "childParamsGroups": [] } @@ -174470,11 +174470,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.4/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -174498,7 +174498,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -174527,11 +174527,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.4/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -174555,7 +174555,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", "statusCodes": [ { "httpStatusCode": "204", @@ -384793,7 +384793,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -387745,7 +387745,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -390697,7 +390697,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 502924a81d6e..fdfbd60840a7 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -178331,7 +178331,7 @@ } ], "previews": [], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", + "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", "statusCodes": [ { "httpStatusCode": "200", @@ -184158,11 +184158,11 @@ }, { "type": "string", - "description": "

Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.

", + "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", + "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", "isRequired": false, "childParamsGroups": [] } @@ -186277,11 +186277,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -186305,7 +186305,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -186334,11 +186334,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -186362,7 +186362,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", "statusCodes": [ { "httpStatusCode": "204", @@ -397065,7 +397065,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -400031,7 +400031,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -402997,7 +402997,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 2a66c0522955..6b91ddab2d80 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -157308,6 +157308,406 @@ ] } ], + "audit-log": [ + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/audit-log", + "title": "Get the audit log for an enterprise", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "

A search phrase. For more information, see Searching the audit log.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "description": "

The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.

\n

The default is desc.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ] + } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#merge", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.merge", + "@timestamp": 1635940599755, + "created_at": 1635940599755, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", + "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", + "request_category": "other", + "controller_action": "merge", + "url": "https://example.com/octo-org/octo-repo/pull/1/merge", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1", + "actor_session": 1, + "pull_request_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_request_review_events#create", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "business_id": 1, + "org_id": 8, + "action": "pull_request_review.submit", + "@timestamp": 1635940593079, + "created_at": 1635940593079, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "PUT", + "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", + "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", + "actor_session": 1, + "spammy": false, + "pull_request_id": 1, + "body": null, + "allowed": true, + "id": 1, + "state": 40, + "issue_id": 1, + "review_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#create", + "device_cookie": null, + "actor": "mona", + "actor_id": 9, + "user_id": 9, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.create", + "@timestamp": 1635940554161, + "created_at": 1635940554161, + "operation_type": "create", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", + "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", + "client_id": 386351111.163594, + "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", + "actor_session": 2, + "pull_request_id": 1, + "category_type": "Resource Management" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." + }, + "actor_location": { + "type": "object", + "properties": { + "country_name": { + "type": "string" + } + } + }, + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { + "type": "string", + "description": "A unique identifier for an audit event." + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" + } + }, + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + } + ], "global-webhooks": [ { "serverUrl": "https://HOSTNAME/api/v3", @@ -163229,11 +163629,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/github-ae@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -163257,7 +163657,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -163286,11 +163686,11 @@ "bodyParameters": [ { "type": "string", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", + "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/github-ae@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "isRequired": false, "childParamsGroups": [] } @@ -163314,7 +163714,7 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", "statusCodes": [ { "httpStatusCode": "204", @@ -250581,6 +250981,404 @@ ], "subcategory": "orgs" }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/audit-log", + "title": "Get the audit log for an organization", + "category": "orgs", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "

A search phrase. For more information, see Searching the audit log.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "description": "

The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.

\n

The default is desc.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ] + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#merge", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.merge", + "@timestamp": 1635940599755, + "created_at": 1635940599755, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", + "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", + "request_category": "other", + "controller_action": "merge", + "url": "https://example.com/octo-org/octo-repo/pull/1/merge", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1", + "actor_session": 1, + "pull_request_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_request_review_events#create", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "business_id": 1, + "org_id": 8, + "action": "pull_request_review.submit", + "@timestamp": 1635940593079, + "created_at": 1635940593079, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "PUT", + "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", + "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", + "actor_session": 1, + "spammy": false, + "pull_request_id": 1, + "body": null, + "allowed": true, + "id": 1, + "state": 40, + "issue_id": 1, + "review_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#create", + "device_cookie": null, + "actor": "mona", + "actor_id": 9, + "user_id": 9, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.create", + "@timestamp": 1635940554161, + "created_at": 1635940554161, + "operation_type": "create", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", + "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", + "client_id": 386351111.163594, + "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", + "actor_session": 2, + "pull_request_id": 1, + "category_type": "Resource Management" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." + }, + "actor_location": { + "type": "object", + "properties": { + "country_name": { + "type": "string" + } + } + }, + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { + "type": "string", + "description": "A unique identifier for an audit event." + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" + } + }, + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ], + "subcategory": "orgs" + }, { "serverUrl": "https://HOSTNAME/api/v3", "verb": "get", @@ -257815,6 +258613,7 @@ } } ], + "previews": [], "descriptionHTML": "

Configures a GitHub AE Pages site. For more information, see \"About GitHub Pages.\"

", "statusCodes": [ { @@ -257830,9 +258629,6 @@ "description": "

Validation failed

" } ], - "previews": [ - "

Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.switcheroo-preview+json
" - ], "subcategory": "pages" }, { @@ -258027,6 +258823,7 @@ } ], "descriptionHTML": "", + "previews": [], "statusCodes": [ { "httpStatusCode": "204", @@ -258041,9 +258838,6 @@ "description": "

Validation failed

" } ], - "previews": [ - "

To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json

" - ], "subcategory": "pages" }, { @@ -361458,7 +362252,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

", + "description": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.

", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 9f11a8d35a04..7193bcd7116a 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -26763,7 +26763,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -122540,7 +122540,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -436066,7 +436066,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -511568,6 +511568,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -511659,6 +511668,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -511679,7 +511691,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -511715,6 +511728,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -511735,7 +511754,8 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } }, @@ -511744,6 +511764,7 @@ "value": [ { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -511770,7 +511791,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -511779,6 +511801,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "string" } ] @@ -511904,6 +511927,10 @@ "application/json": { "schema": { "properties": { + "name": { + "description": "A descriptive name for the new key.", + "type": "string" + }, "armored_public_key": { "description": "A GPG key in ASCII-armored format.", "type": "string" @@ -511933,6 +511960,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -512024,6 +512060,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -512044,7 +512083,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -512080,6 +512120,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -512100,13 +512146,15 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] }, "examples": { "default": { "value": { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -512133,7 +512181,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -512142,6 +512191,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" } } @@ -512353,6 +512403,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -512444,6 +512503,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -512464,7 +512526,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -512500,6 +512563,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -512520,13 +512589,15 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] }, "examples": { "default": { "value": { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -512553,7 +512624,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -512562,6 +512634,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" } } @@ -565246,6 +565319,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "mastahyeti's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -565337,6 +565419,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -565357,7 +565442,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -565393,6 +565479,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -565413,7 +565505,8 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } }, @@ -565422,6 +565515,7 @@ "value": [ { "id": 3, + "name": "mastahyeti's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -565448,7 +565542,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -565457,6 +565552,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "raw_key": "string" } ] diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 59dd213e8822..87b4b97a1c08 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -1336,7 +1336,7 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.1/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.1/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.1/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" @@ -5169,7 +5169,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.1/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" } }, "required": [ @@ -366931,7 +366931,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -463209,7 +463209,7 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.1/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#http-verbs).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" @@ -463245,7 +463245,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.1/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } @@ -463261,7 +463261,7 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.1/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" @@ -463297,7 +463297,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.1/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 5966a1848688..8bfb50c20a57 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -1336,7 +1336,7 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" @@ -5176,7 +5176,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" } }, "required": [ @@ -376230,7 +376230,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -473297,7 +473297,7 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" @@ -473333,7 +473333,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } @@ -473349,7 +473349,7 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" @@ -473385,7 +473385,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index e44cc39047d6..5eb43679a453 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -1268,7 +1268,7 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" @@ -5030,7 +5030,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" } }, "required": [ @@ -99656,7 +99656,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -379799,7 +379799,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -476887,7 +476887,7 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" @@ -476923,7 +476923,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } @@ -476939,7 +476939,7 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" @@ -476975,7 +476975,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index d4ed2596c34c..24b5ac769bc1 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -1268,7 +1268,7 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.4/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.4/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" @@ -5022,7 +5022,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" } }, "required": [ @@ -33707,7 +33707,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -111452,7 +111452,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -396001,7 +396001,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -499450,7 +499450,7 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" @@ -499486,7 +499486,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.4/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } @@ -499502,7 +499502,7 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" @@ -499538,7 +499538,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.4/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 64b18fa06ed6..6b45be249bf6 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -1268,7 +1268,7 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.5/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.5/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" @@ -5022,7 +5022,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" } }, "required": [ @@ -34073,7 +34073,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -115703,7 +115703,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -407984,7 +407984,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.5/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -511954,7 +511954,7 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" @@ -511990,7 +511990,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } @@ -512006,7 +512006,7 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" @@ -512042,7 +512042,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 46c8e714941a..155225dfaa37 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -21302,6 +21302,402 @@ } } }, + "/enterprises/{enterprise}/audit-log": { + "get": { + "summary": "Get the audit log for an enterprise", + "operationId": "enterprise-admin/get-audit-log", + "description": "Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ] + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." + }, + "actor_location": { + "type": "object", + "properties": { + "country_name": { + "type": "string" + } + } + }, + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { + "type": "string", + "description": "A unique identifier for an audit event." + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" + } + }, + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#merge", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.merge", + "@timestamp": 1635940599755, + "created_at": 1635940599755, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", + "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", + "request_category": "other", + "controller_action": "merge", + "url": "https://example.com/octo-org/octo-repo/pull/1/merge", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1", + "actor_session": 1, + "pull_request_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_request_review_events#create", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "business_id": 1, + "org_id": 8, + "action": "pull_request_review.submit", + "@timestamp": 1635940593079, + "created_at": 1635940593079, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "PUT", + "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", + "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", + "actor_session": 1, + "spammy": false, + "pull_request_id": 1, + "body": null, + "allowed": true, + "id": 1, + "state": 40, + "issue_id": 1, + "review_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#create", + "device_cookie": null, + "actor": "mona", + "actor_id": 9, + "user_id": 9, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.create", + "@timestamp": 1635940554161, + "created_at": 1635940554161, + "operation_type": "create", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", + "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", + "client_id": 386351111.163594, + "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", + "actor_session": 2, + "pull_request_id": 1, + "category_type": "Resource Management" + } + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "audit-log" + } + } + }, "/feeds": { "get": { "summary": "Get feeds", @@ -55511,6 +55907,402 @@ } } }, + "/orgs/{org}/audit-log": { + "get": { + "summary": "Get the audit log for an organization", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nThis endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Resources in the REST API](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\"", + "operationId": "orgs/get-audit-log", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-audit-log" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ] + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." + }, + "actor_location": { + "type": "object", + "properties": { + "country_name": { + "type": "string" + } + } + }, + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { + "type": "string", + "description": "A unique identifier for an audit event." + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" + } + }, + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#merge", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.merge", + "@timestamp": 1635940599755, + "created_at": 1635940599755, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", + "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", + "request_category": "other", + "controller_action": "merge", + "url": "https://example.com/octo-org/octo-repo/pull/1/merge", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1", + "actor_session": 1, + "pull_request_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_request_review_events#create", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "business_id": 1, + "org_id": 8, + "action": "pull_request_review.submit", + "@timestamp": 1635940593079, + "created_at": 1635940593079, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "PUT", + "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", + "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", + "actor_session": 1, + "spammy": false, + "pull_request_id": 1, + "body": null, + "allowed": true, + "id": 1, + "state": 40, + "issue_id": 1, + "review_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#create", + "device_cookie": null, + "actor": "mona", + "actor_id": 9, + "user_id": 9, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.create", + "@timestamp": 1635940554161, + "created_at": 1635940554161, + "operation_type": "create", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", + "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", + "client_id": 386351111.163594, + "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", + "actor_session": 2, + "pull_request_id": 1, + "category_type": "Resource Management" + } + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": null + } + } + }, "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", @@ -309663,13 +310455,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "pages", - "previews": [ - { - "name": "switcheroo", - "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```" - } - ] + "subcategory": "pages" } }, "put": { @@ -310094,13 +310880,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "pages", - "previews": [ - { - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } - ] + "subcategory": "pages" } } }, @@ -359684,7 +360464,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -445734,7 +446514,7 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/github-ae@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" @@ -445770,7 +446550,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/github-ae@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } } @@ -445786,7 +446566,7 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/github-ae@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" @@ -445822,7 +446602,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/github-ae@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }