Skip to main content

Abstract Class: BaseOAuthRevokeRouteMongo

Defined in: auth/src/routes/mongo/BaseOAuthRevokeRouteMongo.ts:8

Handles the OAuth 2.0 token revocation endpoint (RFC 7009). Accepts either a refresh token or an access token in the token parameter — the optional token_type_hint is used only to pick which kind to try first (RFC 7009 §2.1); the other kind is still tried if the hinted lookup doesn't find a match, since a client is allowed to omit or get the hint wrong. Always responds 200, whether or not token actually existed, belonged to a different client, or was already revoked/expired — RFC 7009 §2.2 requires this endpoint to never leak that distinction to the caller. Only a client-authentication failure is reported as an error.

Extends​

Constructors​

Constructor​

new BaseOAuthRevokeRouteMongo(): BaseOAuthRevokeRouteMongo

Returns​

BaseOAuthRevokeRouteMongo

Inherited from​

BaseOAuthRevokeRoute.constructor

Properties​

accessTokenDenylist?​

protected optional accessTokenDenylist?: AccessTokenDenylist

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:32

Inherited from​

BaseOAuthRevokeRoute.accessTokenDenylist

clientAuthUtils?​

protected optional clientAuthUtils?: ClientAuthUtils

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:37

Inherited from​

BaseOAuthRevokeRoute.clientAuthUtils

clientClass​

protected clientClass: any = ClientMongo

Defined in: auth/src/routes/mongo/BaseOAuthRevokeRouteMongo.ts:9

Overrides​

BaseOAuthRevokeRoute.clientClass

clientRepo?​

protected optional clientRepo?: RepoUtils<ClientMongo>

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:41

Inherited from​

BaseOAuthRevokeRoute.clientRepo

oauthTokenUtils?​

protected optional oauthTokenUtils?: OAuthTokenUtils

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:43

Inherited from​

BaseOAuthRevokeRoute.oauthTokenUtils

rateLimiter?​

protected optional rateLimiter?: RateLimiter

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:46

Inherited from​

BaseOAuthRevokeRoute.rateLimiter

refreshTokenClass​

protected refreshTokenClass: any = OAuthRefreshTokenMongo

Defined in: auth/src/routes/mongo/BaseOAuthRevokeRouteMongo.ts:10

Overrides​

BaseOAuthRevokeRoute.refreshTokenClass

refreshTokenRepo?​

protected optional refreshTokenRepo?: RepoUtils<OAuthRefreshTokenMongo>

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:50

Inherited from​

BaseOAuthRevokeRoute.refreshTokenRepo

signingKeyClass​

protected signingKeyClass: any = SigningKeyMongo

Defined in: auth/src/routes/mongo/BaseOAuthRevokeRouteMongo.ts:11

Overrides​

BaseOAuthRevokeRoute.signingKeyClass

Methods​

revoke()​

revoke(req, res): Promise<any>

Defined in: auth/src/routes/BaseOAuthRevokeRoute.ts:150

Revokes the given token (RFC 7009). Always responds 200 with an empty body — whether or not token actually existed, matched this client, or was already revoked. Only a missing token parameter or a client-authentication failure is reported as an error.

Parameters​

req​

HttpRequest

res​

HttpResponse

Returns​

Promise<any>

Inherited from​

BaseOAuthRevokeRoute.revoke