invitation_teams
Creates, updates, deletes, gets or lists an invitation_teams resource.
Overview
| Name | invitation_teams |
| Type | Resource |
| Id | github.orgs.invitation_teams |
Fields
The following fields are returned by SELECT queries:
- list_invitation_teams
Response
| Name | Datatype | Description |
|---|---|---|
id | integer | |
name | string | |
enterprise_id | integer | Unique identifier of the enterprise to which this team belongs |
node_id | string | |
organization_id | integer | Unique identifier of the organization to which this team belongs |
description | string | |
html_url | string (uri) | (example: https://github.com/orgs/rails/teams/core) |
members_url | string | |
notification_setting | string | |
parent | object | Groups of organization members that gives permissions on specified repositories. (title: Team Simple) |
permission | string | |
permissions | object | |
privacy | string | |
repositories_url | string (uri) | |
slug | string | |
type | string | The ownership type of the team (enterprise, organization) |
url | string (uri) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_invitation_teams | select | org, invitation_id | per_page, page | List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
invitation_id | integer | The unique identifier of the invitation. |
org | string | The organization name. The name is not case sensitive. |
page | integer | The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
per_page | integer | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
SELECT examples
- list_invitation_teams
List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
SELECT
id,
name,
enterprise_id,
node_id,
organization_id,
description,
html_url,
members_url,
notification_setting,
parent,
permission,
permissions,
privacy,
repositories_url,
slug,
type,
url
FROM github.orgs.invitation_teams
WHERE org = '{{ org }}' -- required
AND invitation_id = '{{ invitation_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;