Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@coveo/auth

Package Overview
Dependencies
Maintainers
0
Versions
444
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@coveo/auth

Functions to help authenticate with the Coveo platform.

  • 2.0.5
  • beta
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
607
increased by389.52%
Maintainers
0
Weekly downloads
 
Created
Source

npm version

@coveo/auth

Functions to help authenticate with the Coveo platform.

Install

npm i @coveo/auth

SAML

  1. Configure a SAML authentication provider on your organization.

  2. Inside your web application, instantiate the SAML client in this package.

Example

import {buildSamlClient} from '@coveo/auth`;

const organizationId = '<organization id>';
const provider = '<configured SAML auth provider name>';

async function main() {
  const saml = buildSamlClient({organizationId, provider});
  const accessToken = await saml.authenticate();
  console.log(accessToken);
}

main();

Example with @coveo/headless

import {buildSamlClient} from '@coveo/auth`;
import {buildSearchEngine} from '@coveo/headless`;

async function main() {
  const saml = buildSamlClient(...);
  const accessToken = await saml.authenticate();

  const engine = buildSearchEngine({
    configuration: {
      organizationId,
      accessToken,
      renewAccessToken: saml.authenticate,
    },
  });
}

main()

Example with @coveo/headless and React

Reference

SamlClientOptions

  • organizationId: string

    The unique identifier of the target Coveo Cloud organization (e.g., mycoveoorganization8tp8wu3).

  • provider: string

    The SAML authentication provider name (e.g., oktaA323aab78b9f1-45b5-a095-a1f0fa09ddd5).

  • platformOrigin?: string

    The Coveo origin to authenticate through.

    Default value is https://platform.cloud.coveo.com.

Keywords

FAQs

Package last updated on 04 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc