Optionalmessage: stringError thrown when a request to the MonoCloud authorization server fails.
This error typically indicates a network failure, an unexpected HTTP response, or an unsuccessful response returned by the authorization server.
-Optionalmessage: stringOAuth error returned by the authorization server during an authentication or token request.
These errors correspond to standard OAuth / OpenID Connect error responses such as invalid_request, access_denied, or invalid_grant.
OptionalerrorDescription: stringOAuth error code returned by the authorization server.
diff --git a/docs/html/classes/_monocloud_auth-core.index.MonoCloudTokenError.html b/docs/html/classes/_monocloud_auth-core.index.MonoCloudTokenError.html index 66580065..3b6d4a3a 100644 --- a/docs/html/classes/_monocloud_auth-core.index.MonoCloudTokenError.html +++ b/docs/html/classes/_monocloud_auth-core.index.MonoCloudTokenError.html @@ -1,3 +1,3 @@Error thrown when a token operation fails.
-Optionalmessage: stringError thrown when validation fails.
-Optionalmessage: stringwindow.localStorage-backed implementation of IStorage.
This is the default storage used by MonoCloudJSCoreClient.
Retrieves the value associated with the given key.
+The unique identifier for the stored item.
+The stored value as a string, or null if the key does not exist.
Removes the item associated with the specified key from storage.
+The unique identifier of the item to remove.
+Stores a key-value pair in the storage.
+The unique identifier for the item.
+The string value to store.
+In-memory implementation of IStorage.
+Useful for testing or for sessions that should not persist across page reloads.
+Retrieves the value associated with the given key.
+The unique identifier for the stored item.
+The stored value as a string, or null if the key does not exist.
Removes the item associated with the specified key from storage.
+The unique identifier of the item to remove.
+Stores a key-value pair in the storage.
+The unique identifier for the item.
+The string value to store.
+Base class for all MonoCloud authentication errors.
+All errors thrown by the MonoCloud SDK extend this class, allowing applications to safely detect and handle MonoCloud-specific failures using instanceof.
Optionalmessage: stringError thrown when a request to the MonoCloud authorization server fails.
+This error typically indicates a network failure, an unexpected HTTP response, or an unsuccessful response returned by the authorization server.
+Optionalmessage: stringMonoCloudJSCoreClient is the core SDK entry point for integrating MonoCloud authentication into single-page applications (SPAs) and other browser-based JavaScript environments.
It provides:
+import { MonoCloudJSCoreClient } from '@monocloud/auth-js-core';
export const client = new MonoCloudJSCoreClient({
tenantDomain: 'your-tenant.monocloud.com',
clientId: 'your-client-id',
appUrl: 'http://localhost:3000',
callbackPath: '/callback',
signOutCallbackPath: '/logout'
});
+Initializes a new instance of the MonoCloudJSCoreClient.
+Configuration options for the client.
+Custom storage implementation for session persistence. Defaults to new LocalStorage().
OptionalpostCallbackFn: PostCallbackA callback function executed after a successful sign-in or sign-out. Useful for client-side routing integration.
+OptionalonSessionCreating: OnSessionCreatingA hook used to modify or validate the session during creation.
+import { MonoCloudJSCoreClient } from '@monocloud/auth-js-core';
const client = new MonoCloudJSCoreClient({
tenantDomain: 'your-tenant.monocloud.com',
clientId: 'your-client-id',
appUrl: 'http://localhost:3000',
});
+import { MonoCloudJSCoreClient } from '@monocloud/auth-js-core';
import { MemoryStorage } from './storage';
import { router } from './router';
const client = new MonoCloudJSCoreClient(
options,
new MemoryStorage(),
(state) => {
// Use router to navigate instead of full page reload.
router.push(state.returnUrl || '/dashboard');
}
);
+Underlying OpenID Connect client used for advanced authorization and token operations.
+Retrieves the current session object from configured storage.
+The active session or undefined if not authenticated.
Retrieves the active tokens for the session.
+If the tokens are expired or about to expire, this method will attempt to refresh them automatically before returning.
+Optionaloptions: GetTokensOptionsOptions to control token retrieval (e.g., force refresh).
+The active tokens.
+const tokens = await client.getTokens();
console.log(tokens.accessToken);
+const tokens = await client.getTokens({
resource: 'https://api.example.com',
scopes: 'read:data'
});
+MonoCloudValidationError If the session does not exist.
+Processes the authentication callback.
+This method must be called on application startup (usually in the entry point or router) +to handle the response from the identity provider after a redirect flow.
+A promise that resolves when the callback processing is complete.
+Refetches user information from the UserInfo endpoint and updates the local session.
+await client.refetchUserInfo();
const session = await client.getSession();
console.log('Updated user data:', session.user);
+MonoCloudValidationError If the session is invalid or the default token is missing.
+Refreshes the user's session.
+This method can be used to explicitly refresh tokens using various methods:
+silent: Uses a hidden iframe (requires third-party cookies).refresh_token: Uses the Refresh Token Grant (requires offline_access scope).popup: Opens a transient popup to refresh the session interactively.OptionalrefreshOptions: RefreshOptionsOptional configuration for the refresh flow.
+MonoCloudValidationError If the session is invalid or missing required tokens.
+MonoCloudJsError If called from within a popup or iframe.
+Initiates the sign-in flow.
+OptionalsignInOptions: SignInOptionsOptional configuration for the sign-in request.
+document.getElementById('login-btn').addEventListener('click', async () => {
// Standard top-level redirect to the authorization server.
await client.signIn();
});
+document.getElementById('login-popup-btn').addEventListener('click', async () => {
// Opens a centered popup for authentication.
await client.signIn({ mode: 'popup' });
console.log('User finished popup flow!');
});
+document.getElementById('register-btn').addEventListener('click', async () => {
// Forces the identity provider to show the registration/sign-up screen.
await client.signIn({ signUp: true });
});
+MonoCloudJsError If called from within a popup or iframe.
+Initiates the sign-out flow.
+Clears the local session and optionally redirects the user to the identity provider to end the session there (Federated Sign-Out).
+OptionalsignOutOptions: SignOutOptionsOptional configuration for the sign-out request.
+document.getElementById('logout-btn').addEventListener('click', async () => {
await client.signOut();
});
+document.getElementById('logout-popup-btn').addEventListener('click', async () => {
// Opens a popup to perform federated sign-out and keep the user on the current page.
await client.signOut({ mode: 'popup' });
});
+MonoCloudJsError If called from within a popup or iframe.
+Base class for all MonoCloud authentication errors.
+All errors thrown by the MonoCloud SDK extend this class, allowing applications to safely detect and handle MonoCloud-specific failures using instanceof.
Optionalmessage: stringOAuth error returned by the authorization server during an authentication or token request.
+These errors correspond to standard OAuth / OpenID Connect error responses such as invalid_request, access_denied, or invalid_grant.
OptionalerrorDescription: stringOptionaloptions: MonoCloudClientOptionsGenerates a session with user and tokens by exchanging authorization code from callback params.
+The authorization code received from the callback.
+The redirect URI that was used in the authorization request.
+A space-separated list of scopes originally requested via the /authorize endpoint.
+This is stored in the session to ensure the correct access token can be identified and refreshed during refreshSession().
Optionalresource: stringA space-separated list of resource indicators originally requested via the /authorize endpoint.
+Used alongside scopes to uniquely identify and refresh the specific access token associated with these resources.
Optionaloptions: AuthenticateOptionsOptions for authenticating a user with authorization code.
+The user's session containing authentication tokens and user information.
+MonoCloudValidationError - When the token scope does not contain the openid scope, +or if 'expires_in' or 'scope' is missing from the token response.
+MonoCloudOPError - When the OpenID Provider returns a standardized. +OAuth 2.0 error response.
+MonoCloudTokenError - If ID Token validation fails.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Generates an authorization URL with specified parameters.
+If no values are provided for responseType, or codeChallengeMethod, they default to code, and S256, respectively.
Authorization URL parameters.
+Tenant's authorization URL.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+StaticdecodeDecodes the payload of a JSON Web Token (JWT) and returns it as an object.
+++Note: THIS METHOD DOES NOT VERIFY JWT TOKENS.
+
JWT to decode.
+Decoded payload.
+MonoCloudTokenError - If decoding fails
+Generates OpenID end session URL for signing out.
+Note - The state is added only when postLogoutRedirectUri is present.
Parameters to build end session URL.
+Tenant's end session URL.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Exchanges an authorization code for tokens.
+The authorization code received from the authorization server.
+The redirect URI used in the initial authorization request.
+OptionalcodeVerifier: stringCode verifier for PKCE.
+Optionalresource: stringSpace-separated list of resources the access token should be scoped to.
+Tokens obtained by exchanging an authorization code at the token endpoint.
+MonoCloudOPError - When the OpenID Provider returns a standardized +OAuth 2.0 error response.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Fetches the JSON Web Keys used to sign the ID token. +The JWKS is cached for 1 minute.
+If true, bypasses the cache and fetches fresh set of JWKS from the server.
The JSON Web Key Set containing the public keys for token verification.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Fetches the authorization server metadata from the .well-known endpoint. +The metadata is cached for 1 minute.
+If true, bypasses the cache and fetches fresh metadata from the server.
The issuer metadata for the tenant, retrieved from the OpenID Connect discovery endpoint.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Performs a pushed authorization request.
+Authorization Parameters.
+Response from Pushed Authorization Request (PAR) endpoint.
+MonoCloudOPError - When the request is invalid.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Refetches user information for an existing session using the userinfo endpoint. +Updates the session's user object with the latest user information while preserving existing properties.
+Access token used to fetch the userinfo.
+The current MonoCloudSession.
+Optionaloptions: RefetchUserInfoOptionsUserinfo refetch options.
+Updated session with the latest userinfo.
+MonoCloudValidationError - When the token scope does not contain openid scope
+MonoCloudOPError - When the OpenID Provider returns a standardized +OAuth 2.0 error response.
+MonoCloudTokenError - If ID Token validation fails
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Exchanges a refresh token for new tokens.
+The refresh token used to request new tokens.
+Optionaloptions: RefreshGrantOptionsRefresh grant options.
+Tokens obtained by exchanging a refresh token at the token endpoint.
+MonoCloudOPError - When the OpenID Provider returns a standardized +OAuth 2.0 error response.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Refreshes an existing session using the refresh token. +This function requests new tokens using the refresh token and optionally updates user information.
+The current MonoCloudSession containing the refresh token.
+Optionaloptions: RefreshSessionOptionsSession refresh options.
+User's session containing refreshed authentication tokens and user information.
+MonoCloudValidationError - If the refresh token is not present in the session, +or if 'expires_in' or 'scope' (including the openid scope) is missing from the token response.
+MonoCloudOPError - When the OpenID Provider returns a standardized +OAuth 2.0 error response.
+MonoCloudTokenError - If ID Token validation fails
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Revokes an access token or refresh token, rendering it invalid for future use.
+The token string to be revoked.
+OptionaltokenType: stringHint about the token type ('access_token' or 'refresh_token').
+If token revocation succeeded.
+MonoCloudValidationError - If token is invalid or unsupported token type
+MonoCloudOPError - When the OpenID Provider returns a standardized +OAuth 2.0 error response.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+Fetches userinfo associated with the provided access token.
+A valid access token used to retrieve userinfo.
+The authenticated user's claims.
+MonoCloudOPError - When the OpenID Provider returns a standardized +OAuth 2.0 error (e.g., 'invalid_token') in the 'WWW-Authenticate' header +following a 401 Unauthorized response.
+MonoCloudHttpError - Thrown if there is a network error during the request or +unexpected status code during the request or a serialization error while processing the response.
+MonoCloudValidationError - When the access token is invalid.
+Validates an ID Token.
+The ID Token JWT string to validate.
+Array of JSON Web Keys (JWK) used to verify the token's signature.
+Number of seconds to adjust the current time to account for clock differences.
+Additional time tolerance in seconds for time-based claim validation.
+OptionalmaxAge: numberMaximum authentication age in seconds.
+Optionalnonce: stringNonce value to validate against the token's nonce claim.
+Validated ID Token claims.
+MonoCloudTokenError - If ID Token validation fails
+Error thrown when a token operation fails.
+Optionalmessage: stringError thrown when validation fails.
+Optionalmessage: stringwindow.sessionStorage-backed implementation of IStorage.
Data persists for the lifetime of the current browser tab.
+Retrieves the value associated with the given key.
+The unique identifier for the stored item.
+The stored value as a string, or null if the key does not exist.
Removes the item associated with the specified key from storage.
+The unique identifier of the item to remove.
+Stores a key-value pair in the storage.
+The unique identifier for the item.
+The string value to store.
+Base class for all MonoCloud authentication errors.
All errors thrown by the MonoCloud SDK extend this class, allowing applications to safely detect and handle MonoCloud-specific failures using instanceof.
Optionalmessage: stringError thrown when a request to the MonoCloud authorization server fails.
This error typically indicates a network failure, an unexpected HTTP response, or an unsuccessful response returned by the authorization server.
-Optionalmessage: stringOAuth error returned by the authorization server during an authentication or token request.
These errors correspond to standard OAuth / OpenID Connect error responses such as invalid_request, access_denied, or invalid_grant.
OptionalerrorDescription: stringOAuth error code returned by the authorization server.
diff --git a/docs/html/classes/_monocloud_auth-nextjs.index.MonoCloudTokenError.html b/docs/html/classes/_monocloud_auth-nextjs.index.MonoCloudTokenError.html index 562a427c..28322e34 100644 --- a/docs/html/classes/_monocloud_auth-nextjs.index.MonoCloudTokenError.html +++ b/docs/html/classes/_monocloud_auth-nextjs.index.MonoCloudTokenError.html @@ -1,3 +1,3 @@Error thrown when a token operation fails.
-Optionalmessage: stringError thrown when validation fails.
-Optionalmessage: stringBase class for all MonoCloud authentication errors.
All errors thrown by the MonoCloud SDK extend this class, allowing applications to safely detect and handle MonoCloud-specific failures using instanceof.
Optionalmessage: stringError thrown when a request to the MonoCloud authorization server fails.
This error typically indicates a network failure, an unexpected HTTP response, or an unsuccessful response returned by the authorization server.
-Optionalmessage: stringOAuth error returned by the authorization server during an authentication or token request.
These errors correspond to standard OAuth / OpenID Connect error responses such as invalid_request, access_denied, or invalid_grant.
OptionalerrorDescription: stringOAuth error code returned by the authorization server.
diff --git a/docs/html/classes/_monocloud_auth-node-core.index.MonoCloudTokenError.html b/docs/html/classes/_monocloud_auth-node-core.index.MonoCloudTokenError.html index dcc63749..3edf050c 100644 --- a/docs/html/classes/_monocloud_auth-node-core.index.MonoCloudTokenError.html +++ b/docs/html/classes/_monocloud_auth-node-core.index.MonoCloudTokenError.html @@ -1,3 +1,3 @@Error thrown when a token operation fails.
-Optionalmessage: stringError thrown when validation fails.
-Optionalmessage: stringThe ciphertext to decrypt.
The secret used to derive the decryption key.
Decrypted plaintext string or undefined if decryption fails.
-The secret used for decryption.
State object on success.
Base class for all MonoCloud authentication errors.
All errors thrown by the MonoCloud SDK extend this class, allowing applications to safely detect and handle MonoCloud-specific failures using
-instanceof.