@octokit/oauth-methods
Version:
Set of stateless request methods to create, check, reset, refresh, and delete user access tokens for OAuth and GitHub Apps
59 lines (58 loc) • 1.65 kB
TypeScript
export type OAuthAppAuthentication = {
clientType: "oauth-app";
clientId: string;
clientSecret: string;
token: string;
scopes: string[];
};
export type GitHubAppAuthenticationWithExpirationDisabled = {
clientType: "github-app";
clientId: string;
clientSecret: string;
token: string;
};
export type GitHubAppAuthenticationWithExpirationEnabled = GitHubAppAuthenticationWithExpirationDisabled & {
expiresAt: string;
};
export type GitHubAppAuthenticationWithRefreshToken = GitHubAppAuthenticationWithExpirationEnabled & {
refreshToken: string;
refreshTokenExpiresAt: string;
};
/**
* @deprecated Use `GitHubAppAuthenticationWithExpirationDisabled` or
* `GitHubAppAuthenticationWithExpirationEnabled` instead.
*/
export type GitHubAppAuthentication = {
clientType: "github-app";
clientId: string;
clientSecret: string;
token: string;
};
/**
* @deprecated Use `GitHubAppAuthenticationWithRefreshToken` instead.
*/
export type GitHubAppAuthenticationWithExpiration = {
clientType: "github-app";
clientId: string;
clientSecret: string;
token: string;
refreshToken: string;
expiresAt: string;
refreshTokenExpiresAt: string;
};
export type OAuthAppCreateTokenResponseData = {
access_token: string;
scope: string;
token_type: "bearer";
};
export type GitHubAppCreateTokenResponseData = {
access_token: string;
token_type: "bearer";
};
export type GitHubAppCreateTokenWithExpirationResponseData = {
access_token: string;
token_type: "bearer";
expires_in: number;
refresh_token: string;
refresh_token_expires_in: number;
};