BaseAuthProviderConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
The base Auth provider configuration interface.
Signature:
export interface BaseAuthProviderConfig
Properties
| Property |
Type |
Description |
| displayName |
string |
The user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console. |
| enabled |
boolean |
Whether the provider configuration is enabled or disabled. A user cannot sign in using a disabled provider. |
| providerId |
string |
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.. |
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;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["The base Auth provider configuration interface.\n\n**Signature:** \n\n export interface BaseAuthProviderConfig \n\nProperties\n\nBaseAuthProviderConfig.displayName\n\nThe user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console.\n\n**Signature:** \n\n displayName?: string;\n\nBaseAuthProviderConfig.enabled\n\nWhether the provider configuration is enabled or disabled. A user cannot sign in using a disabled provider.\n\n**Signature:** \n\n enabled: boolean;\n\nBaseAuthProviderConfig.providerId\n\nThe 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.`.\n\n**Signature:** \n\n providerId: string;"]]
