auth0 4.0.0-beta.2 → 4.0.0-beta.3
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/dist/cjs/management/__generated/managers/attack-protection-manager.js +7 -7
- package/dist/cjs/management/__generated/managers/attack-protection-manager.js.map +1 -1
- package/dist/cjs/management/__generated/managers/client-grants-manager.js +1 -1
- package/dist/cjs/management/__generated/managers/clients-manager.js +6 -12
- package/dist/cjs/management/__generated/managers/clients-manager.js.map +1 -1
- package/dist/cjs/management/__generated/managers/grants-manager.js +14 -14
- package/dist/cjs/management/__generated/managers/grants-manager.js.map +1 -1
- package/dist/cjs/management/__generated/managers/resource-servers-manager.js +2 -2
- package/dist/cjs/management/__generated/managers/users-manager.js +16 -3
- package/dist/cjs/management/__generated/managers/users-manager.js.map +1 -1
- package/dist/cjs/management/__generated/models/index.js +12 -4
- package/dist/cjs/management/__generated/models/index.js.map +1 -1
- package/dist/esm/management/__generated/managers/attack-protection-manager.js +7 -7
- package/dist/esm/management/__generated/managers/attack-protection-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/client-grants-manager.js +1 -1
- package/dist/esm/management/__generated/managers/clients-manager.js +6 -12
- package/dist/esm/management/__generated/managers/clients-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/grants-manager.js +14 -14
- package/dist/esm/management/__generated/managers/grants-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/resource-servers-manager.js +2 -2
- package/dist/esm/management/__generated/managers/users-manager.js +16 -3
- package/dist/esm/management/__generated/managers/users-manager.js.map +1 -1
- package/dist/esm/management/__generated/models/index.js +8 -0
- package/dist/esm/management/__generated/models/index.js.map +1 -1
- package/dist/types/management/__generated/managers/attack-protection-manager.d.ts +21 -7
- package/dist/types/management/__generated/managers/client-grants-manager.d.ts +1 -1
- package/dist/types/management/__generated/managers/clients-manager.d.ts +6 -12
- package/dist/types/management/__generated/managers/grants-manager.d.ts +5 -5
- package/dist/types/management/__generated/managers/resource-servers-manager.d.ts +2 -2
- package/dist/types/management/__generated/managers/users-manager.d.ts +14 -4
- package/dist/types/management/__generated/models/index.d.ts +123 -46
- package/package.json +1 -1
|
@@ -17,12 +17,10 @@ export declare class ClientsManager extends BaseAPI {
|
|
|
17
17
|
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude
|
|
18
18
|
* may also be specified. Note:
|
|
19
19
|
* <ul>
|
|
20
|
-
* <li>
|
|
21
|
-
* <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
20
|
+
* <li><code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
22
21
|
* any scope.
|
|
23
22
|
* </li>
|
|
24
|
-
* <li>
|
|
25
|
-
* <code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
23
|
+
* <li><code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
26
24
|
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
27
25
|
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
28
26
|
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
@@ -38,8 +36,7 @@ export declare class ClientsManager extends BaseAPI {
|
|
|
38
36
|
* <code>organization_require_behavior</code> properties can only be retrieved with the <code>read:clients</code> or
|
|
39
37
|
* <code>read:client_keys</code> scope.
|
|
40
38
|
* </li>
|
|
41
|
-
* <li>
|
|
42
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
39
|
+
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
43
40
|
* <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
|
|
44
41
|
* <code>read:client_keys</code> scope.
|
|
45
42
|
* </li>
|
|
@@ -53,12 +50,10 @@ export declare class ClientsManager extends BaseAPI {
|
|
|
53
50
|
/**
|
|
54
51
|
* Retrieve client details. A list of fields to include or exclude may also be specified. Note:
|
|
55
52
|
* <ul>
|
|
56
|
-
* <li>
|
|
57
|
-
* <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
53
|
+
* <li><code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
58
54
|
* the any of the scopes.
|
|
59
55
|
* </li>
|
|
60
|
-
* <li>
|
|
61
|
-
* <code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
56
|
+
* <li><code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
62
57
|
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
63
58
|
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
64
59
|
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
@@ -74,8 +69,7 @@ export declare class ClientsManager extends BaseAPI {
|
|
|
74
69
|
* <code>organization_require_behavior</code> properties can only be retrieved with the <code>read:clients</code> or
|
|
75
70
|
* <code>read:client_keys</code> scope.
|
|
76
71
|
* </li>
|
|
77
|
-
* <li>
|
|
78
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
72
|
+
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
79
73
|
* <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
|
|
80
74
|
* <code>read:client_keys</code> scope.
|
|
81
75
|
* </li>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as runtime from '../../../lib/runtime.js';
|
|
2
2
|
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
-
import type { GetGrants200ResponseOneOf, UserGrant,
|
|
3
|
+
import type { GetGrants200ResponseOneOf, UserGrant, DeleteGrantsByIdRequest, DeleteGrantsByUserIdRequest, GetGrantsRequest } from '../models/index.js';
|
|
4
4
|
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
5
|
/**
|
|
6
6
|
*
|
|
@@ -8,18 +8,18 @@ declare const BaseAPI: typeof runtime.BaseAPI;
|
|
|
8
8
|
export declare class GrantsManager extends BaseAPI {
|
|
9
9
|
/**
|
|
10
10
|
* Delete a grant associated with your account.
|
|
11
|
-
* Delete a grant by
|
|
11
|
+
* Delete a grant by id
|
|
12
12
|
*
|
|
13
13
|
* @throws {RequiredError}
|
|
14
14
|
*/
|
|
15
|
-
|
|
15
|
+
delete(requestParameters: DeleteGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
16
|
/**
|
|
17
17
|
* Delete a grant associated with your account.
|
|
18
|
-
* Delete a grant by
|
|
18
|
+
* Delete a grant by user_id
|
|
19
19
|
*
|
|
20
20
|
* @throws {RequiredError}
|
|
21
21
|
*/
|
|
22
|
-
|
|
22
|
+
deleteByUserId(requestParameters?: DeleteGrantsByUserIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
23
23
|
/**
|
|
24
24
|
* Retrieve the <a href="https://auth0.com/docs/api-auth/which-oauth-flow-to-use">grants</a> associated with your account.
|
|
25
25
|
* Get grants
|
|
@@ -36,13 +36,13 @@ export declare class ResourceServersManager extends BaseAPI {
|
|
|
36
36
|
*
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
|
-
update(requestParameters: PatchResourceServersByIdRequest, bodyParameters: ResourceServerUpdate, initOverrides?: InitOverride): Promise<ApiResponse<
|
|
39
|
+
update(requestParameters: PatchResourceServersByIdRequest, bodyParameters: ResourceServerUpdate, initOverrides?: InitOverride): Promise<ApiResponse<ResourceServer>>;
|
|
40
40
|
/**
|
|
41
41
|
* Create a new API (also known as a resource server).
|
|
42
42
|
* Create a resource server
|
|
43
43
|
*
|
|
44
44
|
* @throws {RequiredError}
|
|
45
45
|
*/
|
|
46
|
-
create(bodyParameters: PostResourceServersRequest, initOverrides?: InitOverride): Promise<ApiResponse<
|
|
46
|
+
create(bodyParameters: PostResourceServersRequest, initOverrides?: InitOverride): Promise<ApiResponse<ResourceServer>>;
|
|
47
47
|
}
|
|
48
48
|
export {};
|
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
import * as runtime from '../../../lib/runtime.js';
|
|
2
2
|
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
-
import type { DeletePermissionsRequest, DeleteUserIdentityByUserId200ResponseInner, DeleteUserRolesRequest, GetAuthenticationMethods200ResponseOneOfAuthenticatorsInner, GetUsers200ResponseOneOfInner, PatchAuthenticationMethodsByAuthenticationMethodIdRequest, PostAuthenticationMethods201Response, PostAuthenticationMethodsRequest, PostIdentitiesRequest, PostPermissionsRequest, PostRecoveryCodeRegeneration200Response, PostUserRolesRequest, PutAuthenticationMethodsRequestInner, UserCreate, UserEnrollment, UserIdentity, UserUpdate, GetAuthenticationMethods200ResponseOneOf, GetAuthenticationMethods200ResponseOneOfInner, GetLogs200ResponseOneOf, Log, GetPermissions200ResponseOneOf, GetPermissions200ResponseOneOfInner, GetOrganizations200ResponseOneOf, GetOrganizations200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetUsers200ResponseOneOf, DeleteAuthenticationMethodsByAuthenticationMethodIdRequest, DeleteAuthenticatorsRequest, DeleteMultifactorByProviderRequest, DeletePermissionsOperationRequest, DeleteUserIdentityByUserIdRequest, DeleteUserRolesOperationRequest, DeleteUsersByIdRequest, GetAuthenticationMethodsRequest, GetAuthenticationMethodsByAuthenticationMethodIdRequest, GetEnrollmentsRequest, GetLogsByUserRequest, GetPermissionsRequest, GetUserOrganizationsRequest, GetUserRolesRequest, GetUsersRequest, GetUsersByIdRequest, PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, PatchUsersByIdRequest, PostAuthenticationMethodsOperationRequest, PostIdentitiesOperationRequest, PostInvalidateRememberBrowserRequest, PostPermissionsOperationRequest, PostRecoveryCodeRegenerationRequest, PostUserRolesOperationRequest, PutAuthenticationMethodsRequest } from '../models/index.js';
|
|
3
|
+
import type { DeletePermissionsRequest, DeleteUserIdentityByUserId200ResponseInner, DeleteUserRolesRequest, GetAuthenticationMethods200ResponseOneOfAuthenticatorsInner, GetUsers200ResponseOneOfInner, PatchAuthenticationMethodsByAuthenticationMethodIdRequest, PostAuthenticationMethods201Response, PostAuthenticationMethodsRequest, PostIdentitiesRequest, PostPermissionsRequest, PostRecoveryCodeRegeneration200Response, PostUserRolesRequest, PutAuthenticationMethodsRequestInner, UserCreate, UserEnrollment, UserIdentity, UserUpdate, GetAuthenticationMethods200ResponseOneOf, GetAuthenticationMethods200ResponseOneOfInner, GetLogs200ResponseOneOf, Log, GetPermissions200ResponseOneOf, GetPermissions200ResponseOneOfInner, GetOrganizations200ResponseOneOf, GetOrganizations200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetUsers200ResponseOneOf, DeleteAuthenticationMethodsRequest, DeleteAuthenticationMethodsByAuthenticationMethodIdRequest, DeleteAuthenticatorsRequest, DeleteMultifactorByProviderRequest, DeletePermissionsOperationRequest, DeleteUserIdentityByUserIdRequest, DeleteUserRolesOperationRequest, DeleteUsersByIdRequest, GetAuthenticationMethodsRequest, GetAuthenticationMethodsByAuthenticationMethodIdRequest, GetEnrollmentsRequest, GetLogsByUserRequest, GetPermissionsRequest, GetUserOrganizationsRequest, GetUserRolesRequest, GetUsersRequest, GetUsersByIdRequest, PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, PatchUsersByIdRequest, PostAuthenticationMethodsOperationRequest, PostIdentitiesOperationRequest, PostInvalidateRememberBrowserRequest, PostPermissionsOperationRequest, PostRecoveryCodeRegenerationRequest, PostUserRolesOperationRequest, PutAuthenticationMethodsRequest } from '../models/index.js';
|
|
4
4
|
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
5
|
/**
|
|
6
6
|
*
|
|
7
7
|
*/
|
|
8
8
|
export declare class UsersManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Deletes all authentication methods for the given user
|
|
11
|
+
*
|
|
12
|
+
* @throws {RequiredError}
|
|
13
|
+
*/
|
|
14
|
+
deleteAuthenticationMethods(requestParameters: DeleteAuthenticationMethodsRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
9
15
|
/**
|
|
10
16
|
* Deletes an authentication method by ID
|
|
11
17
|
*
|
|
@@ -159,7 +165,9 @@ export declare class UsersManager extends BaseAPI {
|
|
|
159
165
|
*
|
|
160
166
|
* @throws {RequiredError}
|
|
161
167
|
*/
|
|
162
|
-
updateAuthenticationMethod(requestParameters: PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, bodyParameters: PatchAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<
|
|
168
|
+
updateAuthenticationMethod(requestParameters: PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, bodyParameters: PatchAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
|
|
169
|
+
[key: string]: any;
|
|
170
|
+
}>>;
|
|
163
171
|
/**
|
|
164
172
|
* Update a user.
|
|
165
173
|
*
|
|
@@ -237,7 +245,7 @@ export declare class UsersManager extends BaseAPI {
|
|
|
237
245
|
*/
|
|
238
246
|
update(requestParameters: PatchUsersByIdRequest, bodyParameters: UserUpdate, initOverrides?: InitOverride): Promise<ApiResponse<GetUsers200ResponseOneOfInner>>;
|
|
239
247
|
/**
|
|
240
|
-
* Creates an authentication method for a given user.
|
|
248
|
+
* Creates an authentication method for a given user. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.
|
|
241
249
|
*
|
|
242
250
|
* @throws {RequiredError}
|
|
243
251
|
*/
|
|
@@ -318,6 +326,8 @@ export declare class UsersManager extends BaseAPI {
|
|
|
318
326
|
*
|
|
319
327
|
* @throws {RequiredError}
|
|
320
328
|
*/
|
|
321
|
-
updateAuthenticationMethods(requestParameters: PutAuthenticationMethodsRequest, bodyParameters: Array<PutAuthenticationMethodsRequestInner>, initOverrides?: InitOverride): Promise<ApiResponse<
|
|
329
|
+
updateAuthenticationMethods(requestParameters: PutAuthenticationMethodsRequest, bodyParameters: Array<PutAuthenticationMethodsRequestInner>, initOverrides?: InitOverride): Promise<ApiResponse<Array<{
|
|
330
|
+
[key: string]: any;
|
|
331
|
+
}>>>;
|
|
322
332
|
}
|
|
323
333
|
export {};
|
|
@@ -112,6 +112,11 @@ export interface Client {
|
|
|
112
112
|
*
|
|
113
113
|
*/
|
|
114
114
|
sso_disabled?: boolean;
|
|
115
|
+
/**
|
|
116
|
+
* Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
|
|
117
|
+
*
|
|
118
|
+
*/
|
|
119
|
+
cross_origin_authentication?: boolean;
|
|
115
120
|
/**
|
|
116
121
|
* URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.
|
|
117
122
|
*
|
|
@@ -146,7 +151,7 @@ export interface Client {
|
|
|
146
151
|
*/
|
|
147
152
|
token_endpoint_auth_method?: ClientTokenEndpointAuthMethodEnum;
|
|
148
153
|
/**
|
|
149
|
-
* Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()
|
|
154
|
+
* Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space]
|
|
150
155
|
*
|
|
151
156
|
*/
|
|
152
157
|
client_metadata?: {
|
|
@@ -891,7 +896,7 @@ export interface ClientCreate {
|
|
|
891
896
|
* Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
|
|
892
897
|
*
|
|
893
898
|
*/
|
|
894
|
-
|
|
899
|
+
cross_origin_authentication?: boolean;
|
|
895
900
|
/**
|
|
896
901
|
* URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.
|
|
897
902
|
*
|
|
@@ -926,7 +931,7 @@ export interface ClientCreate {
|
|
|
926
931
|
*/
|
|
927
932
|
addons?: ClientAddons;
|
|
928
933
|
/**
|
|
929
|
-
* Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()
|
|
934
|
+
* Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space]
|
|
930
935
|
*
|
|
931
936
|
*/
|
|
932
937
|
client_metadata?: {
|
|
@@ -1421,6 +1426,11 @@ export interface ClientUpdate {
|
|
|
1421
1426
|
*
|
|
1422
1427
|
*/
|
|
1423
1428
|
sso?: boolean;
|
|
1429
|
+
/**
|
|
1430
|
+
* <code>true</code> if this client can be used to make cross-origin authentication requests, <code>false</code> otherwise if cross origin is disabled
|
|
1431
|
+
*
|
|
1432
|
+
*/
|
|
1433
|
+
cross_origin_authentication?: boolean;
|
|
1424
1434
|
/**
|
|
1425
1435
|
* URL for the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.
|
|
1426
1436
|
*
|
|
@@ -1473,7 +1483,7 @@ export interface ClientUpdate {
|
|
|
1473
1483
|
*/
|
|
1474
1484
|
addons?: ClientUpdateAddons | null;
|
|
1475
1485
|
/**
|
|
1476
|
-
* Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()
|
|
1486
|
+
* Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space]
|
|
1477
1487
|
*
|
|
1478
1488
|
*/
|
|
1479
1489
|
client_metadata?: {
|
|
@@ -2497,7 +2507,7 @@ export interface DraftUpdate {
|
|
|
2497
2507
|
*/
|
|
2498
2508
|
export interface EmailProvider {
|
|
2499
2509
|
/**
|
|
2500
|
-
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, or `
|
|
2510
|
+
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
|
|
2501
2511
|
*
|
|
2502
2512
|
*/
|
|
2503
2513
|
name?: string;
|
|
@@ -3064,11 +3074,13 @@ export interface GetActions200ResponseActionsInnerDependenciesInner {
|
|
|
3064
3074
|
registry_url?: string;
|
|
3065
3075
|
}
|
|
3066
3076
|
/**
|
|
3067
|
-
* Integration defines a self contained functioning unit which partners
|
|
3077
|
+
* Integration defines a self contained functioning unit which partners
|
|
3078
|
+
* publish. A partner may create one or many of these integrations.
|
|
3068
3079
|
*/
|
|
3069
3080
|
export interface GetActions200ResponseActionsInnerIntegration {
|
|
3070
3081
|
/**
|
|
3071
|
-
* id is a system generated GUID. This same ID is designed to be federated in
|
|
3082
|
+
* id is a system generated GUID. This same ID is designed to be federated in
|
|
3083
|
+
* all the applicable localities.
|
|
3072
3084
|
*
|
|
3073
3085
|
*/
|
|
3074
3086
|
id?: string;
|
|
@@ -3083,17 +3095,23 @@ export interface GetActions200ResponseActionsInnerIntegration {
|
|
|
3083
3095
|
*/
|
|
3084
3096
|
url_slug?: string;
|
|
3085
3097
|
/**
|
|
3086
|
-
* partner_id is the foreign key reference to the partner account this
|
|
3098
|
+
* partner_id is the foreign key reference to the partner account this
|
|
3099
|
+
* integration belongs to.
|
|
3087
3100
|
*
|
|
3088
3101
|
*/
|
|
3089
3102
|
partner_id?: string;
|
|
3090
3103
|
/**
|
|
3091
|
-
* name is the integration name, which will be used for display purposes in
|
|
3104
|
+
* name is the integration name, which will be used for display purposes in
|
|
3105
|
+
* the marketplace.
|
|
3106
|
+
*
|
|
3107
|
+
* To start we're going to make sure the display name is at least 3
|
|
3108
|
+
* characters. Can adjust this easily later.
|
|
3092
3109
|
*
|
|
3093
3110
|
*/
|
|
3094
3111
|
name?: string;
|
|
3095
3112
|
/**
|
|
3096
|
-
* description adds more text for the integration name -- also relevant for
|
|
3113
|
+
* description adds more text for the integration name -- also relevant for
|
|
3114
|
+
* the marketplace listing.
|
|
3097
3115
|
*
|
|
3098
3116
|
*/
|
|
3099
3117
|
description?: string;
|
|
@@ -3154,7 +3172,8 @@ export interface GetActions200ResponseActionsInnerIntegrationCurrentRelease {
|
|
|
3154
3172
|
*/
|
|
3155
3173
|
semver?: GetActions200ResponseActionsInnerIntegrationCurrentReleaseSemver;
|
|
3156
3174
|
/**
|
|
3157
|
-
* required_secrets declares all the necessary secrets for an integration to
|
|
3175
|
+
* required_secrets declares all the necessary secrets for an integration to
|
|
3176
|
+
* work.
|
|
3158
3177
|
*
|
|
3159
3178
|
*/
|
|
3160
3179
|
required_secrets?: Array<GetActions200ResponseActionsInnerIntegrationCurrentReleaseRequiredSecretsInner>;
|
|
@@ -3165,7 +3184,12 @@ export interface GetActions200ResponseActionsInnerIntegrationCurrentRelease {
|
|
|
3165
3184
|
required_configuration?: Array<GetActions200ResponseActionsInnerIntegrationCurrentReleaseRequiredSecretsInner>;
|
|
3166
3185
|
}
|
|
3167
3186
|
/**
|
|
3168
|
-
* Param are form input values, primarily utilized when specifying secrets and
|
|
3187
|
+
* Param are form input values, primarily utilized when specifying secrets and
|
|
3188
|
+
* configuration values for actions.
|
|
3189
|
+
*
|
|
3190
|
+
* These are especially important for partner integrations -- but can be
|
|
3191
|
+
* exposed to tenant admins as well if they want to parameterize their custom
|
|
3192
|
+
* actions.
|
|
3169
3193
|
*/
|
|
3170
3194
|
export interface GetActions200ResponseActionsInnerIntegrationCurrentReleaseRequiredSecretsInner {
|
|
3171
3195
|
/**
|
|
@@ -3410,7 +3434,7 @@ export interface GetAuthenticationMethods200ResponseOneOfAuthenticatorsInner {
|
|
|
3410
3434
|
* The authentication method preferred for phone authenticators.
|
|
3411
3435
|
*
|
|
3412
3436
|
*/
|
|
3413
|
-
preferred_authentication_method?:
|
|
3437
|
+
preferred_authentication_method?: GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerPreferredAuthenticationMethodEnum;
|
|
3414
3438
|
/**
|
|
3415
3439
|
* The ID of a linked authentication method. Linked authentication methods will be deleted together.
|
|
3416
3440
|
*
|
|
@@ -3464,6 +3488,11 @@ export declare const GetAuthenticationMethods200ResponseOneOfAuthenticatorsInner
|
|
|
3464
3488
|
readonly guardian: "guardian";
|
|
3465
3489
|
};
|
|
3466
3490
|
export type GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerTypeEnum = (typeof GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerTypeEnum)[keyof typeof GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerTypeEnum];
|
|
3491
|
+
export declare const GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerPreferredAuthenticationMethodEnum: {
|
|
3492
|
+
readonly sms: "sms";
|
|
3493
|
+
readonly voice: "voice";
|
|
3494
|
+
};
|
|
3495
|
+
export type GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerPreferredAuthenticationMethodEnum = (typeof GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerPreferredAuthenticationMethodEnum)[keyof typeof GetAuthenticationMethods200ResponseOneOfAuthenticatorsInnerPreferredAuthenticationMethodEnum];
|
|
3467
3496
|
/**
|
|
3468
3497
|
*
|
|
3469
3498
|
*/
|
|
@@ -3666,7 +3695,17 @@ export interface GetBranding200ResponseColors {
|
|
|
3666
3695
|
page_background?: GetBranding200ResponseColorsPageBackground;
|
|
3667
3696
|
}
|
|
3668
3697
|
/**
|
|
3669
|
-
* Page Background Color or Gradient
|
|
3698
|
+
* Page Background Color or Gradient.
|
|
3699
|
+
* Property contains either <code>null</code> to unset, a solid color as a string value <code>#FFFFFF</code>, or a gradient as an object.
|
|
3700
|
+
*
|
|
3701
|
+
* <code>
|
|
3702
|
+
* {
|
|
3703
|
+
* type: 'linear-gradient',
|
|
3704
|
+
* start: '#FFFFFF',
|
|
3705
|
+
* end: '#000000',
|
|
3706
|
+
* angle_deg: 35
|
|
3707
|
+
* }
|
|
3708
|
+
* </code>
|
|
3670
3709
|
*/
|
|
3671
3710
|
export type GetBranding200ResponseColorsPageBackground = string | {
|
|
3672
3711
|
[key: string]: any;
|
|
@@ -5868,21 +5907,6 @@ export interface PatchAuthenticationMethodsByAuthenticationMethodIdRequest {
|
|
|
5868
5907
|
*
|
|
5869
5908
|
*/
|
|
5870
5909
|
name?: string;
|
|
5871
|
-
/**
|
|
5872
|
-
* Base32 encoded secret for TOTP generation.
|
|
5873
|
-
*
|
|
5874
|
-
*/
|
|
5875
|
-
totp_secret?: string;
|
|
5876
|
-
/**
|
|
5877
|
-
* Applies to email authentication methods only. The email address used to send verification messages.
|
|
5878
|
-
*
|
|
5879
|
-
*/
|
|
5880
|
-
email?: string;
|
|
5881
|
-
/**
|
|
5882
|
-
* Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.
|
|
5883
|
-
*
|
|
5884
|
-
*/
|
|
5885
|
-
phone_number?: string;
|
|
5886
5910
|
/**
|
|
5887
5911
|
* Preferred phone authentication method
|
|
5888
5912
|
*
|
|
@@ -6009,17 +6033,20 @@ export interface PatchBreachedPasswordDetectionRequest {
|
|
|
6009
6033
|
*/
|
|
6010
6034
|
enabled?: boolean;
|
|
6011
6035
|
/**
|
|
6012
|
-
* Action to take when a breached password is detected during a login
|
|
6036
|
+
* Action to take when a breached password is detected during a login.
|
|
6037
|
+
* Possible values: <code>block</code>, <code>user_notification</code>, <code>admin_notification</code>.
|
|
6013
6038
|
*
|
|
6014
6039
|
*/
|
|
6015
6040
|
shields?: Array<PatchBreachedPasswordDetectionRequestShieldsEnum>;
|
|
6016
6041
|
/**
|
|
6017
|
-
* When "admin_notification" is enabled, determines how often email notifications are sent
|
|
6042
|
+
* When "admin_notification" is enabled, determines how often email notifications are sent.
|
|
6043
|
+
* Possible values: <code>immediately</code>, <code>daily</code>, <code>weekly</code>, <code>monthly</code>.
|
|
6018
6044
|
*
|
|
6019
6045
|
*/
|
|
6020
6046
|
admin_notification_frequency?: Array<PatchBreachedPasswordDetectionRequestAdminNotificationFrequencyEnum>;
|
|
6021
6047
|
/**
|
|
6022
|
-
* The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard
|
|
6048
|
+
* The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard.
|
|
6049
|
+
* Possible values: <code>standard</code>, <code>enhanced</code>.
|
|
6023
6050
|
*
|
|
6024
6051
|
*/
|
|
6025
6052
|
method?: PatchBreachedPasswordDetectionRequestMethodEnum;
|
|
@@ -6058,7 +6085,8 @@ export interface PatchBreachedPasswordDetectionRequestStage {
|
|
|
6058
6085
|
*/
|
|
6059
6086
|
export interface PatchBreachedPasswordDetectionRequestStagePreUserRegistration {
|
|
6060
6087
|
/**
|
|
6061
|
-
* Action to take when a breached password is detected during a signup
|
|
6088
|
+
* Action to take when a breached password is detected during a signup.
|
|
6089
|
+
* Possible values: <code>block</code>, <code>admin_notification</code>.
|
|
6062
6090
|
*
|
|
6063
6091
|
*/
|
|
6064
6092
|
shields?: Array<PatchBreachedPasswordDetectionRequestStagePreUserRegistrationShieldsEnum>;
|
|
@@ -6078,7 +6106,8 @@ export interface PatchBruteForceProtectionRequest {
|
|
|
6078
6106
|
*/
|
|
6079
6107
|
enabled?: boolean;
|
|
6080
6108
|
/**
|
|
6081
|
-
* Action to take when a brute force protection threshold is violated
|
|
6109
|
+
* Action to take when a brute force protection threshold is violated.
|
|
6110
|
+
* Possible values: <code>block</code>, <code>user_notification</code>.
|
|
6082
6111
|
*
|
|
6083
6112
|
*/
|
|
6084
6113
|
shields?: Array<PatchBruteForceProtectionRequestShieldsEnum>;
|
|
@@ -6088,7 +6117,8 @@ export interface PatchBruteForceProtectionRequest {
|
|
|
6088
6117
|
*/
|
|
6089
6118
|
allowlist?: Array<PatchBruteForceProtectionRequestAllowlistInner>;
|
|
6090
6119
|
/**
|
|
6091
|
-
* Account Lockout: Determines whether or not IP address is used when counting failed attempts
|
|
6120
|
+
* Account Lockout: Determines whether or not IP address is used when counting failed attempts.
|
|
6121
|
+
* Possible values: <code>count_per_identifier_and_ip</code>, <code>count_per_identifier</code>.
|
|
6092
6122
|
*
|
|
6093
6123
|
*/
|
|
6094
6124
|
mode?: PatchBruteForceProtectionRequestModeEnum;
|
|
@@ -6266,7 +6296,7 @@ export interface PatchOrganizationsByIdRequestBranding {
|
|
|
6266
6296
|
*/
|
|
6267
6297
|
export interface PatchProviderRequest {
|
|
6268
6298
|
/**
|
|
6269
|
-
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, or `
|
|
6299
|
+
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
|
|
6270
6300
|
*
|
|
6271
6301
|
*/
|
|
6272
6302
|
name?: PatchProviderRequestNameEnum;
|
|
@@ -6298,6 +6328,8 @@ export declare const PatchProviderRequestNameEnum: {
|
|
|
6298
6328
|
readonly ses: "ses";
|
|
6299
6329
|
readonly sparkpost: "sparkpost";
|
|
6300
6330
|
readonly smtp: "smtp";
|
|
6331
|
+
readonly azure_cs: "azure_cs";
|
|
6332
|
+
readonly ms365: "ms365";
|
|
6301
6333
|
};
|
|
6302
6334
|
export type PatchProviderRequestNameEnum = (typeof PatchProviderRequestNameEnum)[keyof typeof PatchProviderRequestNameEnum];
|
|
6303
6335
|
/**
|
|
@@ -6310,7 +6342,8 @@ export interface PatchSuspiciousIpThrottlingRequest {
|
|
|
6310
6342
|
*/
|
|
6311
6343
|
enabled?: boolean;
|
|
6312
6344
|
/**
|
|
6313
|
-
* Action to take when a suspicious IP throttling threshold is violated
|
|
6345
|
+
* Action to take when a suspicious IP throttling threshold is violated.
|
|
6346
|
+
* Possible values: <code>block</code>, <code>admin_notification</code>.
|
|
6314
6347
|
*
|
|
6315
6348
|
*/
|
|
6316
6349
|
shields?: Array<PatchSuspiciousIpThrottlingRequestShieldsEnum>;
|
|
@@ -7914,7 +7947,7 @@ export interface PostPermissionsRequest {
|
|
|
7914
7947
|
*/
|
|
7915
7948
|
export interface PostProviderRequest {
|
|
7916
7949
|
/**
|
|
7917
|
-
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, or `
|
|
7950
|
+
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
|
|
7918
7951
|
*
|
|
7919
7952
|
*/
|
|
7920
7953
|
name: PostProviderRequestNameEnum;
|
|
@@ -7946,6 +7979,8 @@ export declare const PostProviderRequestNameEnum: {
|
|
|
7946
7979
|
readonly ses: "ses";
|
|
7947
7980
|
readonly sparkpost: "sparkpost";
|
|
7948
7981
|
readonly smtp: "smtp";
|
|
7982
|
+
readonly azure_cs: "azure_cs";
|
|
7983
|
+
readonly ms365: "ms365";
|
|
7949
7984
|
};
|
|
7950
7985
|
export type PostProviderRequestNameEnum = (typeof PostProviderRequestNameEnum)[keyof typeof PostProviderRequestNameEnum];
|
|
7951
7986
|
/**
|
|
@@ -9062,6 +9097,9 @@ export interface TenantSettings {
|
|
|
9062
9097
|
/**
|
|
9063
9098
|
*/
|
|
9064
9099
|
session_cookie?: TenantSettingsSessionCookie | null;
|
|
9100
|
+
/**
|
|
9101
|
+
*/
|
|
9102
|
+
sessions?: TenantSettingsSessions | null;
|
|
9065
9103
|
}
|
|
9066
9104
|
export declare const TenantSettingsEnabledLocalesEnum: {
|
|
9067
9105
|
readonly ar: "ar";
|
|
@@ -9273,6 +9311,11 @@ export interface TenantSettingsFlags {
|
|
|
9273
9311
|
*
|
|
9274
9312
|
*/
|
|
9275
9313
|
disable_fields_map_fix?: boolean;
|
|
9314
|
+
/**
|
|
9315
|
+
* Used to allow users to pick what factor to enroll of the available MFA factors.
|
|
9316
|
+
*
|
|
9317
|
+
*/
|
|
9318
|
+
mfa_show_factor_list_on_enrollment?: boolean;
|
|
9276
9319
|
}
|
|
9277
9320
|
/**
|
|
9278
9321
|
* Guardian page customization.
|
|
@@ -9304,6 +9347,16 @@ export declare const TenantSettingsSessionCookieModeEnum: {
|
|
|
9304
9347
|
readonly non_persistent: "non-persistent";
|
|
9305
9348
|
};
|
|
9306
9349
|
export type TenantSettingsSessionCookieModeEnum = (typeof TenantSettingsSessionCookieModeEnum)[keyof typeof TenantSettingsSessionCookieModeEnum];
|
|
9350
|
+
/**
|
|
9351
|
+
* Sessions related settings for tenant
|
|
9352
|
+
*/
|
|
9353
|
+
export interface TenantSettingsSessions {
|
|
9354
|
+
/**
|
|
9355
|
+
* Whether to bypass prompting logic (false) when performing OIDC Logout
|
|
9356
|
+
*
|
|
9357
|
+
*/
|
|
9358
|
+
oidc_logout_prompt_enabled?: boolean;
|
|
9359
|
+
}
|
|
9307
9360
|
/**
|
|
9308
9361
|
*
|
|
9309
9362
|
*/
|
|
@@ -9386,6 +9439,9 @@ export interface TenantSettingsUpdate {
|
|
|
9386
9439
|
/**
|
|
9387
9440
|
*/
|
|
9388
9441
|
session_cookie?: TenantSettingsSessionCookie | null;
|
|
9442
|
+
/**
|
|
9443
|
+
*/
|
|
9444
|
+
sessions?: TenantSettingsSessions | null;
|
|
9389
9445
|
}
|
|
9390
9446
|
export declare const TenantSettingsUpdateEnabledLocalesEnum: {
|
|
9391
9447
|
readonly ar: "ar";
|
|
@@ -9572,6 +9628,11 @@ export interface TenantSettingsUpdateFlags {
|
|
|
9572
9628
|
*
|
|
9573
9629
|
*/
|
|
9574
9630
|
disable_fields_map_fix?: boolean;
|
|
9631
|
+
/**
|
|
9632
|
+
* Used to allow users to pick what factor to enroll of the available MFA factors.
|
|
9633
|
+
*
|
|
9634
|
+
*/
|
|
9635
|
+
mfa_show_factor_list_on_enrollment?: boolean;
|
|
9575
9636
|
}
|
|
9576
9637
|
export declare const TenantSettingsUpdateFlagsChangePwdFlowV1Enum: {
|
|
9577
9638
|
readonly false: false;
|
|
@@ -10879,22 +10940,22 @@ export interface GetProviderRequest {
|
|
|
10879
10940
|
/**
|
|
10880
10941
|
*
|
|
10881
10942
|
*/
|
|
10882
|
-
export interface
|
|
10943
|
+
export interface DeleteGrantsByIdRequest {
|
|
10883
10944
|
/**
|
|
10884
|
-
*
|
|
10945
|
+
* ID of the grant to delete.
|
|
10885
10946
|
*
|
|
10886
10947
|
*/
|
|
10887
|
-
|
|
10948
|
+
id: string;
|
|
10888
10949
|
}
|
|
10889
10950
|
/**
|
|
10890
10951
|
*
|
|
10891
10952
|
*/
|
|
10892
|
-
export interface
|
|
10953
|
+
export interface DeleteGrantsByUserIdRequest {
|
|
10893
10954
|
/**
|
|
10894
|
-
*
|
|
10955
|
+
* user_id of the grant to delete.
|
|
10895
10956
|
*
|
|
10896
10957
|
*/
|
|
10897
|
-
|
|
10958
|
+
user_id?: string;
|
|
10898
10959
|
}
|
|
10899
10960
|
/**
|
|
10900
10961
|
*
|
|
@@ -12168,7 +12229,10 @@ export interface GetUserBlocksRequest {
|
|
|
12168
12229
|
*/
|
|
12169
12230
|
identifier: string;
|
|
12170
12231
|
/**
|
|
12171
|
-
*
|
|
12232
|
+
*
|
|
12233
|
+
* If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.
|
|
12234
|
+
* If true and Brute Force Protection is disabled, will return an empty list.
|
|
12235
|
+
*
|
|
12172
12236
|
*
|
|
12173
12237
|
*/
|
|
12174
12238
|
consider_brute_force_enablement?: boolean;
|
|
@@ -12183,11 +12247,24 @@ export interface GetUserBlocksByIdRequest {
|
|
|
12183
12247
|
*/
|
|
12184
12248
|
id: string;
|
|
12185
12249
|
/**
|
|
12186
|
-
*
|
|
12250
|
+
*
|
|
12251
|
+
* If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.
|
|
12252
|
+
* If true and Brute Force Protection is disabled, will return an empty list.
|
|
12253
|
+
*
|
|
12187
12254
|
*
|
|
12188
12255
|
*/
|
|
12189
12256
|
consider_brute_force_enablement?: boolean;
|
|
12190
12257
|
}
|
|
12258
|
+
/**
|
|
12259
|
+
*
|
|
12260
|
+
*/
|
|
12261
|
+
export interface DeleteAuthenticationMethodsRequest {
|
|
12262
|
+
/**
|
|
12263
|
+
* The ID of the user in question.
|
|
12264
|
+
*
|
|
12265
|
+
*/
|
|
12266
|
+
id: string;
|
|
12267
|
+
}
|
|
12191
12268
|
/**
|
|
12192
12269
|
*
|
|
12193
12270
|
*/
|