@coveo/platform-client 57.10.0 → 57.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { GranularResource, PrivilegeModel } from '../BaseInterfaces.js';
|
|
2
|
-
import { ApiKeyExposureReportSeverity, ApiKeyReportCreationType
|
|
2
|
+
import { ApiKeyStatus, ApiKeyExposureReportSeverity, ApiKeyReportCreationType } from '../Enums.js';
|
|
3
3
|
import { UserModel } from '../Users/UserInterfaces.js';
|
|
4
4
|
export interface ApiKeyBaseModel extends GranularResource {
|
|
5
5
|
/**
|
|
@@ -102,6 +102,32 @@ export interface ApiKeyModel extends ApiKeyBaseModel {
|
|
|
102
102
|
*/
|
|
103
103
|
exposureReport?: ExposureReport;
|
|
104
104
|
}
|
|
105
|
+
export interface ExposureReport {
|
|
106
|
+
/**
|
|
107
|
+
* API Key logger id associated to the Exposure Report
|
|
108
|
+
*/
|
|
109
|
+
apiKeyLoggerId: string;
|
|
110
|
+
/**
|
|
111
|
+
* The severity of the exposure
|
|
112
|
+
*/
|
|
113
|
+
severity: ApiKeyExposureReportSeverity;
|
|
114
|
+
/**
|
|
115
|
+
* The reason behind the exposure report for a given API key
|
|
116
|
+
*/
|
|
117
|
+
reason: string;
|
|
118
|
+
/**
|
|
119
|
+
* The date the key should be deactivated
|
|
120
|
+
*/
|
|
121
|
+
deactivationDate: number;
|
|
122
|
+
/**
|
|
123
|
+
* The way the API key report has been created
|
|
124
|
+
*/
|
|
125
|
+
creationType: ApiKeyReportCreationType;
|
|
126
|
+
/**
|
|
127
|
+
* Represents the user that has created the report
|
|
128
|
+
*/
|
|
129
|
+
createdBy: UserModel;
|
|
130
|
+
}
|
|
105
131
|
export interface CreateApiKeyModel extends ApiKeyBaseModel {
|
|
106
132
|
/**
|
|
107
133
|
* The duration of the API key in ISO-8601 format. Once the duration is reached the key expires and cannot be used anymore.
|
|
@@ -177,30 +203,4 @@ interface EnforceQueryPipelineConfigurationModel {
|
|
|
177
203
|
interface ImpersonationRestrictionsModel {
|
|
178
204
|
allowedUserIds: QueryAuthenticationModel[];
|
|
179
205
|
}
|
|
180
|
-
interface ExposureReport {
|
|
181
|
-
/**
|
|
182
|
-
* API Key logger id associated to the Exposure Report
|
|
183
|
-
*/
|
|
184
|
-
apiKeyLoggerId: string;
|
|
185
|
-
/**
|
|
186
|
-
* The severity of the exposure
|
|
187
|
-
*/
|
|
188
|
-
severity: ApiKeyExposureReportSeverity;
|
|
189
|
-
/**
|
|
190
|
-
* The reason behind the exposure report for a given API key
|
|
191
|
-
*/
|
|
192
|
-
reason: string;
|
|
193
|
-
/**
|
|
194
|
-
* The date the key should be deactivated
|
|
195
|
-
*/
|
|
196
|
-
deactivationDate: number;
|
|
197
|
-
/**
|
|
198
|
-
* The way the API key report has been created
|
|
199
|
-
*/
|
|
200
|
-
creationType: ApiKeyReportCreationType;
|
|
201
|
-
/**
|
|
202
|
-
* Represents the user that has created the report
|
|
203
|
-
*/
|
|
204
|
-
createdBy: UserModel;
|
|
205
|
-
}
|
|
206
206
|
export {};
|