AuthProviderConfigFilter interface
Stay organized with collections
Save and categorize content based on your preferences.
The filter interface used for listing provider configurations. This is used when specifying how to list configured identity providers via BaseAuth.listProviderConfigs().
Signature:
export interface AuthProviderConfigFilter
Properties
| Property |
Type |
Description |
| maxResults |
number |
The maximum number of results to return per page. The default and maximum is 100. |
| pageToken |
string |
The next page token. When not specified, the lookup starts from the beginning of the list. |
| type |
'saml' | 'oidc' |
The Auth provider configuration filter. This can be either saml or oidc. The former is used to look up SAML providers only, while the latter is used for OIDC providers. |
AuthProviderConfigFilter.maxResults
The maximum number of results to return per page. The default and maximum is 100.
Signature:
maxResults?: number;
AuthProviderConfigFilter.pageToken
The next page token. When not specified, the lookup starts from the beginning of the list.
Signature:
pageToken?: string;
AuthProviderConfigFilter.type
The Auth provider configuration filter. This can be either saml or oidc. The former is used to look up SAML providers only, while the latter is used for OIDC providers.
Signature:
type: 'saml' | 'oidc';
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,["# AuthProviderConfigFilter interface\n\nThe filter interface used for listing provider configurations. This is used when specifying how to list configured identity providers via [BaseAuth.listProviderConfigs()](./firebase-admin.auth.baseauth.md#baseauthlistproviderconfigs).\n\n**Signature:** \n\n export interface AuthProviderConfigFilter \n\nProperties\n----------\n\n| Property | Type | Description |\n|----------------------------------------------------------------------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [maxResults](./firebase-admin.auth.authproviderconfigfilter.md#authproviderconfigfiltermaxresults) | number | The maximum number of results to return per page. The default and maximum is 100. |\n| [pageToken](./firebase-admin.auth.authproviderconfigfilter.md#authproviderconfigfilterpagetoken) | string | The next page token. When not specified, the lookup starts from the beginning of the list. |\n| [type](./firebase-admin.auth.authproviderconfigfilter.md#authproviderconfigfiltertype) | 'saml' \\| 'oidc' | The Auth provider configuration filter. This can be either `saml` or `oidc`. The former is used to look up SAML providers only, while the latter is used for OIDC providers. |\n\nAuthProviderConfigFilter.maxResults\n-----------------------------------\n\nThe maximum number of results to return per page. The default and maximum is 100.\n\n**Signature:** \n\n maxResults?: number;\n\nAuthProviderConfigFilter.pageToken\n----------------------------------\n\nThe next page token. When not specified, the lookup starts from the beginning of the list.\n\n**Signature:** \n\n pageToken?: string;\n\nAuthProviderConfigFilter.type\n-----------------------------\n\nThe Auth provider configuration filter. This can be either `saml` or `oidc`. The former is used to look up SAML providers only, while the latter is used for OIDC providers.\n\n**Signature:** \n\n type: 'saml' | 'oidc';"]]
