| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|---|---|---|
| installation_id | number | インストールID | |
| app_id | number | アプリID | |
| created_at | number | アプリの作成時刻(Unixタイムスタンプ形式) | |
| repository_selection | string | リポジトリアクセス選択 | |
| read_permissions | リスト<string> | アプリのインストール時に付与される「読む」権限 | |
| write_permissions | リスト<string> | アプリのインストール時に書き込み権限が付与されます | |
| webhook_events | リスト<string> | アプリのインストール時にWebhookイベントを購読する | |
| app_name | string | アプリ名 | |
| app_slug | string | アプリのURLに分かりやすい名前 | |
| updated_at | number | アプリの更新時刻(Unixタイムスタンプ形式) | |
| admin_permissions | リスト<string> | アプリのインストール時に付与される管理者権限 |
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|---|---|---|
| bypass_force_push_allowances | リスト<object> | 「指定されたアクターによるブランチ保護のバイパスを許可する」設定で定義されているように、強制プッシュが制限されている場合でも、このブランチへの強制プッシュが許可されているユーザー、チーム、またはアプリのリスト。 | |
| name | string | 強制プッシュの制限をバイパスできるアクターの表示名。例: Manoj S | |
| id | string | GitHubシステムにおけるアクターの固有識別子。例:U_kgDOCu4R6w | |
| __typename | string | 強制プッシュの制限をバイパスできるアクターの種類(ユーザー、チーム、またはアプリ)。例:ユーザー | |
| login | string | アクターのユーザー名またはログイン識別子。例:ns-manojs | |
| restricts_review_dismissals | boolean | 「プルリクエストのレビューを却下できるユーザーを制限する」の設定で定義されているように、特定のユーザーのみがプルリクエストのレビューを却下できるかどうかを示します。例:True | |
| org | string | このブランチ保護ルールが適用されるリポジトリを所有する GitHub の組織。 | |
| requires_approving_reviews | boolean | 「プルリクエストのレビューをマージ前に必須にする」設定で定義されているように、プルリクエストのマージに指定数の承認レビューが必要かどうかを示します。ex: True | |
| required_approving_review_count | number | プルリクエストをマージする前に必要な承認レビューの数。GitHubでは、1〜6人の必須レビュアーを設定できます。例:4 | |
| dismisses_stale_reviews | boolean | 「新しいコミットがプッシュされたときに古いプルリクエストの承認を却下する」の設定で定義されているように、ブランチにプッシュされた新しいコミットによって、以前のプルリクエストのレビューが自動的に却下されるかどうかを示します。例:True | |
| creator_login | string | ブランチ保護ルールを作成したユーザーのGitHubユーザー名。例:ns-manojs | |
| required_status_check_contexts | リスト<string> | 「Status checks that are required」設定で指定された、マージを許可する前に合格しなければならないステータスチェックのリスト。例:['security-scan'] | |
| requires_linear_history | boolean | 「リニア履歴を必須にする」設定で定義されているように、マージコミットによるプルリクエストのマージがブロックされているかどうかを示します。When true, only squash and rebase merges are allowed.例:True | |
| allows_deletions | boolean | 「Allow deletions」設定で定義されているように、ブランチの削除が許可されているかどうかを示します。false(デフォルト)の場合、ブランチの削除はブロックされます。例:True | |
| rule_pattern | string | このルールが適用されるブランチ名のパターン(例:'main'、'develop'、'release/*')。ワイルドカードを使うことができます。例: develop | |
| requires_strict_status_checks | boolean | 「マージする前にブランチを最新の状態にすることを必須にする」の設定で定義されているように、マージする前にブランチがベースブランチに対して最新の状態になっている必要があるかどうかを示します。例:True | |
| requires_commit_signatures | boolean | 「署名付きコミットを必須にする」設定で定義されているように、すべてのコミットに GPG または S/MIME で署名する必要があるかどうかを示します。例: True | |
| requires_deployments | boolean | 特定の環境へのデプロイが成功することがプルリクエストのマージ前に必要かどうかを、「Require deployments to succeed before merging」設定に基づいて示します。例:False | |
| full_name | string | この組織におけるこのブランチ保護ルールとリポジトリの組み合わせに対する一意の識別子。例:server-module-29__develop | |
| id | string | GitHubのブランチ保護ルールの一意の識別子。API操作と追跡に使用します。例:BPR_kwDOOKjAzM4D00Zs | |
| requires_status_checks | boolean | 「Require status checks to pass before merging」設定で定義されている、プルリクエストをマージする前にステータスチェックが必要かどうかを示します。例:True | |
| requires_code_owner_reviews | boolean | 'Require review from Code Owners' 設定で定義されているように、プルリクエストが指定されたオーナーを持つコードを変更したときに、コードオーナーからの承認が必要かどうかを示します。例: True | |
| allows_force_pushes | boolean | 「Allow force pushes」設定で定義されているとおり、このブランチで強制プッシュが許可されているかどうかを示します。false(デフォルト)の場合、強制プッシュはブロックされます。例:True | |
| requires_conversation_resolution | boolean | 'Require conversation resolution before merging' 設定で定義されているように、プルリクエストをマージする前にすべての会話を解決する必要があるかどうかを示します。例:True | |
| lock_branch | boolean | 「ブランチのロック」設定で定義されているように、ブランチがロックされているかどうかを示します。trueの場合、ブランチは読み取り専用となり、特定の権限を持つユーザー以外は変更を加えることができません。例:False | |
| repository_name | string | Repository | このブランチ保護ルールが適用されるリポジトリの名前。例:server-module-29 |
| is_admin_enforced | boolean | 「上記の関与の設定のバイパスを許可しない」オプションで定義されているように、リポジトリ管理者がすべてのブランチ保護ルールに従う必要があるかどうかを示します。false の場合、管理者は制限をバイパスできます。例: True | |
| lock_allows_fetch_and_merge | boolean | ブランチがロックされている場合に、'Allow fork syncing' 設定で定義されているように、ユーザーがリポジトリをフォークしてロックされたブランチからアップデートを取得できるかどうかを示します。例:False | |
| required_deployment_environments | リスト<string> | 「必要なデプロイ」設定で指定されているように、マージが許可される前にデプロイが成功している必要がある環境のリスト。例: [] | |
| matching_refs | リスト<string> | このブランチ保護ルールパターンに一致するブランチ名のリスト。ex: ['開発'] | |
| review_dismissal_allowances | リスト<object> | 「Restrict who can dismiss pull request reviews」設定で定義されているように、プルリクエストのレビューの辞退が許可されているユーザー、チーム、またはアプリのリスト。レビュー辞退の制限が有効な場合にのみ関連します。 | |
| __typename | string | レビューを却下できるアクターのタイプ(ユーザー、チーム、またはアプリ)。例:ユーザー | |
| login | string | レビューの却下権限を持つアクターのユーザー名またはログイン識別子。例:ns-dmaurya | |
| name | string | レビューを非表示にできるアクターの表示名。例: Deepika Maurya | |
| id | string | GitHub システムにおけるアクターの一意識別子。例:U_kgDOBo_Qlg | |
| database_id | number | GitHub のシステムにおけるブランチ保護ルールの内部データベース識別子。例:64783499 | |
| bypass_pull_request_allowances | リスト<object> | 'Allow specified actors to bypass pull request requirements'設定で定義されているように、マージ時にプルリクエスト要件をバイパスできるユーザー、チーム、またはアプリのリスト。 | |
| name | string | プルリクエストの要件をバイパスできるアクターの表示名。例:Manoj S | |
| id | string | GitHubシステムにおけるアクターの固有識別子。例:U_kgDOCu4R6w | |
| __typename | string | pull requestの要件をバイパスできるアクターのタイプ(ユーザー、チーム、またはアプリ)。例:ユーザー | |
| login | string | アクターのユーザー名またはログイン識別子。例:ns-manojs | |
| repository_id | string | このブランチ保護ルールが適用されるリポジトリの一意の識別子。ex: R_kgDOPGYl5A | |
| restricts_pushes | boolean | 'Restrict who can push to matching branches' の設定で定義されているように、このブランチへのプッシュが特定の人、チーム、またはアプリに制限されているかどうかを示します。例:True | |
| push_allowances | リスト<object> | 'Restrict who can push to matching branches' が有効な場合に、このブランチへのプッシュが許可されているユーザー、チーム、またはアプリのリスト。 | |
| name | string | プッシュ権限を持つアクターの表示名。例:Manoj S | |
| id | string | GitHubシステムにおけるアクターの固有識別子。例:U_kgDOCu4R6w | |
| __typename | string | プッシュ権限を持つアクターの種類(ユーザー、チーム、またはアプリ)。例:ユーザー | |
| login | string | アクターのユーザー名またはログイン識別子。例:ns-manojs |
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|---|---|---|
| connectedAppName | string | 接続されたアプリケーションの名前。 | |
| riskScore | number | 接続されたアプリケーションに関連付けられたリスクスコア。 | |
| appID | string | 接続されたアプリケーションの一意の識別子 | |
| riskLevel | string | 接続されたアプリケーションに関連するリスクレベル。 | |
| permissionsMetadata | リスト<object> | 接続されたアプリケーションに関連付けられた各権限のメタデータ。 | |
| firstSeenTime | number | 権限が最初に確認された時点のタイムスタンプ。 | |
| removedTime | number | 権限が削除された時点のタイムスタンプ(削除されていない場合は0)。 | |
| riskScore | number | 許可のリスクスコア。リスクレベルが不明な場合は存在しません。 | |
| name | string | 権限の名前。 | |
| riskLevel | string | 許可のリスクレベル。 |
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|---|---|---|
| companyHTML | string | ユーザーの公開プロフィール会社をHTML形式で表示 | |
| isSiteAdmin | boolean | このユーザーがサイト管理者であるかどうか | |
| viewerCanChangePinnedItems | boolean | 閲覧者はリポジトリやgistをプロフィールにピン留めできますか? | |
| monthlyEstimatedSponsorsIncomeInCents | number | このユーザーのGitHub Sponsorsからの月間推定収入額(セント/米ドル) | |
| databaseId | number | データベースから主キーを識別します | |
| bio | string | ユーザーの公開プロフィール欄 | |
| isFollowingViewer | boolean | このユーザーが閲覧者をフォローしているかどうか | |
| isSponsoringViewer | boolean | 視聴者がこのユーザー/組織からスポンサーを受けているかどうか | |
| viewerIsFollowing | boolean | このユーザーが閲覧者にフォローされているかどうか | |
| followers | object | 指定されたユーザーの後に続くユーザーのリスト | |
| totalCount | number | 現在のユーザーをフォローしているユーザーの総数を特定します。 | |
| string | ユーザーの公開プロフィール 電子メール | ||
| company | string | ユーザーの公開プロフィール企業 | |
| isBountyHunter | boolean | このユーザーがGitHubセキュリティバグバウンティの参加者であるかどうか | |
| isViewer | boolean | このユーザーが閲覧ユーザーであるかどうか | |
| role | string | このユーザーが組織内で果たす役割 | |
| pinnedItemsRemaining | number | このプロフィール所有者が自分のプロフィールにピン留めできるアイテムの残り数を返します。 | |
| pronouns | string | ユーザーのプロフィールで使用されている代名詞 | |
| updatedAt | string | ユーザーが最後に更新された日時を識別します | |
| twitterUsername | string | ユーザーのTwitterユーザー名 | |
| repositories | object | ユーザーが所有するリポジトリのリスト | |
| totalCount | number | ユーザーが所有する公開リポジトリの総数を識別します。 | |
| isDeveloperProgramMember | boolean | このユーザーがGitHub開発者プログラムのメンバーであるかどうか | |
| isEmployee | boolean | このユーザーがGitHubの従業員であるかどうか | |
| viewerCanCreateProjects | boolean | 現在の閲覧者は、この所有者に対して新しいプロジェクトを作成できますか? | |
| projectsUrl | string | ユーザーのプロジェクト一覧を表示するHTTP URL | |
| viewerIsSponsoring | boolean | 視聴者がこのユーザーを支援しているかどうか | |
| recentProjects | object | このユーザーが所有者のコンテキストで最近変更したプロジェクト | |
| totalCount | number | ユーザーに関連付けられた最近のプロジェクトの総数を識別します。 | |
| repositoriesContributedTo | object | ユーザーが最近貢献したリポジトリのリスト | |
| totalCount | number | ユーザーに関連付けられたプルリクエストの総数を識別します。 | |
| totalDiskUsage | number | ユーザーに関連付けられているすべてのリポジトリの合計サイズ(キロバイト単位) | |
| following | object | 指定されたユーザーがフォローしているユーザーのリスト | |
| totalCount | number | 現在ユーザーがフォローしているユーザーの総数を表示します。 | |
| id | string | ユーザーのID | |
| avatarUrl | string | ユーザーの公開アバターを指すURL | |
| createdAt | string | ユーザーが作成された日時を識別します。 | |
| bioHTML | string | ユーザーの公開プロフィール(HTML形式) | |
| isGitHubStar | boolean | このユーザーがGitHub Starsプログラムのメンバーであるかどうか | |
| isHireable | boolean | ユーザーが雇用希望者として登録しているかどうか | |
| viewerCanFollow | boolean | 視聴者がユーザーをフォローできるかどうか | |
| anyPinnableItems | boolean | このリポジトリの所有者が、自分のプロフィールにピン留めできるアイテムを持っているかどうかを確認します。 | |
| hasSponsorsListing | boolean | このユーザーがGitHub Sponsorsに掲載されているかどうか | |
| location | string | ユーザーの公開プロフィールの場所 | |
| login | string | ログインに使うユーザー名 | |
| name | string | ユーザーの公開プロフィール名 | |
| resourcePath | string | このユーザーリソースのHTTPパス | |
| url | string | このユーザーのHTTP URL | |
| status | object | ユーザーの現在の行動に関するデスクリプション | |
| message | string | ユーザーが何をしているかを説明する短いメッセージ | |
| expiresAt | string | 設定されている場合、この日付以降はステータスが表示されなくなります。 | |
| updatedAt | string | オブジェクトが最後に更新された日時を識別します。 | |
| indicatesLimitedAvailability | boolean | このステータスは、ユーザーがGitHub上で完全には利用できないことを示しているかどうか | |
| createdAt | string | ステータスが作成された日時を識別します | |
| isCampusExpert | boolean | このユーザーがGitHubキャンパスエキスパートプログラムの参加者であるかどうか | |
| viewerCanSponsor | boolean | 視聴者がこのユーザーや組織をスポンサーできるかどうか | |
| canReceiveOrganizationEmailsWhenNotificationsRestricted | boolean | 組織が通知制限を有効にしている場合、このユーザーは電子メール通知を受け取ることができますか? | |
| estimatedNextSponsorsPayoutInCents | number | このユーザー/組織に対する次回のGitHubスポンサーの予想支払い(セント(USD) | |
| websiteUrl | string | ユーザーの公開ウェブサイト/ブログへのURL | |
| pullRequests | object | このユーザーに関連付けられたプルリクエストのリスト | |
| totalCount | number | ユーザーに関連付けられたプルリクエストの総数を識別します。 |
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|---|---|---|
| name | string | 組織名 | |
| public_gists_count | number | 組織の公開要点の数 | |
| two_factor_requirement_enabled | boolean | 組織がすべてのユーザーに2段階認証を義務付けているかどうか | |
| has_inactive_admin_users | boolean | 組織に非アクティブな管理者ユーザーがいるかどうか | |
| has_inactive_users | boolean | 組織に非アクティブなユーザーがいるかどうか | |
| default_repository_permission | string | メンバーが組織リポジトリに対して持つデフォルトの権限レベル。* 読む - このリポジトリをプルできますが、プッシュや管理はできません。 * 書き込み - プルとプッシュはできますが、このリポジトリを管理することはできません。* admin - このリポジトリのプル、プッシュ、および管理を行うことができます。* なし - デフォルトでは権限は付与されません。デフォルト:読む |
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|---|---|---|
| allow_update_branch | boolean | ベースブランチより遅れているプルリクエストのヘッドブランチは、マージ前に最新の状態にする必要がない場合でも、常に更新できるかどうか。 | |
| auto_merge_allowed | boolean | このリポジトリのプルリクエストで自動マージを有効にできるかどうか。 | |
| description | string | リポジトリのデスクリプション。 | |
| disk_usage | number | このリポジトリがディスク上で占めるキロバイト数。 | |
| is_archived | boolean | リポジトリがメンテナンスされていないかどうかを示します。 | |
| merge_commit_message | string | プルリクエストをマージする際に、デフォルトのコミットメッセージがどのように生成されるか。 | |
| merge_commit_title | string | プルリクエストをマージする際に、デフォルトのコミットタイトルがどのように生成されるか。 | |
| pushed_at | number | リポジトリに最後にコミットがプッシュされた日時(Unixタイムスタンプ形式) | |
| branch_protection_rule_bypass_admin_user | boolean | ブランチ保護ルールが管理者ユーザーをバイパスするかどうか | |
| has_wiki_enabled | boolean | リポジトリにWiki機能が有効になっているかどうかを示します。 | |
| is_mirror | boolean | リポジトリがミラーサイトかどうかを識別します。 | |
| viewer_default_merge_method | string | 最後の ビューアによるマージ方法、またはリポジトリのデフォルト。 | |
| viewer_has_starred | boolean | 閲覧ユーザーがこのスター付きアイテムにスターを付けたかどうかを示すブール値を返します。 | |
| visibility | string | リポジトリの可視性レベルを示します。 | |
| has_outside_collaborators | boolean | このリポジトリに外部の共同研究者がいる場合はtrueを返します。 | |
| has_discussions_enabled | boolean | リポジトリでディスカッション機能が有効になっているかどうかを示します。 | |
| is_empty | boolean | このリポジトリが空かどうかを返します。 | |
| web_commit_signoff_required | boolean | このリポジトリのウェブベースのコミットに対して、貢献者が承認が必要かどうか。 | |
| created_at | number | リポジトリの作成時刻(Unixタイムスタンプ形式) | |
| is_blank_issues_enabled | boolean | 空の課題の作成が許可されている場合はtrueを返します。 | |
| is_locked | boolean | リポジトリがロックされているかどうかを示します。 | |
| merge_commit_allowed | boolean | このリポジトリのマージコミットにプルリクエストがマージされるかどうか。 | |
| stargazer_count | number | この天体上にいる天体観測者の数を返します。 | |
| name | string | リポジトリ名 | |
| archived_at | number | リポジトリがアーカイブされた日時を特定します。 | |
| is_fork | boolean | リポジトリがフォークであるかどうかを識別します。 | |
| lock_reason | string | リポジトリがロックされた理由。 | |
| is_disabled | boolean | このリポジトリが無効になっているかどうかを返します。 | |
| is_user_configuration_repository | boolean | このリポジトリはユーザー設定リポジトリですか? | |
| squash_merge_allowed | boolean | このリポジトリでスクワッシュマージが有効になっているかどうか。 | |
| default_branch | object | リポジトリのデフォルトブランチ | |
| protection_rule | object | 支店保護規則 | |
| requires_approving_reviews | boolean | 承認されたレビューは、一致する支店を更新するために必要ですか? | |
| requires_status_checks | boolean | 一致するブランチを更新するには、ステータスチェックが必要ですか? | |
| dismisses_stale_reviews | boolean | マッチングブランチに新しいコミットをプッシュすると、プルリクエストのレビュー承認が却下されますか? | |
| allow_force_pushes | boolean | 枝に力を加えることを許可する | |
| allow_deletions | boolean | ブランチの削除を許可する | |
| required_approving_review_count | number | 一致する支店を更新するために必要な承認レビューの数。 | |
| name | string | 支店名 | |
| has_gitignore_file | boolean | デフォルトブランチに.gitignoreファイルがあるかどうかファイル。 | |
| has_codeowners_file | boolean | デフォルトブランチにCODEOWNERSファイルが存在するかどうか。 | |
| has_license_file | boolean | デフォルトブランチにLICENSEファイルが存在するかどうか。 | |
| has_issues_enabled | boolean | リポジトリに課題提出機能が有効になっているかどうかを示します。 | |
| uses_custom_open_graph_image | boolean | このリポジトリがOpen Graphで使うできるカスタム画像を持っているのか、それとも所有者のアバターで表現されているのか。 | |
| viewer_permission | string | リポジトリにおけるユーザーの権限レベル。GitHubアプリとして認証された場合はnullを返します。 | |
| delete_branch_on_merge | boolean | このリポジトリでブランチがマージされた際に、自動的に削除されるかどうか。 | |
| interaction_ability | object | このリポジトリのインタラクション機能設定。 | |
| expiresAt | string | 現在有効な制限が期限切れになる時刻。 | |
| limit | string | このオブジェクトに現在適用されている制限。 | |
| origin | string | 現在有効な相互作用制限の起源。 | |
| squash_merge_commit_title | string | プルリクエストをスカッシュマージする際に、デフォルトのコミットタイトルがどのように生成されるか。 | |
| viewer_can_subscribe | boolean | 閲覧者がリポジトリの購読ステータスを変更できるかどうかを確認してください。 | |
| private | boolean | リポジトリがプライベートかどうか | |
| is_security_policy_enabled | boolean | このリポジトリにセキュリティポリシーがある場合はtrueを返します。 | |
| forking_allowed | boolean | このリポジトリがフォークを許可しているかどうか。 | |
| squash_merge_commit_message | string | プルリクエストをスカッシュマージする際に、デフォルトのコミットメッセージがどのように生成されるか。 | |
| has_vulnerability_alerts_enabled | boolean | リポジトリに対して脆弱性アラートが有効になっているかどうか。 | |
| has_projects_enabled | boolean | リポジトリでプロジェクト機能が有効になっているかどうかを示します。 | |
| full_name | string | リポジトリの正式名称 | |
| is_template | boolean | リポジトリが使うテンプレートで新しいリポジトリを生成できるかどうかを特定します。 | |
| owner | object | リポジトリの所有者であるユーザー。 | |
| id | string | RepositoryOwnerオブジェクトのノードID。 | |
| login | string | ログイン用のユーザー名使う。 | |
| parent | object | これがフォークである場合、リポジトリの親。 | |
| name | string | リポジトリの名前。 | |
| id | string | リポジトリオブジェクトのノードID。 | |
| is_in_organization | boolean | リポジトリが組織所有か、組織リポジトリのプライベートフォークかを示します。 | |
| primary_language | object | リポジトリのコードの主要な言語。 | |
| color | string | 現在の言語に定義されている色。 | |
| id | string | 言語オブジェクトのノードID。 | |
| name | string | 現在使用されている言語の名前。 | |
| viewer_can_update_topics | boolean | 閲覧者がこのリポジトリのトピックを更新できるかどうかを示します。 | |
| viewer_subscription | string | 視聴者が購読対象コンテンツを視聴しているか、視聴していないか、無視しているかを識別します。 | |
| branch_protection_enabled_for_all_branches | boolean | すべてのブランチでブランチ保護が有効になっているかどうか | |
| secret_scanning_enabled | boolean | シークレットスキャンが有効になっているかどうか | |
| template_repository | object | このリポジトリが生成された元のリポジトリ(存在する場合)。 | |
| id | string | リポジトリオブジェクトのノードID。 | |
| name | string | リポジトリの名前。 | |
| viewer_can_administer | boolean | 閲覧者がこのリポジトリに対する管理者権限を持っているかどうかを示します。 | |
| fork_count | number | このリポジトリのフォーク数 | |
| viewer_can_create_projects | boolean | 現在の閲覧者は、この所有者に対して新しいプロジェクトを作成できますか? | |
| rebase_merge_allowed | boolean | このリポジトリでリベースマージが有効になっているかどうか。 |
| ATTRIBUTE | TYPE | 参照する | デスクリプション |
|---|