team_slug parameter
" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations/ORG/team/TEAM_SLUG/external-groups" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('GET /organizations/{org}/team/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})" - } - ], - "summary": "List a connection between an external group and a team", - "x-github": { - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "external-groups" - }, - "slug": "list-a-connection-between-an-external-group-and-a-team", - "category": "teams", - "subcategory": "external-groups", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response
", - "payload": "{\n \"groups\": [\n {\n \"group_id\": \"123\",\n \"group_name\": \"Octocat admins\",\n \"updated_at\": \"2021-01-24T11:31:04-06:00\"\n },\n {\n \"group_id\": \"456\",\n \"group_name\": \"Octocat docs members\",\n \"updated_at\": \"2021-03-24T11:31:04-06:00\"\n }\n ]\n}" - } - ] - }, { "verb": "get", "requestPath": "/orgs/{org}/external-group/{group_id}", @@ -85877,6 +85822,61 @@ } ] }, + { + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "team_slug parameter
" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/external-groups" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})" + } + ], + "summary": "List a connection between an external group and a team", + "x-github": { + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + }, + "slug": "list-a-connection-between-an-external-group-and-a-team", + "category": "teams", + "subcategory": "external-groups", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response
", + "payload": "{\n \"groups\": [\n {\n \"group_id\": \"123\",\n \"group_name\": \"Octocat admins\",\n \"updated_at\": \"2021-01-24T11:31:04-06:00\"\n },\n {\n \"group_id\": \"456\",\n \"group_name\": \"Octocat docs members\",\n \"updated_at\": \"2021-03-24T11:31:04-06:00\"\n }\n ]\n}" + } + ] + }, { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 503a5595ea..0b9f09eb80 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -63769,126 +63769,6 @@ } } }, - "/organizations/{org}/team/{team_slug}/external-groups": { - "get": { - "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/teams#list-external-idp-group-team-connection" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name of the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string", - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "external-groups" - } - } - }, "/orgs/{org}": { "get": { "summary": "Get an organization", @@ -133710,6 +133590,124 @@ } }, "/orgs/{org}/teams/{team_slug}/external-groups": { + "get": { + "summary": "List a connection between an external group and a team", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-external-idp-group-team-connection" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + } + }, "patch": { "summary": "Update the connection between an external group and a team", "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",