Module client

Source
Expand description

§Frontegg API client

The client module provides an API client with typed methods for interacting with the Frontegg API. This client implements authentication, token management, and basic requests against the API.

The Client requires an AppPassword as a parameter. The app password is used to manage an access token. Manage means issuing a new access token or refreshing when half of its lifetime has passed.

Modules§

app_password
This module implements the client’s functions for interacting with the Frontegg passwords API.
role
This module implements the client’s functions for interacting with the Frontegg users API.
user
This module implements the client’s functions for interacting with the Frontegg users API.

Structs§

AppPasswordAuthenticationRequest 🔒
Auth 🔒
AuthenticationResponse 🔒
Client
An API client for Frontegg.
Credentials
Representation of a user’s credentials. They are the same as a user needs to log in to Materialize’s console.
CredentialsAuthenticationRequest 🔒
RefreshRequest 🔒

Enums§

Authentication
Representation of the two possible ways to authenticate a user.

Constants§

APP_PASSWORD_AUTH_PATH 🔒
CREDENTIALS_AUTH_PATH 🔒
REFRESH_AUTH_PATH 🔒