This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.CodeQL.Cli.

Summary

Settings needed to generate a GItHub App Installation Token. Used to get an installation token

Assembly

Cake.CodeQL.Cli.dll

Namespace

Cake.GitHub.Authentication

Base Types

Object

graph BT Type-->Base0["Object"] Type["GitHubAppInstallationTokenToolSettings"] class Type type-node

Syntax

public class GitHubAppInstallationTokenToolSettings

Remarks

See links below for more information.

Constructors

Name	Summary
GitHubAppInstallationTokenToolSettings()

Properties

Name	Value	Summary
AppId	int	unique application is for a GitHub App
InstallationId	int	Installation Id associated with the app.
PrivateKey	string	Private Key generated in github org. The private key is the SINGLE most valuable secret for a GitHub App. We recommend storing the key in a key vault, such as Azure Key Vault or HashiCorp

Extension Methods

Name	Value	Summary
Dump<GitHubAppInstallationTokenToolSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GitHubAppInstallationTokenToolSettings>(GitHubAppInstallationTokenToolSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GitHubAppInstallationTokenToolSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<GitHubAppInstallationTokenToolSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<GitHubAppInstallationTokenToolSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<GitHubAppInstallationTokenToolSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin