HS.HC.Security.API.Credential.V1

class HS.HC.Security.API.Credential.V1

this class provides the implementation for the credentials 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

• CreateCredential()
• DeleteCredential()
• GetCredentialNamespaces()
• GetCredentialsList()
• UpdateCredential()

Methods

classmethod CreateCredential(pCredential As HS.HC.Security.ClientAPI.Credential.V1.RequestCredential, pNamespace As %String = "", Output pStatus As %Status, Output pErrorCode As %Integer = "") as HS.HC.Security.ClientAPI.Credential.V1.Credential

Utility method to create a credential under an optional @Input namespace Defaults to the namespace of the current process

classmethod DeleteCredential(pSystemName As %String, pNamespace As %String = "", Output pStatus As %Status, Output pErrorCode As %Integer = "") as %Stream.Object

Utility method for deleting a credential in a given namespace

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

returns %DynamicArray of objects { Name: "" } with names of interop namespaces the client has READ permissions for

classmethod GetCredentialsList(pNamespace As %String = "", Output pStatus As %Status, Output pErrorCode As %Integer = "") as %DynamicArray

given optional @Input namespace (defaults to current process ns), retrieve list of credentials in an array of HS.HC.Security.ClientAPI.Credential.V1.Credential

classmethod UpdateCredential(pCredential As HS.HC.Security.ClientAPI.Credential.V1.RequestCredential, pNamespace As %String = "", Output pStatus As %Status, Output pErrorCode As %Integer = "") as HS.HC.Security.ClientAPI.Credential.V1.Credential

Utility method to create a credential under an optional @Input namespace Defaults to the namespace of the current process