UNPKG

@twin.org/api-tenant-processor

Version:

API Tenant Processor for converting and api key to a tenant id.

twindev.org

twinfoundation/api

124 lines (62 loc) • 1.57 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# Interface: ITenantAdminComponent Configuration for the tenant admin component ## Extends - `IComponent` ## Methods ### get() > **get**(`tenantId`): `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\> Get a tenant by its id. #### Parameters ##### tenantId `string` The id of the tenant. #### Returns `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\> The tenant or undefined if not found. *** ### getByApiKey() > **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\> Get a tenant by its api key. #### Parameters ##### apiKey `string` The api key of the tenant. #### Returns `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\> The tenant or undefined if not found. *** ### set() > **set**(`tenant`): `Promise`\<`void`\> Set a tenant. #### Parameters ##### tenant [`ITenant`](ITenant.md) The tenant to store. #### Returns `Promise`\<`void`\> Nothing. *** ### remove() > **remove**(`tenantId`): `Promise`\<`void`\> Remove a tenant by its id. #### Parameters ##### tenantId `string` The id of the tenant. #### Returns `Promise`\<`void`\> Nothing. *** ### query() > **query**(`cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\> Query tenants with pagination. #### Parameters ##### cursor? `string` The cursor to start from. ##### limit? `number` The maximum number of tenants to return. #### Returns `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\> The tenants and the next cursor if more tenants are available.