Authentication Policy

Configures an authentication policy.

$idstring Required

Must be at least 1 characters long

Must be at most 64 characters long

$schemaconst Required

namestring Required

The name of the authentication policy

Must be at least 1 characters long

Must be at most 255 characters long

authentication Required

Type: object

The following properties are required:

  • yext
Type: object

The following properties are required:

  • oidc
Type: object

The following properties are required:

  • password

boolean

object

string Required

The Client ID provided by the OIDC Identity Provider.

string Required

The Client Secret provided by the OIDC Identity Provider.

string Required

The login URL provided by the OIDC Identity Provider.

string

An optional endpoint used for OIDC configuration discovery. This endpoint may be needed for some Identity Providers where the configuration endpoint cannot be derived from the loginURL. When this endpoint is provided, the loginURL will be used as the issuer endpoint regardless of the one provided in the discovery document.

object

string Required

apiTokensarray

A list of all api tokens for the policy

Each item of this array must be:

Type: object

string Required

string Required

object Required

string Required

integer Required

object

Default: {“experienceVersion”: “STAGING”}

string

The version label of the Answers experience associated with the event.

string