The deviceClient API provides a structured interface for managing various types of devices including OATH devices, PUSH devices, WebAuthn devices, bound devices, and device profiles. This API leverages Redux Toolkit Query (RTK Query) for efficient data fetching and state management.
The deviceClient function initializes the API client with the provided configuration options and sets up the Redux store with the necessary middleware and reducers.
To install the necessary dependencies for using the deviceClient, run:
npm install @forgerock/device-client --save
To configure the deviceClient, you need to provide a ConfigOptions object that includes the base URL for the server and the realm path.
import { deviceClient } from '@forgerock/device-client';
import { type ConfigOptions } from '@forgerock/javascript-sdk';
const config: ConfigOptions = {
serverConfig: {
baseUrl: 'https://api.example.com',
},
realmPath: '/your-realm-path',
};
If there is no realmPath or you wish to override the value, you can do so in the api call itself where you pass in the query.
const apiClient = deviceClient(config);
get(query: RetrieveOathQuery): Promise<OathDevice[]>
Retrieves Oath devices based on the specified query.
delete(query: RetrieveOathQuery & { device: OathDevice }): Promise<null>
Deletes an Oath device based on the provided query and device information.
get(query: PushDeviceQuery): Promise<PushDevice[]>
Retrieves Push devices based on the specified query.
delete(query: DeleteDeviceQuery): Promise<null>
Deletes a Push device based on the provided query.
get(query: WebAuthnQuery): Promise<WebAuthnDevice[]>
Retrieves WebAuthn devices based on the specified query.
update(query: WebAuthnQuery & { device: WebAuthnDevice }): Promise<UpdatedWebAuthnDevice>
Updates the name of a WebAuthn device based on the provided query and body.
delete(query: WebAuthnQuery & { device: WebAuthnDevice | UpdatedWebAuthnDevice }): Promise<null>
Deletes a WebAuthn device based on the provided query and body.
get(query: GetBoundDevicesQuery): Promise<Device[]>
Retrieves bound devices based on the specified query.
update(query: BoundDeviceQuery): Promise<Device>
Updates the name of a bound device based on the provided query.
delete(query: BoundDeviceQuery): Promise<null>
Deletes a bound device based on the provided query.
get(query: GetProfileDevices): Promise<ProfileDevice[]>
Retrieves device profiles based on the specified query.
update(query: ProfileDevicesQuery): Promise<ProfileDevice>
Updates the name of a device profile based on the provided query.
delete(query: ProfileDevicesQuery): Promise<null>
Deletes a device profile based on the provided query.
const oathQuery: RetrieveOathQuery = {
/* your query parameters */
};
const getResponse = await apiClient.oath.get(oathQuery);
console.log('Oath Devices:', getResponse);
const deleteOathQuery: RetrieveOathQuery & { device: OathDevice } = {
/* your delete query */
};
const deleteResponse = await apiClient.oath.delete(deleteOathQuery);
console.log('Deleted Oath Device:', deleteResponse);
const pushQuery: PushDeviceQuery = {
/* your query parameters */
};
const getResponse = await apiClient.push.get(pushQuery);
console.log('Push Devices:', getResponse);
const deletePushQuery: DeleteDeviceQuery = {
/* your delete query */
};
const deleteResponse = await apiClient.push.delete(deletePushQuery);
console.log('Deleted Push Device:', deleteResponse);
const webAuthnQuery: WebAuthnQuery = {
/* your query parameters */
};
const getResponse = await apiClient.webAuthn.get(webAuthnQuery);
console.log('WebAuthn Devices:', getResponse);
const updateWebAuthnQuery: WebAuthnQuery & { device: WebAuthnDevice } = {
/* your update query */
};
const updateResponse = await apiClient.webAuthn.update(updateWebAuthnQuery);
console.log('Updated WebAuthn Device:', updateResponse);
const deleteWebAuthnQuery: WebAuthnQuery & { device: WebAuthnDevice | UpdatedWebAuthnDevice } = {
/* your delete query */
};
const deleteResponse = await apiClient.webAuthn.delete(deleteWebAuthnQuery);
console.log('Deleted WebAuthn Device:', deleteResponse);
const bindingQuery: GetBoundDevicesQuery = {
/* your query parameters */
};
const getResponse = await apiClient.bound.get(bindingQuery);
console.log('Bound Devices:', getResponse);
const updateBindingQuery: BoundDeviceQuery = {
/* your update query */
};
const updateResponse = await apiClient.bound.update(updateBindingQuery);
console.log('Updated Bound Device:', updateResponse);
const deleteBindingQuery: BoundDeviceQuery = {
/* your delete query */
};
const deleteResponse = await apiClient.bound.delete(deleteBindingQuery);
console.log('Deleted Bound Device:', deleteResponse);
const profileQuery: GetProfileDevices = {
/* your query parameters */
};
const getResponse = await apiClient.profile.get(profileQuery);
console.log('Device Profiles:', getResponse);
const updateProfileQuery: ProfileDevicesQuery = {
/* your update query */
};
const updateResponse = await apiClient.profile.update(updateProfileQuery);
console.log('Updated Device Profile:', updateResponse);
const deleteProfileQuery: ProfileDevicesQuery = {
/* your delete query */
};
const deleteResponse = await apiClient.profile.delete(deleteProfileQuery);
console.log('Deleted Device Profile:', deleteResponse);
When a device client method makes a request to the server and the response is not valid, it will return a promise that resolves to an error object { error: unknown }. For example, to handle WebAuthn device management errors:
const getResponse = await apiClient.webAuthn.get(query);
if (!Array.isArray(getResponse) || 'error' in getResponse) {
// handle get device error
}
const updateResponse = await apiClient.webAuthn.update(query);
if ('error' in updateResponse) {
// handle update device error
}
const deleteResponse = await apiClient.webAuthn.delete(query);
if (deleteResponse !== null && 'error' in deleteResponse) {
// handle delete device error
}
This project is licensed under the MIT License. See the LICENSE file for details.