@3sixty/api-auth-service 0.20.0-next.0 → 0.20.0-next.1

package/docs/reference/classes/AuthenticationAuditEntry.md

@@ -0,0 +1,101 @@
+# Class: AuthenticationAuditEntry
+
+Class defining the storage for authentication audit entries.
+
+## Constructors
+
+### Constructor
+
+> **new AuthenticationAuditEntry**(): `AuthenticationAuditEntry`
+
+#### Returns
+
+`AuthenticationAuditEntry`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The unique identifier for the audit entry.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The timestamp of the audit entry in ISO 8601 format.
+
+***
+
+### event {#event}
+
+> **event**: `string`
+
+The audit event that occurred.
+
+***
+
+### actorId? {#actorid}
+
+> `optional` **actorId?**: `string`
+
+The actor identifier, could be e-mail, username, or other unique identifier.
+
+***
+
+### nodeId? {#nodeid}
+
+> `optional` **nodeId?**: `string`
+
+The node identifier associated with the audit entry, if applicable.
+
+***
+
+### organizationId? {#organizationid}
+
+> `optional` **organizationId?**: `string`
+
+The organization identifier associated with the audit entry, if applicable.
+
+***
+
+### tenantId? {#tenantid}
+
+> `optional` **tenantId?**: `string`
+
+The tenant identifier associated with the audit entry, if applicable.
+
+***
+
+### ipAddressHashes? {#ipaddresshashes}
+
+> `optional` **ipAddressHashes?**: `string`[]
+
+The hashed IP addresses of the client.
+
+***
+
+### userAgent? {#useragent}
+
+> `optional` **userAgent?**: `string`
+
+The user agent string of the client.
+
+***
+
+### correlationId? {#correlationid}
+
+> `optional` **correlationId?**: `string`
+
+The correlation ID for request tracing.
+
+***
+
+### data? {#data}
+
+> `optional` **data?**: `unknown`
+
+Additional data related to the audit entry, such as IP address, user agent, etc.

package/docs/reference/classes/AuthenticationRateEntry.md

@@ -0,0 +1,37 @@
+# Class: AuthenticationRateEntry
+
+Class defining the storage for authentication rate entries.
+
+## Constructors
+
+### Constructor
+
+> **new AuthenticationRateEntry**(): `AuthenticationRateEntry`
+
+#### Returns
+
+`AuthenticationRateEntry`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id for the rate entry.
+
+***
+
+### timestamps {#timestamps}
+
+> **timestamps**: `string`[]
+
+Array of ISO date strings representing timestamps of failed attempts.
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+Last modification time in ISO date format.

package/docs/reference/classes/EntityStorageAuthenticationAuditService.md

@@ -0,0 +1,241 @@
+# Class: EntityStorageAuthenticationAuditService
+
+Implementation of the authentication audit component using entity storage.
+
+## Implements
+
+- `IAuthenticationAuditComponent`
+
+## Constructors
+
+### Constructor
+
+> **new EntityStorageAuthenticationAuditService**(`options?`): `EntityStorageAuthenticationAuditService`
+
+Create a new instance of EntityStorageAuthenticationAuditService.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageAuthenticationAuditServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationAuditServiceConstructorOptions.md)
+
+The dependencies for the identity connector.
+
+#### Returns
+
+`EntityStorageAuthenticationAuditService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.className`
+
+***
+
+### create() {#create}
+
+> **create**(`entry`): `Promise`\<`string`\>
+
+Create a new audit entry.
+
+#### Parameters
+
+##### entry
+
+`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>
+
+The audit entry to be logged.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The unique identifier of the created audit entry.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.create`
+
+***
+
+### get() {#get}
+
+> **get**(`id`): `Promise`\<`IAuthenticationAuditEntry`\>
+
+Get an audit entry by id.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry.
+
+#### Returns
+
+`Promise`\<`IAuthenticationAuditEntry`\>
+
+The audit entry.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.get`
+
+***
+
+### update() {#update}
+
+> **update**(`id`, `entry`): `Promise`\<`void`\>
+
+Update an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to update.
+
+##### entry
+
+`Partial`\<`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>\>
+
+The fields to update on the audit entry.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been updated.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.update`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been removed.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.remove`
+
+***
+
+### query() {#query}
+
+> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>
+
+Query the audit entries.
+
+#### Parameters
+
+##### options?
+
+The query options.
+
+###### actorId?
+
+`string`
+
+The actor identifier to filter the audit entries, optional.
+
+###### organizationId?
+
+`string`
+
+The organization identifier to filter the audit entries, optional.
+
+###### tenantId?
+
+`string`
+
+The tenant identifier to filter the audit entries, optional.
+
+###### nodeId?
+
+`string`
+
+The node identifier to filter the audit entries, optional.
+
+###### event?
+
+`string`
+
+The audit event to filter the audit entries, optional.
+
+###### startDate?
+
+`string`
+
+The start date to filter the audit entries, optional.
+
+###### endDate?
+
+`string`
+
+The end date to filter the audit entries, optional.
+
+##### cursor?
+
+`string`
+
+The cursor for pagination.
+
+##### limit?
+
+`number`
+
+The maximum number of entries to return.
+
+#### Returns
+
+`Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>
+
+The audit entries.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.query`

