Defines Auth multi-tenancy references in index.d.ts. #572
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wuyanna
reviewed
Jun 17, 2019
wuyanna
reviewed
Jun 18, 2019
wuyanna
reviewed
Jun 18, 2019
wuyanna
approved these changes
Jun 19, 2019
kevinthecheung
requested changes
Jun 20, 2019
src/index.d.ts
Outdated
| * A tenant configuration provides information such as the type of tenant (lightweight or | ||
| * full service), display name, tenant identifier and email authentication configuration. | ||
| * For OIDC/SAML provider configuration management, `TenantAwareAuth` instances should | ||
| * be used instead. When configuring these providers, note that tenants will inherit |
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * The current tenant type: `lightweight` or `full_service`. | ||
| * Tenants that use separare billing and quota will require their own project and |
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * Creates a new tenant. | ||
| * When creating new tenants, tenants that use separare billing and quota will require their |
src/index.d.ts
Outdated
| @@ -602,6 +602,10 @@ declare namespace admin.auth { | |||
| * resets, password or email updates, etc). | |||
| */ | |||
| tokensValidAfterTime?: string; | |||
|
|
|||
| /** | |||
| * The user's tenant identifier if available. | |||
There was a problem hiding this comment.
The ID of the tenant the user belongs to
src/index.d.ts
Outdated
| @@ -727,6 +731,10 @@ declare namespace admin.auth { | |||
| * `"google.com"`, `"twitter.com"`, or `"custom"`. | |||
| */ | |||
| sign_in_provider: string; | |||
|
|
|||
| /** | |||
| * The user's tenant ID if available. | |||
src/index.d.ts
Outdated
| interface Tenant { | ||
|
|
||
| /** | ||
| * The current tenant identifier. |
There was a problem hiding this comment.
Can you omit "current" here and throughout?
src/index.d.ts
Outdated
| passwordRequired?: boolean; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Interface representing the properties to set on a new tenant to be created. |
src/index.d.ts
Outdated
| @@ -1820,18 +1933,101 @@ declare namespace admin.auth { | |||
| ): Promise<admin.auth.AuthProviderConfig>; | |||
| } | |||
|
|
|||
| /** | |||
| * Tenant aware `Auth` interface used for managing user, configuring SAML/OIDC providers, | |||
src/index.d.ts
Outdated
| @@ -1820,18 +1933,101 @@ declare namespace admin.auth { | |||
| ): Promise<admin.auth.AuthProviderConfig>; | |||
| } | |||
|
|
|||
| /** | |||
| * Tenant aware `Auth` interface used for managing user, configuring SAML/OIDC providers, | |||
kevinthecheung
approved these changes
Jun 21, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Defines Auth multi-tenancy references in index.d.ts.