Module types/output
APIs
- BranchProtectionRequiredPullRequestReviews
- BranchProtectionRequiredStatusChecks
- BranchProtectionRestrictions
- GetCollaboratorsCollaborator
- GetOrganizationTeamSyncGroupsGroup
- OrganizationWebhookConfiguration
- RepositoryTemplate
- RepositoryWebhookConfiguration
- TeamSyncGroupMappingGroup
APIs
interface BranchProtectionRequiredPullRequestReviews
interface BranchProtectionRequiredPullRequestReviewsproperty dismissStaleReviews
dismissStaleReviews?: undefined | false | true;property dismissalTeams
dismissalTeams?: string[];property dismissalUsers
dismissalUsers?: string[];property includeAdmins
includeAdmins?: undefined | false | true;property requireCodeOwnerReviews
requireCodeOwnerReviews?: undefined | false | true;property requiredApprovingReviewCount
requiredApprovingReviewCount?: undefined | number;interface BranchProtectionRequiredStatusChecks
interface BranchProtectionRequiredStatusChecksproperty contexts
contexts?: string[];property includeAdmins
includeAdmins?: undefined | false | true;property strict
strict?: undefined | false | true;interface BranchProtectionRestrictions
interface BranchProtectionRestrictionsproperty apps
apps?: string[];property teams
teams?: string[];property users
users?: string[];interface GetCollaboratorsCollaborator
interface GetCollaboratorsCollaboratorproperty eventsUrl
eventsUrl: string;The GitHub API URL for the collaborator’s events.
property followersUrl
followersUrl: string;The GitHub API URL for the collaborator’s followers.
property followingUrl
followingUrl: string;The GitHub API URL for those following the collaborator.
property gistsUrl
gistsUrl: string;The GitHub API URL for the collaborator’s gists.
property htmlUrl
htmlUrl: string;The GitHub HTML URL for the collaborator.
property id
id: number;The ID of the collaborator.
property login
login: string;The collaborator’s login.
property organizationsUrl
organizationsUrl: string;The GitHub API URL for the collaborator’s organizations.
property permission
permission: string;The permission of the collaborator.
property receivedEventsUrl
receivedEventsUrl: string;The GitHub API URL for the collaborator’s received events.
property reposUrl
reposUrl: string;The GitHub API URL for the collaborator’s repositories.
property siteAdmin
siteAdmin: boolean;Whether the user is a GitHub admin.
property starredUrl
starredUrl: string;The GitHub API URL for the collaborator’s starred repositories.
property subscriptionsUrl
subscriptionsUrl: string;The GitHub API URL for the collaborator’s subscribed repositories.
property type
type: string;The type of the collaborator (ex. user).
property url
url: string;The GitHub API URL for the collaborator.
interface GetOrganizationTeamSyncGroupsGroup
interface GetOrganizationTeamSyncGroupsGroupproperty groupDescription
groupDescription: string;The description of the IdP group.
property groupId
groupId: string;The ID of the IdP group.
property groupName
groupName: string;The name of the IdP group.
interface OrganizationWebhookConfiguration
interface OrganizationWebhookConfigurationproperty contentType
contentType?: undefined | string;property insecureSsl
insecureSsl?: undefined | false | true;property secret
secret?: undefined | string;property url
url: string;URL of the webhook
interface RepositoryTemplate
interface RepositoryTemplateproperty owner
owner: string;property repository
repository: string;interface RepositoryWebhookConfiguration
interface RepositoryWebhookConfigurationproperty contentType
contentType?: undefined | string;property insecureSsl
insecureSsl?: undefined | false | true;property secret
secret?: undefined | string;property url
url: string;URL of the webhook
interface TeamSyncGroupMappingGroup
interface TeamSyncGroupMappingGroupproperty groupDescription
groupDescription: string;The description of the IdP group.
property groupId
groupId: string;The ID of the IdP group.
property groupName
groupName: string;The name of the IdP group.