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

In this article

Objects

App

Object

A GitHub App.

App Implements

Fields for App

NameDescription

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.

Arguments for 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.

Arguments for 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 Implements

Fields for Bot

NameDescription

avatarUrl (URI!)

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

Arguments for 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 is implemented by

Fields for OauthApplicationAuditEntryData

NameDescription

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.

Values for OauthApplicationCreateAuditEntryState

NameDescription
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.