HS.HC.Security.API.Credential.V1.impl
class HS.HC.Security.API.Credential.V1.impl extends %REST.Impl
API to manage user or system credentials, including CRUDS operations.Business logic class defined by OpenAPI in HS.HC.Security.API.Credential.V1.spec
Updated Nov 13, 2025 13:25:36
Method Inventory
- %LogError()
- %WriteResponse()
- CreateCredential()
- DeleteCredential()
- GetCredentialNamespaces()
- GetCredentialsList()
- UpdateCredential()
Parameters
parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.
parameter ImplementationClass = HS.HC.Security.API.Credential.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 CreateCredential(namespace As %String, credential As %DynamicObject) as %DynamicObject
Create a new credential record.
The method arguments hold values for:
namespace, The namespace in which to create the credentials. Defaults to the namespace of CSP web application, or HSSYS
credential, The credential to be created
The method arguments hold values for:
namespace, The namespace in which to create the credentials. Defaults to the namespace of CSP web application, or HSSYS
credential, The credential to be created
classmethod DeleteCredential(systemName As %String, namespace As %String) as %DynamicObject
Delete a credential by SystemName.
The method arguments hold values for:
systemName, The SystemName of the credential to delete
namespace, The namespace in which to delete the credentials. Defaults to the namespace of CSP web application, or HSSYS
The method arguments hold values for:
systemName, The SystemName of the credential to delete
namespace, The namespace in which to delete the credentials. Defaults to the namespace of CSP web application, or HSSYS
classmethod GetCredentialNamespaces() as %DynamicObject
Get list of namespaces in which credentials may be available.
classmethod GetCredentialsList(namespace As %String) as %DynamicObject
Fetch all stored credentials.
The method arguments hold values for:
namespace, The namespace in which to query the credentials. Defaults to the namespace of CSP web application, or HSSYS
The method arguments hold values for:
namespace, The namespace in which to query the credentials. Defaults to the namespace of CSP web application, or HSSYS
classmethod UpdateCredential(systemName As %String, namespace As %String, credential As %DynamicObject) as %DynamicObject
Update the details of an existing credential.
The method arguments hold values for:
systemName, The SystemName of the credential to update
namespace, The namespace in which to edit the credentials. Defaults to the namespace of CSP web application, or HSSYS
credential, The credential data to update
The method arguments hold values for:
systemName, The SystemName of the credential to update
namespace, The namespace in which to edit the credentials. Defaults to the namespace of CSP web application, or HSSYS
credential, The credential data to update
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()