@unitedeffects/auth
TypeScript icon, indicating that this package has built-in type declarations

1.32.7-a • Public • Published

UE Auth Client SDK

This is an openAPI generated client SDK for the UE Auth API. It utilizes Axios. For any support or help, please contact United Effects directly.

Full API

The full API can be viewed in the UE documents site: https://docs.unitedeffects.com

Install and Use

Example is with yarn but you could use npm. All APIs are provided as classes.

yarn i @unitedeffects/auth
// Example for SystemApi with basic JavaScript
const { SystemApi } = require('@unitedeffects/auth');
const sys = new SystemApi();

sys.apiHealthGet()
.then(d => console.info(d.data))
.catch(e => console.info(e));
// Example for SystemApi with import and async/await
import { SystemApi } from '@unitedeffects/auth';
const sys = new SystemApi();

async function example() {
    try {
        const resp = await sys.apiHealthGet();   
        console.info(resp.data);
    } catch (e) {
        console.info(e);
    }
    
}

API List

These classes are exported and available via import or require.

  • AccountDashboardApi
  • ClientAccessApi
  • ClientsApi
  • DeviceChallengeApi
  • NotificationApi
  • OIDCApi
  • OperationsAPI
  • OrganizationDomainsApi
  • OrganizationNotificationApi
  • OrganizationPermissionsApi
  • OrganizationProductsApi
  • OrganizationRolesApi
  • OrganizationUserProfilesApi
  • OrganizationUsersAccessApi
  • OrganizationApi
  • PermissionsApi
  • ProductsApi
  • ProfileAccessApi
  • ProfileRequestsApi
  • ProfilesApi
  • RolesApi
  • SystemApi
  • UsersApi
  • ValidateAccessApi
  • WebAuthNApi

Environments

This SDK can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

Additional Information

Investment Opportunities

If you are interested in learning about investment opportunities with United Effects, contact invest@unitedeffects.com

Copyright (c) 2023 United Effects LLC, all rights reserved.

Package Sidebar

Install

npm i @unitedeffects/auth

Homepage

ueauth.com

Weekly Downloads

7

Version

1.32.7-a

License

MIT

Unpacked Size

3.71 MB

Total Files

666

Last publish

Collaborators

  • ue-bo
  • cbetzatunitedeffects