BaseAuthProviderConfig interface

The base Auth provider configuration interface.

Signature:

exportinterfaceBaseAuthProviderConfig

Properties

PropertyTypeDescription
displayNamestringThe user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console.
enabledbooleanWhether the provider configuration is enabled or disabled. A user cannot sign in using a disabled provider.
providerIdstringThe provider ID defined by the developer. For a SAML provider, this is always prefixed by saml.. For an OIDC provider, this is always prefixed by oidc..

BaseAuthProviderConfig.displayName

The user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console.

Signature:

displayName?:string;

BaseAuthProviderConfig.enabled

Whether the provider configuration is enabled or disabled. A user cannot sign in using a disabled provider.

Signature:

enabled:boolean;

BaseAuthProviderConfig.providerId

The provider ID defined by the developer. For a SAML provider, this is always prefixed by saml.. For an OIDC provider, this is always prefixed by oidc..

Signature:

providerId:string;