@emilgroup/auth-sdk-node 1.3.0 → 1.4.1
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.
- package/README.md +2 -2
- package/dist/api/authservice-api.d.ts +613 -0
- package/dist/api/authservice-api.js +1069 -0
- package/dist/api/default-api.d.ts +66 -0
- package/dist/api/default-api.js +200 -0
- package/dist/api.d.ts +13 -0
- package/dist/api.js +31 -0
- package/dist/base.d.ts +78 -0
- package/dist/base.js +394 -0
- package/dist/common.d.ts +92 -0
- package/dist/common.js +277 -0
- package/dist/configuration.d.ts +90 -0
- package/dist/configuration.js +44 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +36 -0
- package/dist/models/create-org-and-user-request-dto.d.ts +84 -0
- package/dist/models/create-org-and-user-request-dto.js +15 -0
- package/dist/models/create-org-and-user-response-class.d.ts +32 -0
- package/dist/models/create-org-and-user-response-class.js +15 -0
- package/dist/models/create-user-request-dto.d.ts +54 -0
- package/dist/models/create-user-request-dto.js +15 -0
- package/dist/models/create-user-response-class.d.ts +25 -0
- package/dist/models/create-user-response-class.js +15 -0
- package/dist/models/custom-schema-class.d.ts +66 -0
- package/dist/models/custom-schema-class.js +15 -0
- package/dist/models/forgot-password-request-dto.d.ts +24 -0
- package/dist/models/forgot-password-request-dto.js +15 -0
- package/dist/models/get-samllogin-link-request-dto.d.ts +24 -0
- package/dist/models/get-samllogin-link-request-dto.js +15 -0
- package/dist/models/index.d.ts +21 -0
- package/dist/models/index.js +37 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/login-by-samlrequest-dto.d.ts +30 -0
- package/dist/models/login-by-samlrequest-dto.js +15 -0
- package/dist/models/login-class.d.ts +30 -0
- package/dist/models/login-class.js +15 -0
- package/dist/models/login-request-dto.d.ts +30 -0
- package/dist/models/login-request-dto.js +15 -0
- package/dist/models/logout-request-dto.d.ts +24 -0
- package/dist/models/logout-request-dto.js +15 -0
- package/dist/models/org-invitation-class.d.ts +109 -0
- package/dist/models/org-invitation-class.js +15 -0
- package/dist/models/organization-class.d.ts +114 -0
- package/dist/models/organization-class.js +15 -0
- package/dist/models/refresh-token-dto.d.ts +24 -0
- package/dist/models/refresh-token-dto.js +15 -0
- package/dist/models/reset-password-request-dto.d.ts +36 -0
- package/dist/models/reset-password-request-dto.js +15 -0
- package/dist/models/role-class.d.ts +54 -0
- package/dist/models/role-class.js +15 -0
- package/dist/models/user-class.d.ts +85 -0
- package/dist/models/user-class.js +15 -0
- package/dist/models/verify-org-invitation-request-dto.d.ts +24 -0
- package/dist/models/verify-org-invitation-request-dto.js +15 -0
- package/dist/models/verify-org-invitation-response-class.d.ts +32 -0
- package/dist/models/verify-org-invitation-response-class.js +15 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/auth-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/auth-sdk-node@1.4.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/auth-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/auth-sdk-node@1.4.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -0,0 +1,613 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL AuthService
|
|
3
|
+
* The EMIL AuthService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreateOrgAndUserRequestDto } from '../models';
|
|
16
|
+
import { CreateOrgAndUserResponseClass } from '../models';
|
|
17
|
+
import { CreateUserRequestDto } from '../models';
|
|
18
|
+
import { CreateUserResponseClass } from '../models';
|
|
19
|
+
import { ForgotPasswordRequestDto } from '../models';
|
|
20
|
+
import { LoginBySAMLRequestDto } from '../models';
|
|
21
|
+
import { LoginClass } from '../models';
|
|
22
|
+
import { LoginRequestDto } from '../models';
|
|
23
|
+
import { LogoutRequestDto } from '../models';
|
|
24
|
+
import { RefreshTokenDto } from '../models';
|
|
25
|
+
import { ResetPasswordRequestDto } from '../models';
|
|
26
|
+
import { VerifyOrgInvitationResponseClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* AuthserviceApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export declare const AuthserviceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
|
+
/**
|
|
33
|
+
* Register a new organization with appropriate hierarchy and create a user for that organization.
|
|
34
|
+
* @summary Register Organization and User using invitation token
|
|
35
|
+
* @param {CreateOrgAndUserRequestDto} createOrgAndUserRequestDto
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
createOrgAndUser: (createOrgAndUserRequestDto: CreateOrgAndUserRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
* Register a tenant user using the invite token sent to the tenant user\'s email address.
|
|
42
|
+
* @summary Register tenant user after invite
|
|
43
|
+
* @param {CreateUserRequestDto} createUserRequestDto
|
|
44
|
+
* @param {*} [options] Override http request option.
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
*/
|
|
47
|
+
createUser: (createUserRequestDto: CreateUserRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
+
/**
|
|
49
|
+
* Send a tenant user a reset-password token via email.
|
|
50
|
+
* @summary Forgot password by tenant
|
|
51
|
+
* @param {ForgotPasswordRequestDto} forgotPasswordRequestDto
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
forgotPassword: (forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
/**
|
|
57
|
+
* Get saml login link configured for the tenant in cognito as well as tenant settings
|
|
58
|
+
* @summary Get saml login link for tenant
|
|
59
|
+
* @param {string} tenantSlug
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
getSamlLoginLink: (tenantSlug: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Get new access token, refresh token after successful login.
|
|
66
|
+
* @summary Login by tenant
|
|
67
|
+
* @param {LoginRequestDto} loginRequestDto
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
login: (loginRequestDto: LoginRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
+
/**
|
|
73
|
+
* Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist
|
|
74
|
+
* @summary Login by SAML idp provider such as ADFS
|
|
75
|
+
* @param {LoginBySAMLRequestDto} loginBySAMLRequestDto
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
loginBySAML: (loginBySAMLRequestDto: LoginBySAMLRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
+
/**
|
|
81
|
+
* Sign tenant user out.
|
|
82
|
+
* @summary Logout tenant
|
|
83
|
+
* @param {LogoutRequestDto} logoutRequestDto
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
logout: (logoutRequestDto: LogoutRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
|
+
/**
|
|
89
|
+
* Get new access token, new refresh token.
|
|
90
|
+
* @summary Refresh token by tenant
|
|
91
|
+
* @param {RefreshTokenDto} refreshTokenDto
|
|
92
|
+
* @param {string} [cookie] HTTP only cookie that was sent during login
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
refreshToken: (refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
|
+
/**
|
|
98
|
+
* Change tenant user\'s password using the token provided by the reset password endpoint.
|
|
99
|
+
* @summary Change password by tenant
|
|
100
|
+
* @param {ResetPasswordRequestDto} resetPasswordRequestDto
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
resetPassword: (resetPasswordRequestDto: ResetPasswordRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
105
|
+
/**
|
|
106
|
+
* Verify the invite sent to the tenant user via email.
|
|
107
|
+
* @summary Verify tenant user\'s invite token
|
|
108
|
+
* @param {string} token
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
verifyInvite: (token: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
113
|
+
/**
|
|
114
|
+
* Verifies token and returns necessary data for signing up as an organization.
|
|
115
|
+
* @summary Verify a organization\'s invitation token
|
|
116
|
+
* @param {string} invitationToken
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
verifyOrgInvitation: (invitationToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
121
|
+
/**
|
|
122
|
+
* Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
|
|
123
|
+
* @summary Verify tenant reset password token
|
|
124
|
+
* @param {string} resetToken Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called.
|
|
125
|
+
* @param {*} [options] Override http request option.
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
*/
|
|
128
|
+
verifyResetPasswordToken: (resetToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* AuthserviceApi - functional programming interface
|
|
132
|
+
* @export
|
|
133
|
+
*/
|
|
134
|
+
export declare const AuthserviceApiFp: (configuration?: Configuration) => {
|
|
135
|
+
/**
|
|
136
|
+
* Register a new organization with appropriate hierarchy and create a user for that organization.
|
|
137
|
+
* @summary Register Organization and User using invitation token
|
|
138
|
+
* @param {CreateOrgAndUserRequestDto} createOrgAndUserRequestDto
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
createOrgAndUser(createOrgAndUserRequestDto: CreateOrgAndUserRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrgAndUserResponseClass>>;
|
|
143
|
+
/**
|
|
144
|
+
* Register a tenant user using the invite token sent to the tenant user\'s email address.
|
|
145
|
+
* @summary Register tenant user after invite
|
|
146
|
+
* @param {CreateUserRequestDto} createUserRequestDto
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
createUser(createUserRequestDto: CreateUserRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponseClass>>;
|
|
151
|
+
/**
|
|
152
|
+
* Send a tenant user a reset-password token via email.
|
|
153
|
+
* @summary Forgot password by tenant
|
|
154
|
+
* @param {ForgotPasswordRequestDto} forgotPasswordRequestDto
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
159
|
+
/**
|
|
160
|
+
* Get saml login link configured for the tenant in cognito as well as tenant settings
|
|
161
|
+
* @summary Get saml login link for tenant
|
|
162
|
+
* @param {string} tenantSlug
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
getSamlLoginLink(tenantSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
167
|
+
/**
|
|
168
|
+
* Get new access token, refresh token after successful login.
|
|
169
|
+
* @summary Login by tenant
|
|
170
|
+
* @param {LoginRequestDto} loginRequestDto
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
*/
|
|
174
|
+
login(loginRequestDto: LoginRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginClass>>;
|
|
175
|
+
/**
|
|
176
|
+
* Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist
|
|
177
|
+
* @summary Login by SAML idp provider such as ADFS
|
|
178
|
+
* @param {LoginBySAMLRequestDto} loginBySAMLRequestDto
|
|
179
|
+
* @param {*} [options] Override http request option.
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
*/
|
|
182
|
+
loginBySAML(loginBySAMLRequestDto: LoginBySAMLRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginClass>>;
|
|
183
|
+
/**
|
|
184
|
+
* Sign tenant user out.
|
|
185
|
+
* @summary Logout tenant
|
|
186
|
+
* @param {LogoutRequestDto} logoutRequestDto
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
logout(logoutRequestDto: LogoutRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
191
|
+
/**
|
|
192
|
+
* Get new access token, new refresh token.
|
|
193
|
+
* @summary Refresh token by tenant
|
|
194
|
+
* @param {RefreshTokenDto} refreshTokenDto
|
|
195
|
+
* @param {string} [cookie] HTTP only cookie that was sent during login
|
|
196
|
+
* @param {*} [options] Override http request option.
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
*/
|
|
199
|
+
refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginClass>>;
|
|
200
|
+
/**
|
|
201
|
+
* Change tenant user\'s password using the token provided by the reset password endpoint.
|
|
202
|
+
* @summary Change password by tenant
|
|
203
|
+
* @param {ResetPasswordRequestDto} resetPasswordRequestDto
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
*/
|
|
207
|
+
resetPassword(resetPasswordRequestDto: ResetPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
208
|
+
/**
|
|
209
|
+
* Verify the invite sent to the tenant user via email.
|
|
210
|
+
* @summary Verify tenant user\'s invite token
|
|
211
|
+
* @param {string} token
|
|
212
|
+
* @param {*} [options] Override http request option.
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
*/
|
|
215
|
+
verifyInvite(token: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
216
|
+
/**
|
|
217
|
+
* Verifies token and returns necessary data for signing up as an organization.
|
|
218
|
+
* @summary Verify a organization\'s invitation token
|
|
219
|
+
* @param {string} invitationToken
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
verifyOrgInvitation(invitationToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyOrgInvitationResponseClass>>;
|
|
224
|
+
/**
|
|
225
|
+
* Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
|
|
226
|
+
* @summary Verify tenant reset password token
|
|
227
|
+
* @param {string} resetToken Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called.
|
|
228
|
+
* @param {*} [options] Override http request option.
|
|
229
|
+
* @throws {RequiredError}
|
|
230
|
+
*/
|
|
231
|
+
verifyResetPasswordToken(resetToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* AuthserviceApi - factory interface
|
|
235
|
+
* @export
|
|
236
|
+
*/
|
|
237
|
+
export declare const AuthserviceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
238
|
+
/**
|
|
239
|
+
* Register a new organization with appropriate hierarchy and create a user for that organization.
|
|
240
|
+
* @summary Register Organization and User using invitation token
|
|
241
|
+
* @param {CreateOrgAndUserRequestDto} createOrgAndUserRequestDto
|
|
242
|
+
* @param {*} [options] Override http request option.
|
|
243
|
+
* @throws {RequiredError}
|
|
244
|
+
*/
|
|
245
|
+
createOrgAndUser(createOrgAndUserRequestDto: CreateOrgAndUserRequestDto, options?: any): AxiosPromise<CreateOrgAndUserResponseClass>;
|
|
246
|
+
/**
|
|
247
|
+
* Register a tenant user using the invite token sent to the tenant user\'s email address.
|
|
248
|
+
* @summary Register tenant user after invite
|
|
249
|
+
* @param {CreateUserRequestDto} createUserRequestDto
|
|
250
|
+
* @param {*} [options] Override http request option.
|
|
251
|
+
* @throws {RequiredError}
|
|
252
|
+
*/
|
|
253
|
+
createUser(createUserRequestDto: CreateUserRequestDto, options?: any): AxiosPromise<CreateUserResponseClass>;
|
|
254
|
+
/**
|
|
255
|
+
* Send a tenant user a reset-password token via email.
|
|
256
|
+
* @summary Forgot password by tenant
|
|
257
|
+
* @param {ForgotPasswordRequestDto} forgotPasswordRequestDto
|
|
258
|
+
* @param {*} [options] Override http request option.
|
|
259
|
+
* @throws {RequiredError}
|
|
260
|
+
*/
|
|
261
|
+
forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: any): AxiosPromise<void>;
|
|
262
|
+
/**
|
|
263
|
+
* Get saml login link configured for the tenant in cognito as well as tenant settings
|
|
264
|
+
* @summary Get saml login link for tenant
|
|
265
|
+
* @param {string} tenantSlug
|
|
266
|
+
* @param {*} [options] Override http request option.
|
|
267
|
+
* @throws {RequiredError}
|
|
268
|
+
*/
|
|
269
|
+
getSamlLoginLink(tenantSlug: string, options?: any): AxiosPromise<void>;
|
|
270
|
+
/**
|
|
271
|
+
* Get new access token, refresh token after successful login.
|
|
272
|
+
* @summary Login by tenant
|
|
273
|
+
* @param {LoginRequestDto} loginRequestDto
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
login(loginRequestDto: LoginRequestDto, options?: any): AxiosPromise<LoginClass>;
|
|
278
|
+
/**
|
|
279
|
+
* Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist
|
|
280
|
+
* @summary Login by SAML idp provider such as ADFS
|
|
281
|
+
* @param {LoginBySAMLRequestDto} loginBySAMLRequestDto
|
|
282
|
+
* @param {*} [options] Override http request option.
|
|
283
|
+
* @throws {RequiredError}
|
|
284
|
+
*/
|
|
285
|
+
loginBySAML(loginBySAMLRequestDto: LoginBySAMLRequestDto, options?: any): AxiosPromise<LoginClass>;
|
|
286
|
+
/**
|
|
287
|
+
* Sign tenant user out.
|
|
288
|
+
* @summary Logout tenant
|
|
289
|
+
* @param {LogoutRequestDto} logoutRequestDto
|
|
290
|
+
* @param {*} [options] Override http request option.
|
|
291
|
+
* @throws {RequiredError}
|
|
292
|
+
*/
|
|
293
|
+
logout(logoutRequestDto: LogoutRequestDto, options?: any): AxiosPromise<void>;
|
|
294
|
+
/**
|
|
295
|
+
* Get new access token, new refresh token.
|
|
296
|
+
* @summary Refresh token by tenant
|
|
297
|
+
* @param {RefreshTokenDto} refreshTokenDto
|
|
298
|
+
* @param {string} [cookie] HTTP only cookie that was sent during login
|
|
299
|
+
* @param {*} [options] Override http request option.
|
|
300
|
+
* @throws {RequiredError}
|
|
301
|
+
*/
|
|
302
|
+
refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: any): AxiosPromise<LoginClass>;
|
|
303
|
+
/**
|
|
304
|
+
* Change tenant user\'s password using the token provided by the reset password endpoint.
|
|
305
|
+
* @summary Change password by tenant
|
|
306
|
+
* @param {ResetPasswordRequestDto} resetPasswordRequestDto
|
|
307
|
+
* @param {*} [options] Override http request option.
|
|
308
|
+
* @throws {RequiredError}
|
|
309
|
+
*/
|
|
310
|
+
resetPassword(resetPasswordRequestDto: ResetPasswordRequestDto, options?: any): AxiosPromise<void>;
|
|
311
|
+
/**
|
|
312
|
+
* Verify the invite sent to the tenant user via email.
|
|
313
|
+
* @summary Verify tenant user\'s invite token
|
|
314
|
+
* @param {string} token
|
|
315
|
+
* @param {*} [options] Override http request option.
|
|
316
|
+
* @throws {RequiredError}
|
|
317
|
+
*/
|
|
318
|
+
verifyInvite(token: string, options?: any): AxiosPromise<void>;
|
|
319
|
+
/**
|
|
320
|
+
* Verifies token and returns necessary data for signing up as an organization.
|
|
321
|
+
* @summary Verify a organization\'s invitation token
|
|
322
|
+
* @param {string} invitationToken
|
|
323
|
+
* @param {*} [options] Override http request option.
|
|
324
|
+
* @throws {RequiredError}
|
|
325
|
+
*/
|
|
326
|
+
verifyOrgInvitation(invitationToken: string, options?: any): AxiosPromise<VerifyOrgInvitationResponseClass>;
|
|
327
|
+
/**
|
|
328
|
+
* Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
|
|
329
|
+
* @summary Verify tenant reset password token
|
|
330
|
+
* @param {string} resetToken Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called.
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
*/
|
|
334
|
+
verifyResetPasswordToken(resetToken: string, options?: any): AxiosPromise<void>;
|
|
335
|
+
};
|
|
336
|
+
/**
|
|
337
|
+
* Request parameters for createOrgAndUser operation in AuthserviceApi.
|
|
338
|
+
* @export
|
|
339
|
+
* @interface AuthserviceApiCreateOrgAndUserRequest
|
|
340
|
+
*/
|
|
341
|
+
export interface AuthserviceApiCreateOrgAndUserRequest {
|
|
342
|
+
/**
|
|
343
|
+
*
|
|
344
|
+
* @type {CreateOrgAndUserRequestDto}
|
|
345
|
+
* @memberof AuthserviceApiCreateOrgAndUser
|
|
346
|
+
*/
|
|
347
|
+
readonly createOrgAndUserRequestDto: CreateOrgAndUserRequestDto;
|
|
348
|
+
}
|
|
349
|
+
/**
|
|
350
|
+
* Request parameters for createUser operation in AuthserviceApi.
|
|
351
|
+
* @export
|
|
352
|
+
* @interface AuthserviceApiCreateUserRequest
|
|
353
|
+
*/
|
|
354
|
+
export interface AuthserviceApiCreateUserRequest {
|
|
355
|
+
/**
|
|
356
|
+
*
|
|
357
|
+
* @type {CreateUserRequestDto}
|
|
358
|
+
* @memberof AuthserviceApiCreateUser
|
|
359
|
+
*/
|
|
360
|
+
readonly createUserRequestDto: CreateUserRequestDto;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* Request parameters for forgotPassword operation in AuthserviceApi.
|
|
364
|
+
* @export
|
|
365
|
+
* @interface AuthserviceApiForgotPasswordRequest
|
|
366
|
+
*/
|
|
367
|
+
export interface AuthserviceApiForgotPasswordRequest {
|
|
368
|
+
/**
|
|
369
|
+
*
|
|
370
|
+
* @type {ForgotPasswordRequestDto}
|
|
371
|
+
* @memberof AuthserviceApiForgotPassword
|
|
372
|
+
*/
|
|
373
|
+
readonly forgotPasswordRequestDto: ForgotPasswordRequestDto;
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* Request parameters for getSamlLoginLink operation in AuthserviceApi.
|
|
377
|
+
* @export
|
|
378
|
+
* @interface AuthserviceApiGetSamlLoginLinkRequest
|
|
379
|
+
*/
|
|
380
|
+
export interface AuthserviceApiGetSamlLoginLinkRequest {
|
|
381
|
+
/**
|
|
382
|
+
*
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof AuthserviceApiGetSamlLoginLink
|
|
385
|
+
*/
|
|
386
|
+
readonly tenantSlug: string;
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* Request parameters for login operation in AuthserviceApi.
|
|
390
|
+
* @export
|
|
391
|
+
* @interface AuthserviceApiLoginRequest
|
|
392
|
+
*/
|
|
393
|
+
export interface AuthserviceApiLoginRequest {
|
|
394
|
+
/**
|
|
395
|
+
*
|
|
396
|
+
* @type {LoginRequestDto}
|
|
397
|
+
* @memberof AuthserviceApiLogin
|
|
398
|
+
*/
|
|
399
|
+
readonly loginRequestDto: LoginRequestDto;
|
|
400
|
+
}
|
|
401
|
+
/**
|
|
402
|
+
* Request parameters for loginBySAML operation in AuthserviceApi.
|
|
403
|
+
* @export
|
|
404
|
+
* @interface AuthserviceApiLoginBySAMLRequest
|
|
405
|
+
*/
|
|
406
|
+
export interface AuthserviceApiLoginBySAMLRequest {
|
|
407
|
+
/**
|
|
408
|
+
*
|
|
409
|
+
* @type {LoginBySAMLRequestDto}
|
|
410
|
+
* @memberof AuthserviceApiLoginBySAML
|
|
411
|
+
*/
|
|
412
|
+
readonly loginBySAMLRequestDto: LoginBySAMLRequestDto;
|
|
413
|
+
}
|
|
414
|
+
/**
|
|
415
|
+
* Request parameters for logout operation in AuthserviceApi.
|
|
416
|
+
* @export
|
|
417
|
+
* @interface AuthserviceApiLogoutRequest
|
|
418
|
+
*/
|
|
419
|
+
export interface AuthserviceApiLogoutRequest {
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @type {LogoutRequestDto}
|
|
423
|
+
* @memberof AuthserviceApiLogout
|
|
424
|
+
*/
|
|
425
|
+
readonly logoutRequestDto: LogoutRequestDto;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* Request parameters for refreshToken operation in AuthserviceApi.
|
|
429
|
+
* @export
|
|
430
|
+
* @interface AuthserviceApiRefreshTokenRequest
|
|
431
|
+
*/
|
|
432
|
+
export interface AuthserviceApiRefreshTokenRequest {
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @type {RefreshTokenDto}
|
|
436
|
+
* @memberof AuthserviceApiRefreshToken
|
|
437
|
+
*/
|
|
438
|
+
readonly refreshTokenDto: RefreshTokenDto;
|
|
439
|
+
/**
|
|
440
|
+
* HTTP only cookie that was sent during login
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof AuthserviceApiRefreshToken
|
|
443
|
+
*/
|
|
444
|
+
readonly cookie?: string;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* Request parameters for resetPassword operation in AuthserviceApi.
|
|
448
|
+
* @export
|
|
449
|
+
* @interface AuthserviceApiResetPasswordRequest
|
|
450
|
+
*/
|
|
451
|
+
export interface AuthserviceApiResetPasswordRequest {
|
|
452
|
+
/**
|
|
453
|
+
*
|
|
454
|
+
* @type {ResetPasswordRequestDto}
|
|
455
|
+
* @memberof AuthserviceApiResetPassword
|
|
456
|
+
*/
|
|
457
|
+
readonly resetPasswordRequestDto: ResetPasswordRequestDto;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* Request parameters for verifyInvite operation in AuthserviceApi.
|
|
461
|
+
* @export
|
|
462
|
+
* @interface AuthserviceApiVerifyInviteRequest
|
|
463
|
+
*/
|
|
464
|
+
export interface AuthserviceApiVerifyInviteRequest {
|
|
465
|
+
/**
|
|
466
|
+
*
|
|
467
|
+
* @type {string}
|
|
468
|
+
* @memberof AuthserviceApiVerifyInvite
|
|
469
|
+
*/
|
|
470
|
+
readonly token: string;
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* Request parameters for verifyOrgInvitation operation in AuthserviceApi.
|
|
474
|
+
* @export
|
|
475
|
+
* @interface AuthserviceApiVerifyOrgInvitationRequest
|
|
476
|
+
*/
|
|
477
|
+
export interface AuthserviceApiVerifyOrgInvitationRequest {
|
|
478
|
+
/**
|
|
479
|
+
*
|
|
480
|
+
* @type {string}
|
|
481
|
+
* @memberof AuthserviceApiVerifyOrgInvitation
|
|
482
|
+
*/
|
|
483
|
+
readonly invitationToken: string;
|
|
484
|
+
}
|
|
485
|
+
/**
|
|
486
|
+
* Request parameters for verifyResetPasswordToken operation in AuthserviceApi.
|
|
487
|
+
* @export
|
|
488
|
+
* @interface AuthserviceApiVerifyResetPasswordTokenRequest
|
|
489
|
+
*/
|
|
490
|
+
export interface AuthserviceApiVerifyResetPasswordTokenRequest {
|
|
491
|
+
/**
|
|
492
|
+
* Tenant user\'s reset token. Reset token can be found in the email sent after \'forgot-password\' endpoint was called.
|
|
493
|
+
* @type {string}
|
|
494
|
+
* @memberof AuthserviceApiVerifyResetPasswordToken
|
|
495
|
+
*/
|
|
496
|
+
readonly resetToken: string;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* AuthserviceApi - object-oriented interface
|
|
500
|
+
* @export
|
|
501
|
+
* @class AuthserviceApi
|
|
502
|
+
* @extends {BaseAPI}
|
|
503
|
+
*/
|
|
504
|
+
export declare class AuthserviceApi extends BaseAPI {
|
|
505
|
+
/**
|
|
506
|
+
* Register a new organization with appropriate hierarchy and create a user for that organization.
|
|
507
|
+
* @summary Register Organization and User using invitation token
|
|
508
|
+
* @param {AuthserviceApiCreateOrgAndUserRequest} requestParameters Request parameters.
|
|
509
|
+
* @param {*} [options] Override http request option.
|
|
510
|
+
* @throws {RequiredError}
|
|
511
|
+
* @memberof AuthserviceApi
|
|
512
|
+
*/
|
|
513
|
+
createOrgAndUser(requestParameters: AuthserviceApiCreateOrgAndUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrgAndUserResponseClass, any>>;
|
|
514
|
+
/**
|
|
515
|
+
* Register a tenant user using the invite token sent to the tenant user\'s email address.
|
|
516
|
+
* @summary Register tenant user after invite
|
|
517
|
+
* @param {AuthserviceApiCreateUserRequest} requestParameters Request parameters.
|
|
518
|
+
* @param {*} [options] Override http request option.
|
|
519
|
+
* @throws {RequiredError}
|
|
520
|
+
* @memberof AuthserviceApi
|
|
521
|
+
*/
|
|
522
|
+
createUser(requestParameters: AuthserviceApiCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateUserResponseClass, any>>;
|
|
523
|
+
/**
|
|
524
|
+
* Send a tenant user a reset-password token via email.
|
|
525
|
+
* @summary Forgot password by tenant
|
|
526
|
+
* @param {AuthserviceApiForgotPasswordRequest} requestParameters Request parameters.
|
|
527
|
+
* @param {*} [options] Override http request option.
|
|
528
|
+
* @throws {RequiredError}
|
|
529
|
+
* @memberof AuthserviceApi
|
|
530
|
+
*/
|
|
531
|
+
forgotPassword(requestParameters: AuthserviceApiForgotPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
532
|
+
/**
|
|
533
|
+
* Get saml login link configured for the tenant in cognito as well as tenant settings
|
|
534
|
+
* @summary Get saml login link for tenant
|
|
535
|
+
* @param {AuthserviceApiGetSamlLoginLinkRequest} requestParameters Request parameters.
|
|
536
|
+
* @param {*} [options] Override http request option.
|
|
537
|
+
* @throws {RequiredError}
|
|
538
|
+
* @memberof AuthserviceApi
|
|
539
|
+
*/
|
|
540
|
+
getSamlLoginLink(requestParameters: AuthserviceApiGetSamlLoginLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
541
|
+
/**
|
|
542
|
+
* Get new access token, refresh token after successful login.
|
|
543
|
+
* @summary Login by tenant
|
|
544
|
+
* @param {AuthserviceApiLoginRequest} requestParameters Request parameters.
|
|
545
|
+
* @param {*} [options] Override http request option.
|
|
546
|
+
* @throws {RequiredError}
|
|
547
|
+
* @memberof AuthserviceApi
|
|
548
|
+
*/
|
|
549
|
+
login(requestParameters: AuthserviceApiLoginRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginClass, any>>;
|
|
550
|
+
/**
|
|
551
|
+
* Get new access token, refresh token after successful login. This api also creates a tenant user if user does not exist
|
|
552
|
+
* @summary Login by SAML idp provider such as ADFS
|
|
553
|
+
* @param {AuthserviceApiLoginBySAMLRequest} requestParameters Request parameters.
|
|
554
|
+
* @param {*} [options] Override http request option.
|
|
555
|
+
* @throws {RequiredError}
|
|
556
|
+
* @memberof AuthserviceApi
|
|
557
|
+
*/
|
|
558
|
+
loginBySAML(requestParameters: AuthserviceApiLoginBySAMLRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginClass, any>>;
|
|
559
|
+
/**
|
|
560
|
+
* Sign tenant user out.
|
|
561
|
+
* @summary Logout tenant
|
|
562
|
+
* @param {AuthserviceApiLogoutRequest} requestParameters Request parameters.
|
|
563
|
+
* @param {*} [options] Override http request option.
|
|
564
|
+
* @throws {RequiredError}
|
|
565
|
+
* @memberof AuthserviceApi
|
|
566
|
+
*/
|
|
567
|
+
logout(requestParameters: AuthserviceApiLogoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
568
|
+
/**
|
|
569
|
+
* Get new access token, new refresh token.
|
|
570
|
+
* @summary Refresh token by tenant
|
|
571
|
+
* @param {AuthserviceApiRefreshTokenRequest} requestParameters Request parameters.
|
|
572
|
+
* @param {*} [options] Override http request option.
|
|
573
|
+
* @throws {RequiredError}
|
|
574
|
+
* @memberof AuthserviceApi
|
|
575
|
+
*/
|
|
576
|
+
refreshToken(requestParameters: AuthserviceApiRefreshTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginClass, any>>;
|
|
577
|
+
/**
|
|
578
|
+
* Change tenant user\'s password using the token provided by the reset password endpoint.
|
|
579
|
+
* @summary Change password by tenant
|
|
580
|
+
* @param {AuthserviceApiResetPasswordRequest} requestParameters Request parameters.
|
|
581
|
+
* @param {*} [options] Override http request option.
|
|
582
|
+
* @throws {RequiredError}
|
|
583
|
+
* @memberof AuthserviceApi
|
|
584
|
+
*/
|
|
585
|
+
resetPassword(requestParameters: AuthserviceApiResetPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
586
|
+
/**
|
|
587
|
+
* Verify the invite sent to the tenant user via email.
|
|
588
|
+
* @summary Verify tenant user\'s invite token
|
|
589
|
+
* @param {AuthserviceApiVerifyInviteRequest} requestParameters Request parameters.
|
|
590
|
+
* @param {*} [options] Override http request option.
|
|
591
|
+
* @throws {RequiredError}
|
|
592
|
+
* @memberof AuthserviceApi
|
|
593
|
+
*/
|
|
594
|
+
verifyInvite(requestParameters: AuthserviceApiVerifyInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
595
|
+
/**
|
|
596
|
+
* Verifies token and returns necessary data for signing up as an organization.
|
|
597
|
+
* @summary Verify a organization\'s invitation token
|
|
598
|
+
* @param {AuthserviceApiVerifyOrgInvitationRequest} requestParameters Request parameters.
|
|
599
|
+
* @param {*} [options] Override http request option.
|
|
600
|
+
* @throws {RequiredError}
|
|
601
|
+
* @memberof AuthserviceApi
|
|
602
|
+
*/
|
|
603
|
+
verifyOrgInvitation(requestParameters: AuthserviceApiVerifyOrgInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyOrgInvitationResponseClass, any>>;
|
|
604
|
+
/**
|
|
605
|
+
* Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
|
|
606
|
+
* @summary Verify tenant reset password token
|
|
607
|
+
* @param {AuthserviceApiVerifyResetPasswordTokenRequest} requestParameters Request parameters.
|
|
608
|
+
* @param {*} [options] Override http request option.
|
|
609
|
+
* @throws {RequiredError}
|
|
610
|
+
* @memberof AuthserviceApi
|
|
611
|
+
*/
|
|
612
|
+
verifyResetPasswordToken(requestParameters: AuthserviceApiVerifyResetPasswordTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
613
|
+
}
|