Enterprise Server 3.21 は、現在リリース候補として使用できます。

Reference documentation for GraphQL schema types in the GitHub Apps category.

この記事で

Objects

App

Object

A GitHub App.

App 実装

App のフィールド

名前説明

clientId (String)

The client ID of the app.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the app.

id (ID!)

The Node ID of the App object.

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses of the app.

ipAllowListEntries の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

logoUrl (URI!)

A URL pointing to the app's logo.

logoUrl の引数

  • size (Int)

    The size of the resulting image.

name (String!)

The name of the app.

slug (String!)

A slug based on the name of the app for use in URLs.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The URL to the app's homepage.

Bot

Object

A special type of user which takes actions on behalf of GitHub Apps.

Bot 実装

Bot のフィールド

名前説明

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

avatarUrl の引数

  • size (Int)

    The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Bot object.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTTP path for this bot.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this bot.

Interfaces

OauthApplicationAuditEntryData

Interface

Metadata for an audit entry with action oauth_application.*.

OauthApplicationAuditEntryData は次で実装されています

OauthApplicationAuditEntryData のフィールド

名前説明

oauthApplicationName (String)

The name of the OAuth application.

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth application.

oauthApplicationUrl (URI)

The HTTP URL for the OAuth application.

Enums

OauthApplicationCreateAuditEntryState

Enum

The state of an OAuth application when it was created.

OauthApplicationCreateAuditEntryState の値です。

名前説明
ACTIVE

The OAuth application was active and allowed to have OAuth Accesses.

PENDING_DELETION

The OAuth application was in the process of being deleted.

SUSPENDED

The OAuth application was suspended from generating OAuth Accesses due to abuse or security concerns.