@coveo/auth NPM

@coveo/auth

Functions to help authenticate with the Coveo platform.

Install

npm i @coveo/auth

SAML

Configure a SAML authentication provider on your organization.
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.

coveo authentication saml

@infinitebrahmanuniverse/nolb-_cov @everything-registry/sub-chunk-200 @zalastax/nolb-_cov

1.11.19

6 days ago

1.11.19-pre.4bf47ba7e9

9 days ago

1.11.19-pre.ac8d896a6a

9 days ago

1.11.19-pre.9dbd94a56c

9 days ago

1.11.19-pre.4004e205e2

9 days ago

1.11.19-pre.0d2549d391

10 days ago

1.11.19-pre.bdcfa61275

9 days ago

1.11.19-pre.0758d7e677

9 days ago

1.11.19-pre.eb3542e592

10 days ago

1.11.19-pre.1e253b78ac

9 days ago

1.11.19-pre.d1ee1c3a9c

10 days ago

1.11.19-pre.fb02d711b8

10 days ago

1.11.18

18 days ago

1.11.18-pre.e1b2c3ae56

19 days ago

1.11.18-pre.68673255a8

19 days ago

1.11.18-pre.3727e7aff1

19 days ago

1.11.18-pre.6e7301afa5

19 days ago

1.11.18-pre.33a934e899

19 days ago

1.11.18-pre.e38b3036ef

19 days ago

1.11.18-pre.2d176469bb

20 days ago

1.11.18-pre.2d991f890e

20 days ago

1.11.17

1 month ago

1.11.17-pre.f033a245ae

1 month ago

1.11.17-pre.7958d0ee56

1 month ago

1.11.17-pre.fa46f506ad

1 month ago

1.11.17-pre.d5d114ec7f

1 month ago

1.11.17-pre.792d23e417

1 month ago

1.11.16

2 months ago

1.11.16-pre.de4e0c023b

2 months ago

1.11.16-pre.3a8906452a

2 months ago

1.11.16-pre.aee20158c8

2 months ago

1.11.15-pre.1e7997c521

2 months ago

1.11.14

2 months ago

1.11.15

2 months ago

1.11.13

2 months ago

1.11.13-pre.1aaeb08802

2 months ago

1.11.15-pre.4f4c978e11

2 months ago

1.11.14-pre.dede0e691f

2 months ago

1.11.13-pre.c8be7479df

2 months ago

1.11.13-pre.4a205a154d

2 months ago

1.11.13-pre.c897205634

2 months ago

1.11.13-pre.f4d9e36dae

2 months ago

1.11.13-pre.4b404abe53

2 months ago

1.11.12

2 months ago

1.11.12-pre.a5c846bec4

2 months ago

1.11.12-pre.299928944d

2 months ago

1.11.12-pre.d2498bfea6

2 months ago

1.11.12-pre.155f04c66c

2 months ago

1.11.12-pre.e0c5762f37

2 months ago

1.11.12-pre.6ed3167663

2 months ago

1.11.12-pre.e4ac6ba393

2 months ago

1.11.12-pre.50e134e35c

2 months ago

1.11.12-pre.8732da4798

2 months ago

1.11.12-pre.cba062e39a

2 months ago

1.11.12-pre.51a8d48200

2 months ago

1.11.12-pre.fb8a0338c8

2 months ago

1.11.12-pre.84d5ab39f4

2 months ago

1.11.12-pre.e527965100

2 months ago

1.11.11

3 months ago

1.11.11-pre.ec0c2dc261

3 months ago

1.11.11-pre.25002cda86

3 months ago

1.11.11-pre.d629fecd44

3 months ago

1.11.11-pre.38d55ef201

3 months ago

1.11.11-pre.a5b645d4f5

3 months ago

1.11.10

3 months ago

1.11.10-pre.6bf3b08648

3 months ago

1.11.9

3 months ago

1.11.9-pre.0ea8fbd167

3 months ago

1.11.9-pre.0e104b844f

3 months ago

1.11.9-pre.48877723d6

3 months ago

1.11.8

3 months ago

1.11.8-pre.b999f7abc8

3 months ago

1.11.8-pre.5b16462091

3 months ago

1.11.8-pre.7fbfad4338

3 months ago