package/docs/reference/classes/EntityStorageAuthenticationRateService.md

@@ -0,0 +1,227 @@
+# Class: EntityStorageAuthenticationRateService
+
+Implementation of the authentication rate component using entity storage.
+
+## Implements
+
+- `IAuthenticationRateComponent`
+
+## Constructors
+
+### Constructor
+
+> **new EntityStorageAuthenticationRateService**(`options?`): `EntityStorageAuthenticationRateService`
+
+Create a new instance of EntityStorageAuthenticationRateService.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageAuthenticationRateServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationRateServiceConstructorOptions.md)
+
+The constructor options.
+
+#### Returns
+
+`EntityStorageAuthenticationRateService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### registerAction() {#registeraction}
+
+> **registerAction**(`action`, `config`): `Promise`\<`void`\>
+
+Register or update rate-limit configuration for an action.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action name.
+
+##### config
+
+`IAuthenticationRateActionConfig`
+
+The action configuration.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action configuration has been stored.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.registerAction`
+
+***
+
+### unregisterAction() {#unregisteraction}
+
+> **unregisterAction**(`action`): `Promise`\<`void`\>
+
+Unregister rate-limit configuration for an action.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action name.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action configuration has been removed.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.unregisterAction`
+
+***
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.className`
+
+***
+
+### start() {#start}
+
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The service needs to be started when the application is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the periodic cleanup task has been registered.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the periodic cleanup task has been removed.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.stop`
+
+***
+
+### check() {#check}
+
+> **check**(`action`, `identifier`): `Promise`\<`string`\>
+
+Check the authentication rate for a given action and identifier.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action to be checked.
+
+##### identifier
+
+`string`
+
+The identifier to be checked.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The rate entry id.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.check`
+
+***
+
+### clear() {#clear}
+
+> **clear**(`action`, `identifier`): `Promise`\<`void`\>
+
+Clear the authentication rate entry for the given action and identifier.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action to clear.
+
+##### identifier
+
+`string`
+
+The identifier to clear.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the rate entry has been removed.
+
+#### Implementation of
+
+`IAuthenticationRateComponent.clear`

package/docs/reference/classes/TenantOverrideProcessor.md

@@ -0,0 +1,129 @@
+# Class: TenantOverrideProcessor
+
+Processes the overrideTenant query parameter for routes that allow tenant override.
+Requires the caller to hold the escalated privilege role. Runs after AuthHeaderProcessor so
+authentication is always resolved in the caller's own partition first.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new TenantOverrideProcessor**(`options?`): `TenantOverrideProcessor`
+
+Create a new instance of TenantOverrideProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ITenantOverrideProcessorConstructorOptions`](../interfaces/ITenantOverrideProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`TenantOverrideProcessor`
+
+## Properties
+
+### OVERRIDE\_TENANT\_PARAM {#override_tenant_param}
+
+> `readonly` `static` **OVERRIDE\_TENANT\_PARAM**: `string` = `"override-tenant"`
+
+The query parameter name used to supply the override tenant ID.
+
+***
+
+### DEFAULT\_AUTHORIZATION\_MODEL\_ID {#default_authorization_model_id}
+
+> `readonly` `static` **DEFAULT\_AUTHORIZATION\_MODEL\_ID**: `string` = `"system"`
+
+The model identifier that is reserved for system-only use.
+
+***
+
+### DEFAULT\_ESCALATED\_PRIVILEGE\_ROLE {#default_escalated_privilege_role}
+
+> `readonly` `static` **DEFAULT\_ESCALATED\_PRIVILEGE\_ROLE**: `string` = `"global-admin"`
+
+The role string required to perform a tenant override.
+
+***
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the tenant override has been applied or skipped.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`