Skip to main content

providers/united-effects

Built-in United Effects integration.

default()​

default<P>(options): OAuthConfig< P >

Add United Effects login to your page.

Setup​

Callback URL​

https://example.com/api/auth/callback/united-effects

Configuration​

import Auth from "@auth/core"
import UnitedEffects from "@auth/core/providers/united-effects"

const request = new Request(origin)
const response = await Auth(request, {
  providers: [UnitedEffects({ clientId: UE_CLIENT_ID, clientSecret: UE_CLIENT_SECRET })],
})

Resources​

Notes​

By default, Auth.js assumes that the UnitedEffects provider is based on the Open ID Connect specification.

note

issuer should be the fully qualified URL including your Auth Group ID – e.g. https://auth.unitedeffects.com/YQpbQV5dbW-224dCovz-3

danger

The United Effects API does not return the user name or image by design, so this provider will return null for both. United Effects prioritizes user personal information security above all and has built a secured profile access request system separate from the provider API.

tip

The UnitedEffects provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer

If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Type parameters​

▪ P extends UnitedEffectsProfile

Parameters​

▪ options: OAuthUserConfig< P > & { issuer: string; }

Returns​

OAuthConfig< P >