HS.HC.Security.API.OAuthClient.V1

class HS.HC.Security.API.OAuthClient.V1

this class provides the implementation for the OAuth client REST APIs, but also are callable directly. Thus, it should make no references to %request or %response, but optionally output an http-level error status for use by the REST API handler.

Method Inventory

• CreateOAuthClient()
• DeleteOAuthClientById()
• DiscoverOAuthServer()
• GetClientObjectFromClientPersistent()
• GetOAuthClientServerDefinitions()
• GetOAuthClients()
• GetTLSConfigurations()
• RefreshJWKS()
• UpdateOAuthClientById()

Methods

classmethod CreateOAuthClient(pClient As HS.HC.Security.ClientAPI.OAuthClient.V1.RequestClient, Output pStatus As %Status, Output pErrorCode As %Integer = "", pDoRegister As %Boolean = 1) as HS.HC.Security.ClientAPI.OAuthClient.V1.Client

Creates an instance of OAuth2.Client, automatically registering if DCR is available

classmethod DeleteOAuthClientById(pClientId As %String, Output pStatus As %Status, Output pErrorCode As %Integer = "")

classmethod DiscoverOAuthServer(pIssuer As %String, pTLSConfiguration As %String, Output pStatus As %Status, Output pErrorCode As %Integer = "") as HS.HC.Security.ClientAPI.OAuthClient.V1.ServerDefinition

Utility method for discovering an oauth server

classmethod GetClientObjectFromClientPersistent(pClient As %Persistent) as HS.HC.Security.ClientAPI.OAuthClient.V1.Client

utility method for obtaining json-enabled client object from persistent OAuth2.Client obj

classmethod GetOAuthClientServerDefinitions(Output pStatus As %Status, Output pErrorCode As %Integer = "") as %DynamicArray

Get all known OAuth servers returns array of DynamicObjects with property "Issuer"

classmethod GetOAuthClients(Output pStatus As %Status, Output pErrorCode As %Integer = "") as %DynamicArray

returns an array of HS.HC.Security.ClientAPI.OAuthClient.V1.Client

classmethod GetTLSConfigurations(Output pStatus As %Status, Output pErrorCode As %Integer = "") as %DynamicArray

returns array of SSL configuration, each a DynamicObject with property "Name"

classmethod RefreshJWKS(pClientId As %String, Output pStatus As %Status, Output pErrorCode As %Integer = "") as HS.HC.Security.ClientAPI.OAuthClient.V1.Client

Utility method for refreshing the json web key set used for signing JWTs

classmethod UpdateOAuthClientById(pClient As HS.HC.Security.ClientAPI.OAuthClient.V1.RequestClient, Output pStatus As %Status, Output pErrorCode As %Integer = "") as HS.HC.Security.ClientAPI.OAuthClient.V1.Client

Updates an instance of OAuth2.Client