Provides a high level interface for providing GitHub App credentials. This enables implementing a lightweight credential resolver for Jenkins where the credential is not stored in the class but instead only queried from Jenkins credentials backend as needed. It could also be stored in an alternate credential backend such as Vault.
Type Params | Return Type | Name and description |
---|---|---|
|
String |
getApiUri() Returns the API URL where this class will attempt to submit a GitHub app. |
|
String |
getAppID() Returns the GitHub App ID for the app installed into GitHub orgs and users. |
|
String |
getId() Returns an ID unique to this credential to differentiate it from other credentials. |
|
String |
getOwner() Returns the owner which installed the GitHub App. |
|
String |
getPrivateKey() Returns the RSA private key for a GitHub App. |
Returns the API URL where this class will attempt to submit a GitHub app. This would return https://api.github.com unless otherwise set to a hosted GitHub Enterprise instance.
Returns the GitHub App ID for the app installed into GitHub orgs and users.
Returns an ID unique to this credential to differentiate it from other credentials.
Returns the owner which installed the GitHub App. This can return an empty String if no owner is set.
Returns the RSA private key for a GitHub App. This will be used to sign JWT tokens for authentication with the GitHub API.