{ "opencollection": "1.0.0", "info": { "name": "Github Enterprise API", "version": "1.1.4" }, "items": [ { "info": { "name": "Enterprise", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get Github Enterprise Server Meta Information", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/meta" }, "docs": "The GitHub Meta API's GET /meta endpoint retrieves essential metadata and configuration information about a GitHub Enterprise Server instance. This operation provides details such as IP address ranges used by GitHub services, supported SSH key fingerprints, webhook IP addresses, and other infrastructure-related information that is useful for network configuration, firewall rules, and security policies. The endpoint requires no authentication and returns data in JSON format, making it a straightf" }, { "info": { "name": "GitHub Get Github Enterprise Server Pages Site", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets information about a GitHub Enterprise Server Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create Github Enterprise Server Pages Site", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update Information About Github Enterprise Server Pages Site", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete Github Enterprise Server Pages Site", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Deletes a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Github Enterprise Server Pages Builds", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists builts of a GitHub Enterprise Server Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Request Github Enterprise Server Pages Build", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until th" }, { "info": { "name": "GitHub Get Github Enterprise Server Pages Build", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds/:build_id", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "build_id", "value": "42", "type": "path" } ] }, "docs": "Gets information about a GitHub Enterprise Server Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Provisioned Scim Groups for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups", "params": [ { "name": "filter", "value": "example_value", "type": "query", "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`." }, { "name": "excludedAttributes", "value": "", "type": "query", "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time." }, { "name": "startIndex", "value": "", "type": "query", "description": "Used for pagination: the starting index of the first result to return when paginating through values." }, { "name": "count", "value": "", "type": "query", "description": "Used for pagination: the number of results to return per page." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response." }, { "info": { "name": "GitHub Provision Scim Enterprise Group", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups", "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user." }, { "info": { "name": "GitHub Get Scim Provisioning Information for an Enterprise Group", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." }, { "name": "excludedAttributes", "value": "", "type": "query", "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group." }, { "info": { "name": "GitHub Set Scim Information for Provisioned Enterprise Group", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-" }, { "info": { "name": "GitHub Update an Attribute for Scim Enterprise Group", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add gro" }, { "info": { "name": "GitHub Delete Scim Group from an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise." }, { "info": { "name": "GitHub List Scim Provisioned Identities for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users", "params": [ { "name": "filter", "value": "example_value", "type": "query", "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`." }, { "name": "startIndex", "value": "", "type": "query", "description": "Used for pagination: the starting index of the first result to return when paginating through values." }, { "name": "count", "value": "", "type": "query", "description": "Used for pagination: the number of results to return per page." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permane" }, { "info": { "name": "GitHub Provision Scim Enterprise User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users", "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The u" }, { "info": { "name": "GitHub Get Scim Provisioning Information for an Enterprise User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user." }, { "info": { "name": "GitHub Set Scim Information for Provisioned Enterprise User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) end" }, { "info": { "name": "GitHub Update an Attribute for Scim Enterprise User", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `" }, { "info": { "name": "GitHub Delete Scim User from an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action." } ] } ], "bundled": true }