1.11.8-pre.fee767378f

3 months ago

1.11.8-pre.72ad49e317

3 months ago

1.11.8-pre.5ff7f565b2

3 months ago

1.11.8-pre.70da81bbee

3 months ago

1.11.8-pre.74f61fee73

3 months ago

1.11.7-pre.be18b0e8b8

4 months ago

1.11.7

4 months ago

1.11.8-pre.49fcf7846d

4 months ago

1.11.8-pre.c249e6313a

4 months ago

1.11.8-pre.fa96dc2cb8

4 months ago

1.11.8-pre.445bb5c040

4 months ago

1.11.8-pre.712b85caa5

4 months ago

1.11.8-pre.b4c9262e89

4 months ago

1.11.8-pre.797d50cd98

4 months ago

1.11.8-pre.327a31f9bc

4 months ago

1.11.8-pre.8cbc113c32

4 months ago

1.11.8-pre.c133f5d684

4 months ago

1.11.6

4 months ago

1.11.6-pre.c67f3e1e53

4 months ago

1.11.6-pre.d7c44e71d8

4 months ago

1.11.6-pre.fe14eabc3b

4 months ago

1.11.6-pre.bc528120bc

4 months ago

1.11.6-pre.1407b28c9d

4 months ago

1.11.6-pre.bfbe402aa3

4 months ago

1.11.6-pre.477f3b4b1b

4 months ago

1.11.6-pre.531d0105f2

4 months ago

1.11.5

5 months ago

1.11.5-pre.268edb9ce0

5 months ago

1.11.5-pre.8d747a06ed

5 months ago

1.11.5-pre.dcfbe70ef2

5 months ago

1.11.5-pre.b5874d6784

5 months ago

1.11.5-pre.2edf82c903

5 months ago

1.11.5-pre.bdb073d633

5 months ago

1.11.5-pre.7cb5aa5b7f

5 months ago

1.11.5-pre.b82d95a764

5 months ago

1.11.5-pre.1a23a511b7

5 months ago

1.11.5-pre.667a764cc1

5 months ago

1.11.5-pre.f4abf465c4

5 months ago

1.10.10-pre.d31b0b7b1d

8 months ago

1.10.9

8 months ago

1.10.8

8 months ago

1.11.0-pre.0f9d6b81c6

7 months ago

1.10.11-pre.dea2152480

7 months ago

1.11.0-pre.9f1d155b3a

6 months ago

1.10.12-pre.ed9f272a14

7 months ago

1.10.11-pre.66f4710dbc

7 months ago

1.11.0-pre.a524fe2a5e

6 months ago

1.11.3-pre.610458e859

6 months ago

1.10.12-pre.bb465377b9

7 months ago

1.10.11-pre.61ff602153

7 months ago

1.10.10-pre.7c74862908

8 months ago

1.10.12-pre.dc27499349

7 months ago

1.10.12-pre.0ae8c4b9f6

7 months ago

1.11.2-pre.4106362293

6 months ago

1.10.11-pre.1b10aaeb5e

7 months ago

1.10.12-pre.9b31ea6d0f

7 months ago

1.10.13-pre.832e58234a

7 months ago

1.10.11-pre.20ee1dd252

7 months ago

1.10.12-pre.0d7e550c3b

7 months ago

1.10.11-pre.af6508d086

7 months ago

1.11.0-pre.047b2a8e8d

6 months ago

1.10.12-pre.b6c78d8923

7 months ago

1.10.11-pre.57f6f21f27

7 months ago

1.11.4

6 months ago

1.11.0-pre.ab0fe39cd8

7 months ago

1.11.3

6 months ago

1.11.4-pre.27b2922430

6 months ago

1.11.2

6 months ago

1.11.1

6 months ago

1.11.0-pre.78f3b5f68c

6 months ago

1.10.12-pre.76b9590865

7 months ago

1.10.10-pre.91755ea60d

8 months ago

1.11.2-pre.e6f04593f9

6 months ago

1.10.10-pre.74ea563a00

8 months ago

1.11.2-pre.f2f2913dcf

6 months ago

1.11.0-pre.fd91e90c7f

7 months ago

1.11.0-pre.f5c6ca8353

7 months ago

1.10.12-pre.a7a50af671

