@emdgroup/react-auth NPM

Interfaces

Functions

UserContextProvider

▸ UserContextProvider(__namedParameters): JSX.Element

This library implements the Authorization Code Grant Flow with PKCE.

import { UserContextProvider } from '@emdgroup/react-auth';
function App(): JSX.Element {
  return (
    <UserContextProvider autoLogin clientId="...">
      <Content />
    </UserContextProvider>
  );
}

function Content(): JSX.Element {
  const { info } = useUser();
  return <p>{info.email}</p>;
}

Parameters

Name	Type
`__namedParameters`	`ProviderOptions`

Returns

JSX.Element

useUser

▸ useUser(): UserContext

Returns the user context previously established with UserContextProvider.

const { info, session, login, logout, authHeader } = useUser();

useEffect(() => {
  if (!session) return; // user is not logged in
  fetch('/api/pet', { headers: authHeader }).then(...);
}, [session, authHeader]);

Returns

UserContext

UserContext

The user context object is returned by the useUser hook.

Properties

authHeader

• Optional authHeader: Object

Convenience header object containing the Authorization header value set to the access token.

Index signature

▪ key: string: string

info

• Optional info: UserInfo

Provides the UserInfo object if the user is authenticated.

login

• Optional login: (opts?: LoginOptions) => void

Type declaration

▸ (opts?): void

Function to initiate the login flow.

Parameters

Name	Type
`opts?`	`LoginOptions`

Returns

void

loginUrl

• Optional loginUrl: string

Set to the URL that the user is redirected to initiate the authorization flow. Useful when you need to start the login flow in a separate window or tab. Use in combination with login({ refresh: false }).

logout

• Optional logout: () => void

Type declaration

▸ (): void

Function to log the user out.

Returns

void

session

• Optional session: UserSession

Provides the UserSession object if the user is authenticated.

ProviderOptions

Properties

acrValues

• Optional acrValues: string

Request a type of multi-factor authentication. Currently, mfa is the only supported value.

additionalParameters

• Optional additionalParameters: string

Additional query parameters, such as state=xyz.

autoLogin

• Optional autoLogin: boolean

When enabled, the user will automatically be logged in when the page is loaded. Defaults to false.

clientId

• clientId: string

Client ID as provided by the IdP.

domainHint

• Optional domainHint: string

Domain name to directly forward a user to the login page for a certain auth domain.

idpHost

• Optional idpHost: string

Overwrite the IdP host, defaults to login.emddigital.com.

prompt

• Optional prompt: "login"

Whether the authorization server prompts the user for re-authentication.

redirectUri

• Optional redirectUri: string

Overwrite the redirect URI, defaults to the current hostname + /auth.

refreshSession

• Optional refreshSession: boolean

Persist and use the refreshToken to renew an expired accessToken. Defaults to false.

userInfoEndpoint

• Optional userInfoEndpoint: string

Overwrite the userinfo endpoint, defaults to /oauth2/userinfo.

LoginOptions

Object representing the options for the login function of the UserContext.

Properties

entrypoint

• Optional entrypoint: string

Entrypoint to redirect the user to after successful authentication. Defaults to the URL that the user initially visited.

redirect

• Optional redirect: boolean

Automatically redirect the user to the login URL and to the entrypoint after successful authentication. Disabling this will disable all redirects. Defaults to false.