Type Alias BaseIDP

type BaseIDP = {
    active?: boolean;
    clockToleranceSec?: number;
    created?: string;
    createNewUsersOnLogin?: boolean;
    description?: string;
    id?: string;
    interactive?: boolean;
    lastUpdated?: string;
    meta?: unknown;
    postLogoutRedirectUri?: string;
    protocol?: IDPProtocol;
    provider?: IDPProvider;
    tenantIds?: string[];
}
Index

Properties

active?: boolean

Indicates whether the IdP is available for use.

clockToleranceSec?: number
created?: string

The timestamp for when the IdP was created.

createNewUsersOnLogin?: boolean

When the flag is true, new users should be created when logging in for the first time.

description?: string
id?: string

The unique identifier for the IdP.

interactive?: boolean

Indicates the type of connection with the IdP, either interactive login or a machine to machine connection.

lastUpdated?: string

The timestamp for when the IdP was last updated.

meta?: unknown
postLogoutRedirectUri?: string

Direct the user on logout to a specific URI.

protocol?: IDPProtocol

The protocol to be used for communicating with the identity provider. Valid values are OIDC, SAML, jwtAuth, and qsefw-local-bearer-token.

provider?: IDPProvider

The identity provider to be used. If protocol is OIDC, the valid values are auth0, okta, generic, salesforce, keycloak, adfs, and azureAD. If protocol is jwtAuth, the valid value is external.

tenantIds?: string[]

The tenant identifiers associated with the given IdP.