From e736dd18da47eeaab3ba3ccc7d7c7c80dd27c010 Mon Sep 17 00:00:00 2001 From: Anton Ramanovich Date: Thu, 12 Jun 2025 13:27:58 +0200 Subject: [PATCH] [ACS-8770] update auth service doc file --- docs/core/services/authentication.service.md | 56 ++++++++------------ 1 file changed, 23 insertions(+), 33 deletions(-) diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 1cf92cca9d..e3b881a2b3 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -2,7 +2,7 @@ Title: Authentication Service Added: v2.0.0 Status: Active -Last reviewed: 2019-03-19 +Last reviewed: 2025-06-12 --- # Authentication Service @@ -13,27 +13,22 @@ Provides authentication to ACS and APS. ### Methods -- **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **addTokenToHeader**(requestUrl: `string`, headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Adds the auth token to an HTTP header using the 'bearer' scheme. + - _requestUrl:_ `string` - The URL of the request for which to set authentication headers. - _headersArg:_ `HttpHeaders` - (Optional) Header that will receive the token - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - The new header with the token added -- **getBearerExcludedUrls**()
- Gets the set of URLs that the token bearer is excluded from. -- **getRedirect**(): `string`
- Gets the URL to redirect to after login. - - **Returns** `string` - The redirect URL -- **getTicketBpm**(): `string|null`
- Gets the BPM ticket stored in the Storage. - - **Returns** `string|null` - The ticket or `null` if none was found -- **getTicketEcm**(): `string|null`
- Gets the ECM ticket stored in the Storage. - - **Returns** `string|null` - The ticket or `null` if none was found -- **getTicketEcmBase64**(): `string|null`
- Gets the BPM ticket from the Storage in Base 64 format. - - **Returns** `string|null` - The ticket or `null` if none was found - **getToken**(): `string`
Gets the auth token. - **Returns** `string` - Auth token string +- **getUsername**(): `string`
+ Gets the username of the authenticated user. + - **Returns** `string` - Username of the authenticated user +- **getAuthHeaders**(requestUrl: `string`, headers: `HttpHeaders`): `HttpHeaders`
+ Gets and sets the necessary authentication headers for a given request URL. + - _requestUrl:_ `string` - The URL of the request for which to obtain authentication headers. + - _headers:_ `HttpHeaders` - The existing HTTP headers to which authentication details might be added. + - **Returns** `HttpHeaders` - The HTTP headers object, potentially updated with authentication tokens. - **isALLProvider**(): `boolean`
Does the provider support both ECM and BPM? - **Returns** `boolean` - True if both are supported, false otherwise @@ -52,28 +47,23 @@ Provides authentication to ACS and APS. - **isOauth**(): `boolean`
Does the provider support OAuth? - **Returns** `boolean` - True if supported, false otherwise -- **isPublicUrl**(): `boolean`
- - **Returns** `boolean` - -- **isRememberMeSet**(): `boolean`
- Checks whether the "remember me" cookie was set or not. - - **Returns** `boolean` - True if set, false otherwise -- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **login**(username: `string`, password: `string`, rememberMe?: `boolean`): [`Observable`](http://reactivex.io/documentation/observable.html)`<{ type: string; ticket: any }>`
Logs the user in. - _username:_ `string` - Username for the login - _password:_ `string` - Password for the login - - _rememberMe:_ `boolean` - Stores the user's login details if true - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket + - _rememberMe:_ `boolean` - (Optional) Stores the user's login details if true + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<{ type: string; ticket: any }>` - An Observable that emits an object containing the authentication type (`type`) and the authentication ticket (`ticket`) upon successful login. - **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user out. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete -- **reset**()
-- **saveRememberMeCookie**(rememberMe: `boolean`)
- Saves the "remember me" cookie as either a long-life cookie or a session cookie. - - _rememberMe:_ `boolean` - Enables a long-life cookie -- **setRedirect**(url?: [`RedirectionModel`](../../../lib/core/src/lib/auth/models/redirection.model.ts))
- Sets the URL to redirect to after login. - - _url:_ [`RedirectionModel`](../../../lib/core/src/lib/auth/models/redirection.model.ts) - (Optional) URL to redirect to -- **ssoImplicitLogin**()
- Logs the user in with SSO +- **reset**(): `void`
Resets the authentication state of the service. +- **on**(event: `string`, listener: `Function`): `void`
Adds an event listener for the specified event. +- **off**(event: `string`, listener?: `Function`): `void`
Removes an event listener for the specified event. +- **once**(event: `string`, listener: `Function`): `void`
Adds a one-time event listener for the specified event. +- **emit**(event: `string`, ...args: `any[]`): `void`
Emits an event with optional arguments. +- **onLogin**: [`Subject`](https://reactivex.io/documentation/subject)``
Emitted when the user logs in successfully. +- **onLogout**: [`Subject`](https://reactivex.io/documentation/subject)``
Emitted when the user logs out. +- **onTokenReceived**: [`Subject`](https://reactivex.io/documentation/subject)``
Emitted when an authentication token is received. +- **onError**: [`Observable`](http://reactivex.io/documentation/observable.html)``
An Observable that emits an error object when an authentication-related error occurs. ## Details