2.0.1 • Published 9 months ago

@coveo/auth v2.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
9 months ago

@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. Instantiate the SAML client provided by this package in your web application.

Sample

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

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

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

main();

Sample 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()

React sample available here.

SamlClientOptions

  • organizationId: string

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

  • 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.

2.0.1

10 months ago

2.0.0

10 months ago

1.11.24

10 months ago

1.11.23

11 months ago

1.11.21

1 year ago

1.11.22

12 months ago

1.11.20

1 year ago

1.11.19

1 year ago

1.11.18

1 year ago

1.11.17

1 year ago

1.11.16

1 year ago

1.11.14

1 year ago

1.11.15

1 year ago

1.11.13

1 year ago

1.11.12

1 year ago

1.11.11

1 year ago

1.11.10

1 year ago

1.11.9

1 year ago

1.11.8

1 year ago

1.11.7

1 year ago

1.11.6

2 years ago

1.11.5

2 years ago

1.10.9

2 years ago

1.10.8

2 years ago

1.11.4

2 years ago

1.11.3

2 years ago

1.11.2

2 years ago

1.11.1

2 years ago

1.11.0

2 years ago

1.10.13

2 years ago

1.10.11

2 years ago

1.10.12

2 years ago

1.10.10

2 years ago

1.10.7

2 years ago

1.10.5

2 years ago

1.10.4

2 years ago

1.10.3

2 years ago

1.10.2

2 years ago

1.10.6

2 years ago

1.10.1

2 years ago

1.9.4

3 years ago

1.9.3

3 years ago

1.10.0

3 years ago

1.9.2

3 years ago

1.6.4

3 years ago

1.8.1

3 years ago

1.6.3

3 years ago

1.8.0

3 years ago

1.6.2

3 years ago

1.6.0

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.7.9

3 years ago

1.7.8

3 years ago

1.7.7

3 years ago

1.6.11

3 years ago

1.7.6

3 years ago

1.6.10

3 years ago

1.7.5

3 years ago

1.6.13

3 years ago

1.7.4

3 years ago

1.6.12

3 years ago

1.6.15

3 years ago

1.6.14

3 years ago

1.6.17

3 years ago

1.6.16

3 years ago

1.6.19

3 years ago

1.6.18

3 years ago

1.9.1

3 years ago

1.7.3

3 years ago

1.9.0

3 years ago

1.7.2

3 years ago

1.7.1

3 years ago

1.7.0

3 years ago

1.5.2

3 years ago

1.5.1

3 years ago

1.5.0

3 years ago

1.6.20

3 years ago

1.6.9

3 years ago

1.6.8

3 years ago

1.6.7

3 years ago

1.6.6

3 years ago

1.6.5

3 years ago

1.2.0

3 years ago

1.3.1

3 years ago

1.3.0

3 years ago

1.2.1

3 years ago

1.1.12

3 years ago

1.1.11

3 years ago

1.1.10

3 years ago

1.1.9

3 years ago

1.1.8

3 years ago

1.1.7

3 years ago

1.1.6

3 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

4 years ago

1.1.2

4 years ago

1.1.1

4 years ago