For the complete documentation index, see llms.txt. This page is also available as Markdown.

gitHubAppSelfHostedCredentials

Credentials for a customer-registered self-hosted GitHub App.

Examples

type GitHubAppSelfHostedCredentials {
  gitHubAppOxId: String
  gitHubAppId: String
  appSlug: String
  clientId: String
  baseUrl: String
  enterpriseServer: Boolean
  privateKey: String
  clientSecret: String
  webhookSecret: String
  installUrl: String
  webhookUrl: String
  installationId: Int
  installationToken: String
  credentialsId: String
  credentialsName: String
  tokenExpirationDate: String
  credentialsType: CredentialsType
  isCertChecksDisabled: Boolean
  hostURL: String
  iv: String
  monitoredResources: JSON
  monitorAllResources: Boolean
  monitorAllNewlyCreatedResources: Float
  brokerUsername: String
  brokerPassword: String
  brokerEnabled: Boolean
  brokerHost: String
  brokerPort: Int
}

Fields

Field
Description
Supported fields

gitHubAppOxId String

OX-internal identifier for this registration (shg--)

gitHubAppId String

GitHub numeric App ID

appSlug String

GitHub App slug (URL-friendly name)

clientId String

GitHub OAuth client ID (plaintext)

baseUrl String

GHES web base URL; absent implies github.com

enterpriseServer Boolean

Whether this is a GitHub Enterprise Server app

privateKey String

GitHub App private key (PEM); masked in responses

clientSecret String

GitHub OAuth client secret; masked in responses

webhookSecret String

GitHub App webhook secret; masked in responses

installUrl String

URL the customer installs the app from; stored to re-show the install dialog

webhookUrl String

Webhook URL this app should deliver events to

installationId Int

Installation identifier; present once the app is installed

installationToken String

Installation-specific token; masked in responses

credentialsId String

credentialsName String

tokenExpirationDate String

credentialsType CredentialsType

isCertChecksDisabled Boolean

Indicates if SSL/TLS certificate validation is disabled

hostURL String

iv String

monitoredResources JSON

monitorAllResources Boolean

monitorAllNewlyCreatedResources Float

brokerUsername String

brokerPassword String

brokerEnabled Boolean

brokerHost String

brokerPort Int

References

Fields with this object:

Last updated