7 months ago

1.10.10-pre.ff5f2eb7ff

8 months ago

1.10.11-pre.0026ae7d47

7 months ago

1.11.2-pre.fa58a98fec

6 months ago

1.10.9-pre.b22fcd60aa

8 months ago

1.10.10-pre.6bcc1e6d51

8 months ago

1.10.13-pre.60d3f48d1c

7 months ago

1.10.12-pre.2fecc824f4

7 months ago

1.10.11-pre.5301957ec1

7 months ago

1.10.12-pre.f50e27229d

7 months ago

1.10.12-pre.cecb76481d

7 months ago

1.11.2-pre.4e3577b90d

6 months ago

1.10.10-pre.afabd13cbf

8 months ago

1.10.11-pre.74ad0cc57d

7 months ago

1.11.1-pre.9f1d155b3a

6 months ago

1.10.12-pre.8afa4e415e

7 months ago

1.11.0-pre.78a2761577

7 months ago

1.11.2-pre.87b5c6e9fc

6 months ago

1.11.2-pre.610458e859

6 months ago

1.10.10-pre.e13c4e0dbe

8 months ago

1.10.11-pre.0bd390f888

7 months ago

1.10.11-pre.ed3f113e87

7 months ago

1.10.12-pre.6d4c6f880c

7 months ago

1.10.10-pre.d700a24de8

8 months ago

1.10.11-pre.eb2a9f3a67

7 months ago

1.10.12-pre.1ed6e361a2

7 months ago

1.11.0-pre.410c235b8d

6 months ago

1.10.9-pre.0d07d03914

8 months ago

1.11.0

6 months ago

1.10.10-pre.1e32da2fca

8 months ago

1.10.11-pre.904eae3579

7 months ago

1.11.0-pre.4d413e6bb2

7 months ago

1.10.10-pre.90eab6b8cb

8 months ago

1.10.10-pre.ec7b821340

8 months ago

1.10.10-pre.0ea1e355d4

8 months ago

1.10.11-pre.424a310ac2

7 months ago

1.10.13-pre.0e20bbe06b

7 months ago

1.10.12-pre.824ab09717

7 months ago

1.11.0-pre.64f5b81f67

7 months ago

1.11.0-pre.02360194a7

7 months ago

1.10.13-pre.051b7c78ce

7 months ago

1.11.0-pre.6a4581aba9

7 months ago

1.10.10-pre.71f9c0c9af

8 months ago

7 months ago

7 months ago

7 months ago

8 months ago

1.10.10-pre.e1713bc558

8 months ago

1.10.12-pre.fe99e37ede

7 months ago

1.10.12-pre.069d82ee3a

7 months ago

1.10.7

11 months ago

1.10.7-pre.1c85c600be

11 months ago

1.10.7-pre.d8b9933283

11 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1.10.7-pre.ed59162e98

11 months ago

1.10.6

12 months ago

1.10.7-pre.0701f8751e

11 months ago

1.10.5-pre.a58df6963d

12 months ago

1.10.7-pre.21e00f286f

11 months ago

1.10.6-pre.0b0627a793

12 months ago

1.10.6-pre.a58df6963d

12 months ago

1.10.7-pre.693ce4edfa

11 months ago

1.10.7-pre.1bbd55786b

11 months ago

1.10.4-pre.a58df6963d

12 months ago

1.10.3-pre.56ce5b910b

12 months ago

1.10.7-pre.9652d517cb

11 months ago

1.10.7-pre.6ea7626dde

11 months ago

1.10.7-pre.07d5f980ea

11 months ago

1.10.7-pre.4507b3725f

11 months ago

1.10.7-pre.259d2521fe

11 months ago

1.10.7-pre.4e5ed3b479

11 months ago

1.10.6-pre.97e808db6e

12 months ago

1.10.7-pre.695270df0c

11 months ago

1.10.7-pre.58e577b6e0

11 months ago

1.10.7-pre.83adce205b

11 months ago

1.10.7-pre.03a2fc5cf8

11 months ago

1.10.6-pre.a6297e1769

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

@coveo/auth

Install

SAML

Sample

Sample with @coveo/headless

SamlClientOptions

Sample with `@coveo/headless`

`SamlClientOptions`