HS.FHIRServer.Util.OAuth2Token
class HS.FHIRServer.Util.OAuth2Token extends HS.FHIRServer.API.OAuth2Token
Class for OAuth 2.0 access token handling. An instance of this class is expected to be instantiated and set as a property on an Interactions instance. There it will be used for all interactions handled during the life of the Interactions instance.Method Inventory
- %OnNew()
- BaseURLGet()
- FSLogScopeMsg()
- GetContextValues()
- GetUserInfo()
- HasCompartment()
- HasScope()
- OAuthClientGet()
- ScopesListGet()
- SetInstance()
- TokenObjectGet()
- TokenStringGet()
- UsernameGet()
- VerifyEverythingRequest()
- VerifyHistoryInstanceResponse()
- VerifyResourceContent()
- VerifyResourceIdRequest()
- VerifySearchRequest()
- VerifySearchResultsGet()
- VerifySystemLevelRequest()
- VerifyTypesList()
Parameters
Methods
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
Derive user information from the current OAuth 2.0 token, and return that data if desired.
Input:
- pBAUsername: Existing basic authentication username (e.g., $username value). - pBARoles : Existing basic authentication user roles (e.g., $roles value). Output:
- pUserInfo(): Array of user information. Standard return is pUserInfo("Username") and pUserInfo("Roles"). This method may be overridden to derive and return other user info via subscripts in the pUserInfo() array.
Set or reset the properties of the current token handler instance, based on the input parameters.
@Input pTokenString The access token string.
@Input pOAuthClient The OAuth 2.0 Client Name, as defined in the Management Portal at System Administration > Security > OAuth 2.0 > Client. @Input pBaseURL The base URL, including scheme, host, port and path of the end point for the current FHIR interaction. @Input pUsername (DEPRECATED) The Basic Auth username for the current FHIR interaction.
This method typically used for read response, create request, update request, patch request.
This method typically used for read, vread or history-instance requests.
If not allowed, this method will Throw. Otherwise, it will simply Return.
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- VerifyDeleteRequest()