@emilgroup/tenant-sdk-node 1.39.1-beta.9 → 1.39.1-beta.98
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/.openapi-generator/FILES +32 -1
- package/README.md +2 -2
- package/api/invite-users-api.ts +8 -8
- package/api/ssoconnection-api.ts +793 -0
- package/api/ssoid-pgroups-api.ts +803 -0
- package/api/user-controller-rest-api.ts +12 -12
- package/api/users-api.ts +4 -4
- package/api.ts +4 -0
- package/dist/api/invite-users-api.d.ts +8 -8
- package/dist/api/invite-users-api.js +6 -6
- package/dist/api/ssoconnection-api.d.ts +434 -0
- package/dist/api/ssoconnection-api.js +784 -0
- package/dist/api/ssoid-pgroups-api.d.ts +451 -0
- package/dist/api/ssoid-pgroups-api.js +739 -0
- package/dist/api/user-controller-rest-api.d.ts +12 -12
- package/dist/api/user-controller-rest-api.js +9 -9
- package/dist/api/users-api.d.ts +4 -4
- package/dist/api/users-api.js +3 -3
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/admin-initial-tenant-config-dto.d.ts +4 -2
- package/dist/models/create-sso-connection-request-dto.d.ts +67 -0
- package/dist/models/create-sso-connection-request-dto.js +24 -0
- package/dist/models/create-sso-connection-response-class.d.ts +25 -0
- package/dist/models/create-sso-idp-group-request-dto.d.ts +37 -0
- package/dist/models/create-sso-idp-group-request-dto.js +15 -0
- package/dist/models/create-sso-idp-group-response-class.d.ts +25 -0
- package/dist/models/create-sso-idp-group-response-class.js +15 -0
- package/dist/models/custom-field-dto.d.ts +8 -4
- package/dist/models/dbconfig-dto.d.ts +0 -6
- package/dist/models/delete-by-code-response-class.d.ts +24 -0
- package/dist/models/delete-by-code-response-class.js +15 -0
- package/dist/models/get-sso-connection-response-class.d.ts +25 -0
- package/dist/models/get-sso-connection-response-class.js +15 -0
- package/dist/models/get-sso-connection-setup-response-class.d.ts +25 -0
- package/dist/models/get-sso-connection-setup-response-class.js +15 -0
- package/dist/models/get-sso-idp-group-response-class.d.ts +25 -0
- package/dist/models/get-sso-idp-group-response-class.js +15 -0
- package/dist/models/index.d.ts +30 -1
- package/dist/models/index.js +30 -1
- package/dist/models/invite-class.d.ts +6 -0
- package/dist/models/list-sso-idp-groups-response-class.d.ts +43 -0
- package/dist/models/list-sso-idp-groups-response-class.js +15 -0
- package/dist/models/oidc-sso-details-input-dto.d.ts +36 -0
- package/dist/models/oidc-sso-details-input-dto.js +15 -0
- package/dist/models/oidc-sso-details-update-dto.d.ts +36 -0
- package/dist/models/oidc-sso-details-update-dto.js +15 -0
- package/dist/models/oidc-sso-setup-class.d.ts +31 -0
- package/dist/models/oidc-sso-setup-class.js +15 -0
- package/dist/models/org-invitation-class.d.ts +6 -0
- package/dist/models/{delete-tenant-request-dto.d.ts → saml-sso-details-dto.d.ts} +5 -11
- package/dist/models/saml-sso-details-dto.js +15 -0
- package/dist/models/saml-sso-setup-class.d.ts +37 -0
- package/dist/models/saml-sso-setup-class.js +15 -0
- package/dist/models/shared-oidc-sso-details-class.d.ts +36 -0
- package/dist/models/shared-oidc-sso-details-class.js +15 -0
- package/dist/models/shared-saml-sso-details-class.d.ts +24 -0
- package/dist/models/shared-saml-sso-details-class.js +15 -0
- package/dist/models/shared-sso-attribute-mapping-class.d.ts +30 -0
- package/dist/models/shared-sso-attribute-mapping-class.js +15 -0
- package/dist/models/sso-attribute-mapping-dto.d.ts +30 -0
- package/dist/models/sso-attribute-mapping-dto.js +15 -0
- package/dist/models/sso-attribute-mapping-template-class.d.ts +36 -0
- package/dist/models/sso-attribute-mapping-template-class.js +15 -0
- package/dist/models/sso-connection-class.d.ts +103 -0
- package/dist/models/sso-connection-class.js +24 -0
- package/dist/models/sso-connection-setup-class.d.ts +32 -0
- package/dist/models/sso-connection-setup-class.js +15 -0
- package/dist/models/sso-idp-group-class.d.ts +73 -0
- package/dist/models/sso-idp-group-class.js +15 -0
- package/dist/models/update-sso-connection-body-dto.d.ts +45 -0
- package/dist/models/update-sso-connection-body-dto.js +15 -0
- package/dist/models/update-sso-connection-response-class.d.ts +25 -0
- package/dist/models/update-sso-connection-response-class.js +15 -0
- package/dist/models/update-sso-connection-status-body-dto.d.ts +24 -0
- package/dist/models/update-sso-connection-status-body-dto.js +15 -0
- package/dist/models/update-sso-connection-status-response-class.d.ts +25 -0
- package/dist/models/update-sso-connection-status-response-class.js +15 -0
- package/dist/models/update-sso-idp-group-body-dto.d.ts +31 -0
- package/dist/models/update-sso-idp-group-body-dto.js +15 -0
- package/dist/models/update-sso-idp-group-response-class.d.ts +25 -0
- package/dist/models/update-sso-idp-group-response-class.js +15 -0
- package/dist/models/update-sso-idp-group-status-body-dto.d.ts +24 -0
- package/dist/models/update-sso-idp-group-status-body-dto.js +15 -0
- package/dist/models/update-sso-idp-group-status-response-class.d.ts +25 -0
- package/dist/models/update-sso-idp-group-status-response-class.js +15 -0
- package/dist/models/user-class.d.ts +7 -0
- package/models/admin-initial-tenant-config-dto.ts +2 -2
- package/models/create-sso-connection-request-dto.ts +77 -0
- package/models/create-sso-connection-response-class.ts +31 -0
- package/models/create-sso-idp-group-request-dto.ts +43 -0
- package/models/create-sso-idp-group-response-class.ts +31 -0
- package/models/custom-field-dto.ts +4 -4
- package/models/dbconfig-dto.ts +0 -6
- package/models/delete-by-code-response-class.ts +30 -0
- package/models/get-sso-connection-response-class.ts +31 -0
- package/models/get-sso-connection-setup-response-class.ts +31 -0
- package/models/get-sso-idp-group-response-class.ts +31 -0
- package/models/index.ts +30 -1
- package/models/invite-class.ts +6 -0
- package/models/list-sso-idp-groups-response-class.ts +49 -0
- package/models/oidc-sso-details-input-dto.ts +42 -0
- package/models/oidc-sso-details-update-dto.ts +42 -0
- package/models/oidc-sso-setup-class.ts +37 -0
- package/models/org-invitation-class.ts +6 -0
- package/models/{delete-tenant-request-dto.ts → saml-sso-details-dto.ts} +5 -11
- package/models/saml-sso-setup-class.ts +43 -0
- package/models/shared-oidc-sso-details-class.ts +42 -0
- package/models/shared-saml-sso-details-class.ts +30 -0
- package/models/shared-sso-attribute-mapping-class.ts +36 -0
- package/models/sso-attribute-mapping-dto.ts +36 -0
- package/models/sso-attribute-mapping-template-class.ts +42 -0
- package/models/sso-connection-class.ts +113 -0
- package/models/sso-connection-setup-class.ts +38 -0
- package/models/sso-idp-group-class.ts +79 -0
- package/models/update-sso-connection-body-dto.ts +51 -0
- package/models/update-sso-connection-response-class.ts +31 -0
- package/models/update-sso-connection-status-body-dto.ts +30 -0
- package/models/update-sso-connection-status-response-class.ts +31 -0
- package/models/update-sso-idp-group-body-dto.ts +37 -0
- package/models/update-sso-idp-group-response-class.ts +31 -0
- package/models/update-sso-idp-group-status-body-dto.ts +30 -0
- package/models/update-sso-idp-group-status-response-class.ts +31 -0
- package/models/user-class.ts +7 -0
- package/package.json +1 -1
- /package/dist/models/{delete-tenant-request-dto.js → create-sso-connection-response-class.js} +0 -0
|
@@ -0,0 +1,434 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL Tenant Service
|
|
3
|
+
* The EMIL TenantService 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 { CreateSsoConnectionRequestDto } from '../models';
|
|
16
|
+
import { CreateSsoConnectionResponseClass } from '../models';
|
|
17
|
+
import { DeleteResponseClass } from '../models';
|
|
18
|
+
import { GetSsoConnectionResponseClass } from '../models';
|
|
19
|
+
import { GetSsoConnectionSetupResponseClass } from '../models';
|
|
20
|
+
import { UpdateSsoConnectionBodyDto } from '../models';
|
|
21
|
+
import { UpdateSsoConnectionResponseClass } from '../models';
|
|
22
|
+
import { UpdateSsoConnectionStatusBodyDto } from '../models';
|
|
23
|
+
import { UpdateSsoConnectionStatusResponseClass } from '../models';
|
|
24
|
+
/**
|
|
25
|
+
* SSOConnectionApi - axios parameter creator
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export declare const SSOConnectionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
|
+
/**
|
|
30
|
+
* Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant. **Required Permissions** \"identity-management.sso.create\"
|
|
31
|
+
* @summary Create the tenant\'s SSO connection
|
|
32
|
+
* @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto
|
|
33
|
+
* @param {string} [authorization] Bearer Token
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
createSsoConnection: (createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
* Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them. **Required Permissions** \"identity-management.sso.delete\"
|
|
40
|
+
* @summary Delete the tenant\'s SSO connection
|
|
41
|
+
* @param {string} code Connection code.
|
|
42
|
+
* @param {string} [authorization] Bearer Token
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
deleteSsoConnection: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
/**
|
|
48
|
+
* Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one. **Required Permissions** \"identity-management.sso.view\"
|
|
49
|
+
* @summary Read the tenant\'s current SSO connection
|
|
50
|
+
* @param {string} [authorization] Bearer Token
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getCurrentSsoConnection: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* Returns the SSO Connection entity identified by code **Required Permissions** \"identity-management.sso.view\"
|
|
57
|
+
* @summary Read the tenant\'s SSO connection
|
|
58
|
+
* @param {string} code Connection code.
|
|
59
|
+
* @param {string} [authorization] Bearer Token
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
getSsoConnection: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns what the creation form with required data. **Required Permissions** \"identity-management.sso.view\"
|
|
66
|
+
* @summary Read the values an SSO connection is created with
|
|
67
|
+
* @param {string} [authorization] Bearer Token
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
getSsoConnectionSetup: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
+
/**
|
|
73
|
+
* Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection. **Required Permissions** \"identity-management.sso.update\"
|
|
74
|
+
* @summary Edit the tenant\'s SSO connection
|
|
75
|
+
* @param {string} code Connection code.
|
|
76
|
+
* @param {UpdateSsoConnectionBodyDto} updateSsoConnectionBodyDto
|
|
77
|
+
* @param {string} [authorization] Bearer Token
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
updateSsoConnection: (code: string, updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
|
+
/**
|
|
83
|
+
* Activates and deactivates SSO connection status. **Required Permissions** \"identity-management.sso.update\"
|
|
84
|
+
* @summary Switch the tenant\'s SSO connection on or off
|
|
85
|
+
* @param {string} code Connection code.
|
|
86
|
+
* @param {UpdateSsoConnectionStatusBodyDto} updateSsoConnectionStatusBodyDto
|
|
87
|
+
* @param {string} [authorization] Bearer Token
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
updateSsoConnectionStatus: (code: string, updateSsoConnectionStatusBodyDto: UpdateSsoConnectionStatusBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* SSOConnectionApi - functional programming interface
|
|
95
|
+
* @export
|
|
96
|
+
*/
|
|
97
|
+
export declare const SSOConnectionApiFp: (configuration?: Configuration) => {
|
|
98
|
+
/**
|
|
99
|
+
* Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant. **Required Permissions** \"identity-management.sso.create\"
|
|
100
|
+
* @summary Create the tenant\'s SSO connection
|
|
101
|
+
* @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto
|
|
102
|
+
* @param {string} [authorization] Bearer Token
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSsoConnectionResponseClass>>;
|
|
107
|
+
/**
|
|
108
|
+
* Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them. **Required Permissions** \"identity-management.sso.delete\"
|
|
109
|
+
* @summary Delete the tenant\'s SSO connection
|
|
110
|
+
* @param {string} code Connection code.
|
|
111
|
+
* @param {string} [authorization] Bearer Token
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
*/
|
|
115
|
+
deleteSsoConnection(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
116
|
+
/**
|
|
117
|
+
* Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one. **Required Permissions** \"identity-management.sso.view\"
|
|
118
|
+
* @summary Read the tenant\'s current SSO connection
|
|
119
|
+
* @param {string} [authorization] Bearer Token
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
getCurrentSsoConnection(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoConnectionResponseClass>>;
|
|
124
|
+
/**
|
|
125
|
+
* Returns the SSO Connection entity identified by code **Required Permissions** \"identity-management.sso.view\"
|
|
126
|
+
* @summary Read the tenant\'s SSO connection
|
|
127
|
+
* @param {string} code Connection code.
|
|
128
|
+
* @param {string} [authorization] Bearer Token
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
getSsoConnection(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoConnectionResponseClass>>;
|
|
133
|
+
/**
|
|
134
|
+
* Returns what the creation form with required data. **Required Permissions** \"identity-management.sso.view\"
|
|
135
|
+
* @summary Read the values an SSO connection is created with
|
|
136
|
+
* @param {string} [authorization] Bearer Token
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
getSsoConnectionSetup(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoConnectionSetupResponseClass>>;
|
|
141
|
+
/**
|
|
142
|
+
* Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection. **Required Permissions** \"identity-management.sso.update\"
|
|
143
|
+
* @summary Edit the tenant\'s SSO connection
|
|
144
|
+
* @param {string} code Connection code.
|
|
145
|
+
* @param {UpdateSsoConnectionBodyDto} updateSsoConnectionBodyDto
|
|
146
|
+
* @param {string} [authorization] Bearer Token
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
updateSsoConnection(code: string, updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSsoConnectionResponseClass>>;
|
|
151
|
+
/**
|
|
152
|
+
* Activates and deactivates SSO connection status. **Required Permissions** \"identity-management.sso.update\"
|
|
153
|
+
* @summary Switch the tenant\'s SSO connection on or off
|
|
154
|
+
* @param {string} code Connection code.
|
|
155
|
+
* @param {UpdateSsoConnectionStatusBodyDto} updateSsoConnectionStatusBodyDto
|
|
156
|
+
* @param {string} [authorization] Bearer Token
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
updateSsoConnectionStatus(code: string, updateSsoConnectionStatusBodyDto: UpdateSsoConnectionStatusBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSsoConnectionStatusResponseClass>>;
|
|
161
|
+
};
|
|
162
|
+
/**
|
|
163
|
+
* SSOConnectionApi - factory interface
|
|
164
|
+
* @export
|
|
165
|
+
*/
|
|
166
|
+
export declare const SSOConnectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
167
|
+
/**
|
|
168
|
+
* Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant. **Required Permissions** \"identity-management.sso.create\"
|
|
169
|
+
* @summary Create the tenant\'s SSO connection
|
|
170
|
+
* @param {CreateSsoConnectionRequestDto} createSsoConnectionRequestDto
|
|
171
|
+
* @param {string} [authorization] Bearer Token
|
|
172
|
+
* @param {*} [options] Override http request option.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
*/
|
|
175
|
+
createSsoConnection(createSsoConnectionRequestDto: CreateSsoConnectionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSsoConnectionResponseClass>;
|
|
176
|
+
/**
|
|
177
|
+
* Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them. **Required Permissions** \"identity-management.sso.delete\"
|
|
178
|
+
* @summary Delete the tenant\'s SSO connection
|
|
179
|
+
* @param {string} code Connection code.
|
|
180
|
+
* @param {string} [authorization] Bearer Token
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
deleteSsoConnection(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
185
|
+
/**
|
|
186
|
+
* Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one. **Required Permissions** \"identity-management.sso.view\"
|
|
187
|
+
* @summary Read the tenant\'s current SSO connection
|
|
188
|
+
* @param {string} [authorization] Bearer Token
|
|
189
|
+
* @param {*} [options] Override http request option.
|
|
190
|
+
* @throws {RequiredError}
|
|
191
|
+
*/
|
|
192
|
+
getCurrentSsoConnection(authorization?: string, options?: any): AxiosPromise<GetSsoConnectionResponseClass>;
|
|
193
|
+
/**
|
|
194
|
+
* Returns the SSO Connection entity identified by code **Required Permissions** \"identity-management.sso.view\"
|
|
195
|
+
* @summary Read the tenant\'s SSO connection
|
|
196
|
+
* @param {string} code Connection code.
|
|
197
|
+
* @param {string} [authorization] Bearer Token
|
|
198
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
*/
|
|
201
|
+
getSsoConnection(code: string, authorization?: string, options?: any): AxiosPromise<GetSsoConnectionResponseClass>;
|
|
202
|
+
/**
|
|
203
|
+
* Returns what the creation form with required data. **Required Permissions** \"identity-management.sso.view\"
|
|
204
|
+
* @summary Read the values an SSO connection is created with
|
|
205
|
+
* @param {string} [authorization] Bearer Token
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
getSsoConnectionSetup(authorization?: string, options?: any): AxiosPromise<GetSsoConnectionSetupResponseClass>;
|
|
210
|
+
/**
|
|
211
|
+
* Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection. **Required Permissions** \"identity-management.sso.update\"
|
|
212
|
+
* @summary Edit the tenant\'s SSO connection
|
|
213
|
+
* @param {string} code Connection code.
|
|
214
|
+
* @param {UpdateSsoConnectionBodyDto} updateSsoConnectionBodyDto
|
|
215
|
+
* @param {string} [authorization] Bearer Token
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
*/
|
|
219
|
+
updateSsoConnection(code: string, updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto, authorization?: string, options?: any): AxiosPromise<UpdateSsoConnectionResponseClass>;
|
|
220
|
+
/**
|
|
221
|
+
* Activates and deactivates SSO connection status. **Required Permissions** \"identity-management.sso.update\"
|
|
222
|
+
* @summary Switch the tenant\'s SSO connection on or off
|
|
223
|
+
* @param {string} code Connection code.
|
|
224
|
+
* @param {UpdateSsoConnectionStatusBodyDto} updateSsoConnectionStatusBodyDto
|
|
225
|
+
* @param {string} [authorization] Bearer Token
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
updateSsoConnectionStatus(code: string, updateSsoConnectionStatusBodyDto: UpdateSsoConnectionStatusBodyDto, authorization?: string, options?: any): AxiosPromise<UpdateSsoConnectionStatusResponseClass>;
|
|
230
|
+
};
|
|
231
|
+
/**
|
|
232
|
+
* Request parameters for createSsoConnection operation in SSOConnectionApi.
|
|
233
|
+
* @export
|
|
234
|
+
* @interface SSOConnectionApiCreateSsoConnectionRequest
|
|
235
|
+
*/
|
|
236
|
+
export interface SSOConnectionApiCreateSsoConnectionRequest {
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @type {CreateSsoConnectionRequestDto}
|
|
240
|
+
* @memberof SSOConnectionApiCreateSsoConnection
|
|
241
|
+
*/
|
|
242
|
+
readonly createSsoConnectionRequestDto: CreateSsoConnectionRequestDto;
|
|
243
|
+
/**
|
|
244
|
+
* Bearer Token
|
|
245
|
+
* @type {string}
|
|
246
|
+
* @memberof SSOConnectionApiCreateSsoConnection
|
|
247
|
+
*/
|
|
248
|
+
readonly authorization?: string;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* Request parameters for deleteSsoConnection operation in SSOConnectionApi.
|
|
252
|
+
* @export
|
|
253
|
+
* @interface SSOConnectionApiDeleteSsoConnectionRequest
|
|
254
|
+
*/
|
|
255
|
+
export interface SSOConnectionApiDeleteSsoConnectionRequest {
|
|
256
|
+
/**
|
|
257
|
+
* Connection code.
|
|
258
|
+
* @type {string}
|
|
259
|
+
* @memberof SSOConnectionApiDeleteSsoConnection
|
|
260
|
+
*/
|
|
261
|
+
readonly code: string;
|
|
262
|
+
/**
|
|
263
|
+
* Bearer Token
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof SSOConnectionApiDeleteSsoConnection
|
|
266
|
+
*/
|
|
267
|
+
readonly authorization?: string;
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Request parameters for getCurrentSsoConnection operation in SSOConnectionApi.
|
|
271
|
+
* @export
|
|
272
|
+
* @interface SSOConnectionApiGetCurrentSsoConnectionRequest
|
|
273
|
+
*/
|
|
274
|
+
export interface SSOConnectionApiGetCurrentSsoConnectionRequest {
|
|
275
|
+
/**
|
|
276
|
+
* Bearer Token
|
|
277
|
+
* @type {string}
|
|
278
|
+
* @memberof SSOConnectionApiGetCurrentSsoConnection
|
|
279
|
+
*/
|
|
280
|
+
readonly authorization?: string;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* Request parameters for getSsoConnection operation in SSOConnectionApi.
|
|
284
|
+
* @export
|
|
285
|
+
* @interface SSOConnectionApiGetSsoConnectionRequest
|
|
286
|
+
*/
|
|
287
|
+
export interface SSOConnectionApiGetSsoConnectionRequest {
|
|
288
|
+
/**
|
|
289
|
+
* Connection code.
|
|
290
|
+
* @type {string}
|
|
291
|
+
* @memberof SSOConnectionApiGetSsoConnection
|
|
292
|
+
*/
|
|
293
|
+
readonly code: string;
|
|
294
|
+
/**
|
|
295
|
+
* Bearer Token
|
|
296
|
+
* @type {string}
|
|
297
|
+
* @memberof SSOConnectionApiGetSsoConnection
|
|
298
|
+
*/
|
|
299
|
+
readonly authorization?: string;
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* Request parameters for getSsoConnectionSetup operation in SSOConnectionApi.
|
|
303
|
+
* @export
|
|
304
|
+
* @interface SSOConnectionApiGetSsoConnectionSetupRequest
|
|
305
|
+
*/
|
|
306
|
+
export interface SSOConnectionApiGetSsoConnectionSetupRequest {
|
|
307
|
+
/**
|
|
308
|
+
* Bearer Token
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof SSOConnectionApiGetSsoConnectionSetup
|
|
311
|
+
*/
|
|
312
|
+
readonly authorization?: string;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Request parameters for updateSsoConnection operation in SSOConnectionApi.
|
|
316
|
+
* @export
|
|
317
|
+
* @interface SSOConnectionApiUpdateSsoConnectionRequest
|
|
318
|
+
*/
|
|
319
|
+
export interface SSOConnectionApiUpdateSsoConnectionRequest {
|
|
320
|
+
/**
|
|
321
|
+
* Connection code.
|
|
322
|
+
* @type {string}
|
|
323
|
+
* @memberof SSOConnectionApiUpdateSsoConnection
|
|
324
|
+
*/
|
|
325
|
+
readonly code: string;
|
|
326
|
+
/**
|
|
327
|
+
*
|
|
328
|
+
* @type {UpdateSsoConnectionBodyDto}
|
|
329
|
+
* @memberof SSOConnectionApiUpdateSsoConnection
|
|
330
|
+
*/
|
|
331
|
+
readonly updateSsoConnectionBodyDto: UpdateSsoConnectionBodyDto;
|
|
332
|
+
/**
|
|
333
|
+
* Bearer Token
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof SSOConnectionApiUpdateSsoConnection
|
|
336
|
+
*/
|
|
337
|
+
readonly authorization?: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Request parameters for updateSsoConnectionStatus operation in SSOConnectionApi.
|
|
341
|
+
* @export
|
|
342
|
+
* @interface SSOConnectionApiUpdateSsoConnectionStatusRequest
|
|
343
|
+
*/
|
|
344
|
+
export interface SSOConnectionApiUpdateSsoConnectionStatusRequest {
|
|
345
|
+
/**
|
|
346
|
+
* Connection code.
|
|
347
|
+
* @type {string}
|
|
348
|
+
* @memberof SSOConnectionApiUpdateSsoConnectionStatus
|
|
349
|
+
*/
|
|
350
|
+
readonly code: string;
|
|
351
|
+
/**
|
|
352
|
+
*
|
|
353
|
+
* @type {UpdateSsoConnectionStatusBodyDto}
|
|
354
|
+
* @memberof SSOConnectionApiUpdateSsoConnectionStatus
|
|
355
|
+
*/
|
|
356
|
+
readonly updateSsoConnectionStatusBodyDto: UpdateSsoConnectionStatusBodyDto;
|
|
357
|
+
/**
|
|
358
|
+
* Bearer Token
|
|
359
|
+
* @type {string}
|
|
360
|
+
* @memberof SSOConnectionApiUpdateSsoConnectionStatus
|
|
361
|
+
*/
|
|
362
|
+
readonly authorization?: string;
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* SSOConnectionApi - object-oriented interface
|
|
366
|
+
* @export
|
|
367
|
+
* @class SSOConnectionApi
|
|
368
|
+
* @extends {BaseAPI}
|
|
369
|
+
*/
|
|
370
|
+
export declare class SSOConnectionApi extends BaseAPI {
|
|
371
|
+
/**
|
|
372
|
+
* Validates the identity provider data, stores the configuration, and prepares the tenant\'s Cognito user pool for the mapped claims. The connection is created inactive: activating it is a separate action. One connection per tenant. **Required Permissions** \"identity-management.sso.create\"
|
|
373
|
+
* @summary Create the tenant\'s SSO connection
|
|
374
|
+
* @param {SSOConnectionApiCreateSsoConnectionRequest} requestParameters Request parameters.
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
* @memberof SSOConnectionApi
|
|
378
|
+
*/
|
|
379
|
+
createSsoConnection(requestParameters: SSOConnectionApiCreateSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSsoConnectionResponseClass, any, {}>>;
|
|
380
|
+
/**
|
|
381
|
+
* Removes the configuration, so the tenant can be configured again from scratch. Only an inactive connection can be deleted, so deactivate it first: deleting a live one would lock every SSO user out of the tenant. Custom attributes an attribute mapping provisioned stay on the user pool permanently, because Cognito cannot remove them. **Required Permissions** \"identity-management.sso.delete\"
|
|
382
|
+
* @summary Delete the tenant\'s SSO connection
|
|
383
|
+
* @param {SSOConnectionApiDeleteSsoConnectionRequest} requestParameters Request parameters.
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
* @memberof SSOConnectionApi
|
|
387
|
+
*/
|
|
388
|
+
deleteSsoConnection(requestParameters: SSOConnectionApiDeleteSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
|
|
389
|
+
/**
|
|
390
|
+
* Returns the SSO connection of the calling tenant. A tenant has at most one connection, so no code has to be known up front. Responds with a not found when the tenant has never configured one. **Required Permissions** \"identity-management.sso.view\"
|
|
391
|
+
* @summary Read the tenant\'s current SSO connection
|
|
392
|
+
* @param {SSOConnectionApiGetCurrentSsoConnectionRequest} requestParameters Request parameters.
|
|
393
|
+
* @param {*} [options] Override http request option.
|
|
394
|
+
* @throws {RequiredError}
|
|
395
|
+
* @memberof SSOConnectionApi
|
|
396
|
+
*/
|
|
397
|
+
getCurrentSsoConnection(requestParameters?: SSOConnectionApiGetCurrentSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSsoConnectionResponseClass, any, {}>>;
|
|
398
|
+
/**
|
|
399
|
+
* Returns the SSO Connection entity identified by code **Required Permissions** \"identity-management.sso.view\"
|
|
400
|
+
* @summary Read the tenant\'s SSO connection
|
|
401
|
+
* @param {SSOConnectionApiGetSsoConnectionRequest} requestParameters Request parameters.
|
|
402
|
+
* @param {*} [options] Override http request option.
|
|
403
|
+
* @throws {RequiredError}
|
|
404
|
+
* @memberof SSOConnectionApi
|
|
405
|
+
*/
|
|
406
|
+
getSsoConnection(requestParameters: SSOConnectionApiGetSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSsoConnectionResponseClass, any, {}>>;
|
|
407
|
+
/**
|
|
408
|
+
* Returns what the creation form with required data. **Required Permissions** \"identity-management.sso.view\"
|
|
409
|
+
* @summary Read the values an SSO connection is created with
|
|
410
|
+
* @param {SSOConnectionApiGetSsoConnectionSetupRequest} requestParameters Request parameters.
|
|
411
|
+
* @param {*} [options] Override http request option.
|
|
412
|
+
* @throws {RequiredError}
|
|
413
|
+
* @memberof SSOConnectionApi
|
|
414
|
+
*/
|
|
415
|
+
getSsoConnectionSetup(requestParameters?: SSOConnectionApiGetSsoConnectionSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSsoConnectionSetupResponseClass, any, {}>>;
|
|
416
|
+
/**
|
|
417
|
+
* Replaces the display name, identity provider details and the claim mapping. The protocol and the provider are fixed for the lifetime of a connection. Editing is only allowed while the connection is inactive, so deactivate it first. Leaving the OIDC client secret out keeps the stored one, and an edit never activates the connection. **Required Permissions** \"identity-management.sso.update\"
|
|
418
|
+
* @summary Edit the tenant\'s SSO connection
|
|
419
|
+
* @param {SSOConnectionApiUpdateSsoConnectionRequest} requestParameters Request parameters.
|
|
420
|
+
* @param {*} [options] Override http request option.
|
|
421
|
+
* @throws {RequiredError}
|
|
422
|
+
* @memberof SSOConnectionApi
|
|
423
|
+
*/
|
|
424
|
+
updateSsoConnection(requestParameters: SSOConnectionApiUpdateSsoConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateSsoConnectionResponseClass, any, {}>>;
|
|
425
|
+
/**
|
|
426
|
+
* Activates and deactivates SSO connection status. **Required Permissions** \"identity-management.sso.update\"
|
|
427
|
+
* @summary Switch the tenant\'s SSO connection on or off
|
|
428
|
+
* @param {SSOConnectionApiUpdateSsoConnectionStatusRequest} requestParameters Request parameters.
|
|
429
|
+
* @param {*} [options] Override http request option.
|
|
430
|
+
* @throws {RequiredError}
|
|
431
|
+
* @memberof SSOConnectionApi
|
|
432
|
+
*/
|
|
433
|
+
updateSsoConnectionStatus(requestParameters: SSOConnectionApiUpdateSsoConnectionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateSsoConnectionStatusResponseClass, any, {}>>;
|
|
434
|
+
}
|