{"meta":{"title":"Enterpriseアカウントの管理","intro":"Enterpriseアカウントと、そのアカウントが所有するOrganizationをGraphQL APIで管理できます。","product":"GraphQL API","breadcrumbs":[{"href":"/ja/enterprise-server@3.17/graphql","title":"GraphQL API"},{"href":"/ja/enterprise-server@3.17/graphql/guides","title":"ガイド"},{"href":"/ja/enterprise-server@3.17/graphql/guides/managing-enterprise-accounts","title":"Enterprise アカウントを管理する"}],"documentType":"article"},"body":"# Enterpriseアカウントの管理\n\nEnterpriseアカウントと、そのアカウントが所有するOrganizationをGraphQL APIで管理できます。\n\n## GraphQLでのEnterpriseアカウントの管理について\n\nOrganizationをモニターし、変更を行ってコンプライアンスを維持しやすくするために、Enterprise Accounts API及びAudit Log APIを利用できます。これらはGraphQL APIでのみ利用できます。\n\nエンタープライズ アカウント エンドポイントは、GitHub Enterprise Cloud と GitHub Enterprise Server の両方で機能します。\n\nGraphQL を使用すると、指定したデータのみを要求し、返すことができます。 たとえば、組織に追加された新しい組織メンバーの情報をすべて表示するには、GraphQL クエリ (つまり情報の要求) を作成します。 また、Enterprise アカウントに管理者を招待するための変化 (変更) を加えることもできます。\n\n監査ログ API を使用すると、誰かが次のような操作を行ったタイミングを監視できます。\n\n* 組織またはリポジトリの設定にアクセスする。\n* アクセス許可を変更する。\n* 組織、リポジトリ、またはチームのユーザーを追加または削除する。\n* ユーザーを管理者に昇格させる。\n* GitHub アプリのアクセス許可を変更します。\n\nAudit Log API を使用すると、監査ログ データのコピーを保持できます。 Audit Log APIで発行するクエリについては、GraphQLのレスポンスには最大で90から120日分のデータが含まれることがあります。 Audit Log API で使用できるフィールドの一覧については、「[企業管理](/ja/enterprise-server@3.17/graphql/reference/enterprise-admin#interface-auditentry)」を参照してください。\n\nエンタープライズアカウントAPIを利用すると、以下のことができます。\n\n* 貴社のEnterpriseアカウントに属するすべての組織とリポジトリを列挙して確認してください。\n* Enterpriseアカウントの設定変更。\n* エンタープライズアカウントおよびその組織の設定のためのポリシーを構成します。\n* エンタープライズアカウントに管理者を招待する。\n* 企業アカウント内で新しい組織を作成する。\n\nEnterprise Accounts API で使用できるフィールドの一覧については、「[Enterpriseアカウントの管理](/ja/enterprise-server@3.17/graphql/guides/managing-enterprise-accounts#graphql-fields-and-types-for-the-enterprise-accounts-api)」を参照してください。\n\n## エンタープライズ アカウントに GraphQL を使用するGetting started\n\nGraphQL を使用してエンタープライズ アカウントを管理し始めるには、[GraphQL クライアントの使用](/ja/enterprise-server@3.17/graphql/guides/using-graphql-clients) を参照してください。\n\nクエリの例については、「[Enterprise アカウント API を使ったクエリの例](#an-example-query-using-the-enterprise-accounts-api)」を参照してください。\n\n### 1. お使いの personal access token で認証します\n\n1. GraphQL で認証するには、開発者設定から personal access token を生成する必要があります。 詳細については、「[個人用アクセス トークンを管理する](/ja/enterprise-server@3.17/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)」を参照してください。\n\n2. アクセスしたい組織内の領域に対して、personal access token に管理者権限とフル コントロール権限を付与します。 プライベート リポジトリ、組織、チーム、ユーザー データ、エンタープライズ課金データとプロファイル データへのアクセスに対する完全なアクセス許可については、 personal access tokenに対して次のスコープを選択することをお勧めします。\n\n * `repo`\n * `admin:org`\n * `user`\n * `admin:enterprise`\n\n Enterpriseアカウントに固有のスコープは以下のとおりです。\n\n * `admin:enterprise`: Enterprise のフル コントロールを付与します (`manage_runners:enterprise`、`manage_billing:enterprise`、`read:enterprise` を含みます)\n * `manage_billing:enterprise`: エンタープライズ課金データの読み取りと書き込み。\n * `manage_runners:enterprise`: GitHub Actions エンタープライズ ランナーとランナー グループを管理するアクセス権。\n * `read:enterprise`: エンタープライズのプロファイル データを読み取ります。\n\n3. personal access tokenをコピーし、GraphQL クライアントに追加するまで安全な場所に保管します。\n\n### 2. GraphQL クライアントの選択\n\nGraphiQLもしくはベースURLの設定ができる他のスタンドアローンのGraphQLクライアントを使うことをおすすめします。\n\n以下のGraphQLクライアントの利用を検討しても良いでしょう。\n\n* [Insomnia](https://support.insomnia.rest/article/176-graphql-queries)\n* [GraphiQL](https://www.gatsbyjs.org/docs/running-queries-with-graphiql/)\n* [Postman](https://learning.getpostman.com/docs/postman/sending_api_requests/graphql/)\n\nこの次のステップではInsomniaを使います。\n\n### 3. Insomnia アプリケーションを、エンタープライズアカウントで GitHub GraphQL API を使用するように設定する\n\n1. ベース URL と `POST` メソッドを GraphQL クライアントに追加します。 GraphQL を使用して情報 (クエリ)、変更情報 (変更)、または GitHub API を使用してデータを転送する場合、既定の HTTP メソッドは `POST` であり、ベース URL は次の構文に従います。\n * エンタープライズ インスタンスの場合: `https:///api/graphql`\n * GitHub Enterprise Cloud: `https://api.github.com/graphql`\n * GitHub Enterprise Cloud とデータ所在地の場合: `https://api.SUBDOMAIN.ghe.com/graphql`\n\n2. \\[認証] メニューを選択し、 **\\[ベアラー トークン]** をクリックします。 以前に別の認証方法を選択した場合、メニューには代わりにその方法ののラベルが付けられています (\\[基本認証] など)。\n\n![Insomnia の展開された \\[認証\\] メニューのスクリーンショット。 メニュー ラベル \\[認証\\] と \\[ベアラー トークン\\] オプションが濃いオレンジ色の枠線で囲まれています。](/assets/images/developer/graphql/insomnia-bearer-token-option.png)\n\n1. \\[TOKEN] フィールドに、前の手順の personal access token を入力します。\n\n![Insomnia の \\[ベアラー\\] 認証設定のスクリーンショット。 \\[TOKEN\\] フィールドが濃いオレンジ色の枠線で囲まれています。](/assets/images/developer/graphql/insomnia-base-url-and-pat.png)\n\n1. **\\[ヘッダー]** をクリックします。\n\n![Insomnia の設定タブのスクリーンショット。 \\[ヘッダー\\] タブが濃いオレンジ色の枠線で囲まれています。](/assets/images/developer/graphql/json-content-type-header.png)\n\n1. **\\[ヘッダー]** タブの **\\[追加]** をクリックします。\n2. \\[ヘッダー] フィールドに「`Content-Type`」と入力します。\n3. \\[値] フィールドに「`application/json`」と入力します。\n\nこれでクエリを実行する準備が整いました。\n\n## Enterprise Accounts APIを使ったクエリの例\n\nこの GraphQL クエリでは、Enterprise Accounts API を使用して、アプライアンスの各組織における `public` リポジトリの合計数を要求します。 このクエリをカスタマイズするには、`` をエンタープライズ アカウントのハンドルに置換します。 たとえば、エンタープライズ アカウントが `https://github.com/enterprises/octo-enterprise` にある場合は、`` を `octo-enterprise` に置き換えます。\n\n```graphql\nquery publicRepositoriesByOrganization($slug: String!) {\n enterprise(slug: $slug) {\n ...enterpriseFragment\n }\n}\n\nfragment enterpriseFragment on Enterprise {\n ... on Enterprise{\n name\n organizations(first: 100){\n nodes{\n name\n ... on Organization{\n name\n repositories(privacy: PUBLIC){\n totalCount\n }\n }\n }\n }\n }\n}\n\n# Passing our Enterprise Account as a variable\nvariables {\n \"slug\": \"\"\n}\n```\n\n次の GraphQL クエリの例では、エンタープライズ アカウント API を使用せずに各組織の `public` リポジトリの数を取得することがいかに困難であるかを示しています。 単一の変数だけをカスタマイズすれば済むようになることから、EnterpriseにとってGraphQLのEnterprise Accounts APIがこのタスクをシンプルにしてくれていることに注意してください。 このクエリをカスタマイズするには、`` や `` などを、インスタンスの組織名に置換します。\n\n```graphql\n# Each organization is queried separately\n{\n organizationOneAlias: organization(login: \"nameOfOrganizationOne\") {\n # How to use a fragment\n ...repositories\n }\n organizationTwoAlias: organization(login: \"nameOfOrganizationTwo\") {\n ...repositories\n }\n # organizationThreeAlias ... and so on up-to lets say 100\n}\n\n## How to define a fragment\nfragment repositories on Organization {\n name\n repositories(privacy: PUBLIC){\n totalCount\n }\n}\n```\n\n## 各Organizationに対して個別にクエリを行う\n\n```graphql\nquery publicRepositoriesByOrganization {\n organizationOneAlias: organization(login: \"\") {\n # How to use a fragment\n ...repositories\n }\n organizationTwoAlias: organization(login: \"\") {\n ...repositories\n }\n # organizationThreeAlias ... and so on up-to lets say 100\n}\n# How to define a fragment\nfragment repositories on Organization {\n name\n repositories(privacy: PUBLIC){\n totalCount\n }\n}\n```\n\nこのGraphQLクエリは、企業組織の直近5件のログエントリを取得します。 このクエリをカスタマイズするには、`` と `` を置換します。\n\n```graphql\n{\n organization(login: \"\") {\n auditLog(last: 5, query: \"actor:\") {\n edges {\n node {\n ... on AuditEntry {\n# Get Audit Log Entry by 'Action'\n action\n actorLogin\n createdAt\n# User 'Action' was performed on\n user{\n name\n email\n }\n }\n }\n }\n }\n }\n}\n```\n\nGraphQLの始め方に関する詳細については、[GraphQLの紹介](/ja/enterprise-server@3.17/graphql/guides/introduction-to-graphql) および [GraphQLでの呼び出しの作成](/ja/enterprise-server@3.17/graphql/guides/forming-calls-with-graphql) を参照してください。\n\n## Enterprise Accounts APIでのGraphQLのフィールドと型\n\nエンタープライズ アカウント API で使用できる新しいクエリ、ミューテーション、およびスキーマ定義型の詳細については、[GraphQL リファレンス ページ](/ja/enterprise-server@3.17/graphql)の詳細な GraphQL 定義が表示されているサイドバーを参照してください。\n\nGraphQL クライアント内から参照ドキュメントをaccessできます。 詳細については、「[GraphQL クライアントの使用](/ja/enterprise-server@3.17/graphql/guides/using-graphql-clients)」を参照してください。\n認証やレート制限の詳細など、その他の情報については、[guides](/ja/enterprise-server@3.17/graphql/guides)を参照してください。"}