dependabit / github-client/src / OAuthHandler

Class: OAuthHandler

Defined in: packages/github-client/src/auth/oauth.ts:32

Handler for OAuth 2.0 authentication

Constructors

Constructor

new OAuthHandler(config): OAuthHandler;

Defined in: packages/github-client/src/auth/oauth.ts:36

Parameters

Parameter	Type
config	OAuthConfig

Returns

OAuthHandler

Methods

authenticate()

authenticate(code): Promise<OAuthAuth>;

Defined in: packages/github-client/src/auth/oauth.ts:49

Exchange authorization code for access token

Parameters

Parameter	Type
code	string

Returns

Promise<OAuthAuth>

---

getAuthorizationUrl()

getAuthorizationUrl(scopes, state?): string;

Defined in: packages/github-client/src/auth/oauth.ts:69

Generate authorization URL for OAuth flow

Parameters

Parameter	Type
scopes	string[]
state?	string

Returns

string

---

getType()

getType(): string;

Defined in: packages/github-client/src/auth/oauth.ts:118

Get authentication type

Returns

string

---

refreshToken()

refreshToken(refreshToken): Promise<OAuthAuth>;

Defined in: packages/github-client/src/auth/oauth.ts:86

Refresh an expired access token

Parameters

Parameter	Type
refreshToken	string

Returns

Promise<OAuthAuth>

---

validate()

validate(): boolean;

Defined in: packages/github-client/src/auth/oauth.ts:105

Validate OAuth configuration

Returns

boolean