HS.HC.Security.API.OAuthClient.V1.impl
class HS.HC.Security.API.OAuthClient.V1.impl extends %REST.Impl
API to manage OAuth clients, discover OAuth server endpoints, dynamically register clients, and refresh JWKS.Business logic class defined by OpenAPI in HS.HC.Security.API.OAuthClient.V1.spec
Updated Nov 13, 2025 13:25:36
Method Inventory
- %LogError()
- %WriteResponse()
- CreateOAuthClient()
- DeleteOAuthClientById()
- DiscoverOAuthServer()
- GetOAuthClientServerDefinitions()
- GetOAuthClients()
- GetTLSConfigurations()
- RefreshJWKS()
- UpdateOAuthClientById()
Parameters
parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.
parameter ImplementationClass = HS.HC.Security.API.OAuthClient.V1;
Methods
Log an API error to the ISCLOG.
This is an alternative to %REST.impl:%LogError().
This logs a level 3 entry so that it does not cause a messages.log severe entry.
This is intended to be called from a REST impl class's %ReportRESTError method.
classmethod %WriteResponse(response)
Inherited description: %WriteResponse is used by the dispatch class to write the response to this request.
classmethod CreateOAuthClient(client As %DynamicObject, register As %Boolean) as %DynamicObject
Create a new OAuth client
The method arguments hold values for:
client, The OAuth client to create
register, Defaults to false, denotes whether to also dynamically register the client, if register_endpoint is available in the OIDC discovery. If truthy and client fails to register, it will not be saved.
The method arguments hold values for:
client, The OAuth client to create
register, Defaults to false, denotes whether to also dynamically register the client, if register_endpoint is available in the OIDC discovery. If truthy and client fails to register, it will not be saved.
classmethod DeleteOAuthClientById(clientid As %String) as %DynamicObject
Delete an OAuth client by ID
The method arguments hold values for:
client_id
The method arguments hold values for:
client_id
classmethod DiscoverOAuthServer(issuer As %String, tlsconfiguration As %String) as %DynamicObject
Discover OAuth server endpoint
The method arguments hold values for:
issuer
tls_configuration
The method arguments hold values for:
issuer
tls_configuration
classmethod GetOAuthClientServerDefinitions() as %DynamicObject
Get all known OAuth servers
classmethod GetOAuthClients() as %DynamicObject
Get all OAuth clients
classmethod GetTLSConfigurations() as %DynamicObject
Get all TLS configurations
classmethod RefreshJWKS(clientid As %String) as %DynamicObject
Refresh the JWKS
The method arguments hold values for:
client_id
The method arguments hold values for:
client_id
classmethod UpdateOAuthClientById(clientid As %String, clientObj As %DynamicObject) as %DynamicObject
Update an OAuth client by ID
The method arguments hold values for:
client_id
clientObj, The OAuth client to be edited
The method arguments hold values for:
client_id
clientObj, The OAuth client to be edited
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %CheckAccepts()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DeleteHeader()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetContentType()
- %GetHeader()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ReportRESTError()
- %SerializeObject()
- %SetContentType()
- %SetCookieFromHeader()
- %SetHeader()
- %SetHeaderIfEmpty()
- %SetModified()
- %SetStatusCode()
- %ValidateObject()