Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

%OAuth2.Server.Revoke

class %OAuth2.Server.Revoke extends %Library.RegisteredObject

%OAuth2.Server.Revoke is the default RevokeTokenClass which is included with the server. The default class will pass through, with no side effects upon token revocation.
The RevokeTokenClass is specified in the Authorization Server Configuration. It must contain a OnRevokeAccessToken method, which can perform user specific operations upon token revocation, optionally bypassing the regular revocation flow.

Method Inventory

Methods

classmethod OnRevokeAccessToken(authCode As %String, Output sc As %Status) as %Boolean
The OnRevokeAccessToken method must return a boolean value or throw an error.
If the method returns 1 or throws an error, the regular revocation flow is bypassed.
If the method returns 0, the regular revocation flow continues.
Default behavior is to permit regular revocation flow.
Receives the AuthorizationCode property value of the token to be deleted.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab