TTenantLookup Class
Describes how to resolve the tenant of a request from an external identifier registered in the tenant catalog.
Remarks
A lookup reads a value from the request (a user claim, a header, a query parameter or the host name, according to Source and Name) and asks the catalog which tenant the identifier Identifier with that value maps to. For example, a lookup with source UserClaim, name sub and identifier user_id resolves the tenant of the authenticated user, provided the application registered the identifier user_id = user id for the tenant.
Syntax
Unit: XData.Comp.TenantConnectionPool
TTenantLookup = class(TCollectionItem);Constructors
| Name | Description |
|---|---|
| Create | Creates a new TTenantLookup item. |
Methods
| Name | Description |
|---|---|
| IdentifierName | Returns the name of the catalog identifier used by the lookup. |
Properties
| Name | Description |
|---|---|
| Identifier | Gets or sets the name of the catalog identifier the value is matched against (for example, user_id or domain). |
| Name | Gets or sets the name of the claim, header or query parameter to read the value from. |
| Source | Gets or sets where the value is read from. |