auth0 7.4.0 → 7.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/management/Client.d.ts +3 -0
- package/dist/cjs/management/Client.js +87 -82
- package/dist/cjs/management/api/requests/requests.d.ts +103 -0
- package/dist/cjs/management/api/resources/attackProtection/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/attackProtection/client/Client.js +9 -4
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.d.ts +105 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.js +388 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/index.js +2 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/exports.js +21 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/index.js +17 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +27 -0
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +101 -0
- package/dist/cjs/management/api/resources/clientProfiles/client/Client.d.ts +106 -0
- package/dist/cjs/management/api/resources/clientProfiles/client/Client.js +391 -0
- package/dist/cjs/management/api/resources/clientProfiles/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/clientProfiles/client/index.js +2 -0
- package/dist/cjs/management/api/resources/clientProfiles/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/clientProfiles/exports.js +21 -0
- package/dist/cjs/management/api/resources/clientProfiles/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/clientProfiles/index.js +17 -0
- package/dist/cjs/management/api/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/index.js +2 -1
- package/dist/cjs/management/api/types/types.d.ts +352 -0
- package/dist/cjs/management/api/types/types.js +83 -21
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/Client.d.mts +3 -0
- package/dist/esm/management/Client.mjs +5 -0
- package/dist/esm/management/api/requests/requests.d.mts +103 -0
- package/dist/esm/management/api/resources/attackProtection/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/attackProtection/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.d.mts +105 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.mjs +351 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/exports.mjs +3 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/index.mjs +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +27 -0
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +101 -0
- package/dist/esm/management/api/resources/clientProfiles/client/Client.d.mts +106 -0
- package/dist/esm/management/api/resources/clientProfiles/client/Client.mjs +354 -0
- package/dist/esm/management/api/resources/clientProfiles/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/clientProfiles/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/clientProfiles/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/clientProfiles/exports.mjs +3 -0
- package/dist/esm/management/api/resources/clientProfiles/index.d.mts +1 -0
- package/dist/esm/management/api/resources/clientProfiles/index.mjs +1 -0
- package/dist/esm/management/api/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/index.mjs +1 -0
- package/dist/esm/management/api/types/types.d.mts +352 -0
- package/dist/esm/management/api/types/types.mjs +62 -0
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +23 -1
- package/reference.md +981 -217
|
@@ -732,6 +732,18 @@ export declare const OauthScope: {
|
|
|
732
732
|
/**
|
|
733
733
|
* Delete Vdcs Templates */
|
|
734
734
|
readonly DeleteVdcsTemplates: "delete:vdcs_templates";
|
|
735
|
+
/**
|
|
736
|
+
* Create Client Profiles */
|
|
737
|
+
readonly CreateClientProfiles: "create:client_profiles";
|
|
738
|
+
/**
|
|
739
|
+
* Read Client Profiles */
|
|
740
|
+
readonly ReadClientProfiles: "read:client_profiles";
|
|
741
|
+
/**
|
|
742
|
+
* Update Client Profiles */
|
|
743
|
+
readonly UpdateClientProfiles: "update:client_profiles";
|
|
744
|
+
/**
|
|
745
|
+
* Delete Client Profiles */
|
|
746
|
+
readonly DeleteClientProfiles: "delete:client_profiles";
|
|
735
747
|
/**
|
|
736
748
|
* Create Organization Client Associations */
|
|
737
749
|
readonly CreateOrganizationClients: "create:organization_clients";
|
|
@@ -1433,6 +1445,60 @@ export interface AttackProtectionCaptchaHcaptchaResponseContent {
|
|
|
1433
1445
|
/** Accepts any additional properties */
|
|
1434
1446
|
[key: string]: any;
|
|
1435
1447
|
}
|
|
1448
|
+
/**
|
|
1449
|
+
* An attack protection policy override for CAPTCHA.
|
|
1450
|
+
*/
|
|
1451
|
+
export interface AttackProtectionCaptchaPolicy {
|
|
1452
|
+
/** System-generated identifier for the policy. */
|
|
1453
|
+
id: string;
|
|
1454
|
+
/** Human-readable policy name. */
|
|
1455
|
+
name: string;
|
|
1456
|
+
/** Description of the policy's purpose. */
|
|
1457
|
+
description?: string | undefined;
|
|
1458
|
+
/** Conflict resolution order. Lower number takes higher precedence. */
|
|
1459
|
+
priority: number;
|
|
1460
|
+
match: Management.AttackProtectionCaptchaPolicyMatch;
|
|
1461
|
+
action: Management.AttackProtectionCaptchaPolicyAction;
|
|
1462
|
+
/** ISO 8601 timestamp when the policy was created. */
|
|
1463
|
+
created_at: string;
|
|
1464
|
+
/** ISO 8601 timestamp when the policy was last updated. */
|
|
1465
|
+
updated_at: string;
|
|
1466
|
+
}
|
|
1467
|
+
/**
|
|
1468
|
+
* CAPTCHA configuration override stored for this policy.
|
|
1469
|
+
*/
|
|
1470
|
+
export interface AttackProtectionCaptchaPolicyAction {
|
|
1471
|
+
active_provider_id?: Management.CaptchaActiveProviderEnum | undefined;
|
|
1472
|
+
simple_captcha?: Management.CaptchaPolicyActionSimpleCaptcha | undefined;
|
|
1473
|
+
auth_challenge?: Management.CaptchaPolicyActionAuthChallenge | undefined;
|
|
1474
|
+
recaptcha_v2?: Management.CaptchaPolicyActionRecaptchaV2 | undefined;
|
|
1475
|
+
recaptcha_enterprise?: Management.CaptchaPolicyActionRecaptchaEnterprise | undefined;
|
|
1476
|
+
hcaptcha?: Management.CaptchaPolicyActionHcaptcha | undefined;
|
|
1477
|
+
friendly_captcha?: Management.CaptchaPolicyActionFriendlyCaptcha | undefined;
|
|
1478
|
+
arkose?: Management.CaptchaPolicyActionArkose | undefined;
|
|
1479
|
+
}
|
|
1480
|
+
/**
|
|
1481
|
+
* CAPTCHA configuration override for this policy.
|
|
1482
|
+
*/
|
|
1483
|
+
export interface AttackProtectionCaptchaPolicyActionInput {
|
|
1484
|
+
active_provider_id?: Management.CaptchaActiveProviderEnum | undefined;
|
|
1485
|
+
simple_captcha?: Management.CaptchaPolicyActionSimpleCaptcha | undefined;
|
|
1486
|
+
auth_challenge?: Management.CaptchaPolicyActionAuthChallenge | undefined;
|
|
1487
|
+
recaptcha_v2?: Management.CaptchaPolicyActionRecaptchaV2Input | undefined;
|
|
1488
|
+
recaptcha_enterprise?: Management.CaptchaPolicyActionRecaptchaEnterpriseInput | undefined;
|
|
1489
|
+
hcaptcha?: Management.CaptchaPolicyActionHcaptchaInput | undefined;
|
|
1490
|
+
friendly_captcha?: Management.CaptchaPolicyActionFriendlyCaptchaInput | undefined;
|
|
1491
|
+
arkose?: Management.CaptchaPolicyActionArkoseInput | undefined;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* Traffic matching criteria for the policy. Exactly one of auth0_managed or geo_country_codes must be specified.
|
|
1495
|
+
*/
|
|
1496
|
+
export interface AttackProtectionCaptchaPolicyMatch {
|
|
1497
|
+
/** Match by Auth0-managed traffic identifiers. */
|
|
1498
|
+
auth0_managed?: string[] | undefined;
|
|
1499
|
+
/** Match by ISO 3166-1 alpha-2 country codes. */
|
|
1500
|
+
geo_country_codes?: string[] | undefined;
|
|
1501
|
+
}
|
|
1436
1502
|
/** The id of the active provider for the CAPTCHA. */
|
|
1437
1503
|
export declare const AttackProtectionCaptchaProviderId: {
|
|
1438
1504
|
readonly Arkose: "arkose";
|
|
@@ -1945,6 +2011,125 @@ export interface BulkUpdateAculResponseContent {
|
|
|
1945
2011
|
/** Accepts any additional properties */
|
|
1946
2012
|
[key: string]: any;
|
|
1947
2013
|
}
|
|
2014
|
+
/** The CAPTCHA provider type. */
|
|
2015
|
+
export declare const CaptchaActiveProviderEnum: {
|
|
2016
|
+
readonly SimpleCaptcha: "simple_captcha";
|
|
2017
|
+
readonly AuthChallenge: "auth_challenge";
|
|
2018
|
+
readonly RecaptchaV2: "recaptcha_v2";
|
|
2019
|
+
readonly RecaptchaEnterprise: "recaptcha_enterprise";
|
|
2020
|
+
readonly Hcaptcha: "hcaptcha";
|
|
2021
|
+
readonly FriendlyCaptcha: "friendly_captcha";
|
|
2022
|
+
readonly Arkose: "arkose";
|
|
2023
|
+
};
|
|
2024
|
+
export type CaptchaActiveProviderEnum = (typeof CaptchaActiveProviderEnum)[keyof typeof CaptchaActiveProviderEnum];
|
|
2025
|
+
/**
|
|
2026
|
+
* Arkose Labs provider configuration.
|
|
2027
|
+
*/
|
|
2028
|
+
export interface CaptchaPolicyActionArkose {
|
|
2029
|
+
/** The Arkose Labs site key. */
|
|
2030
|
+
site_key?: string | undefined;
|
|
2031
|
+
/** The Arkose Labs client subdomain. */
|
|
2032
|
+
client_subdomain?: string | undefined;
|
|
2033
|
+
/** The Arkose Labs verify subdomain. */
|
|
2034
|
+
verify_subdomain?: string | undefined;
|
|
2035
|
+
/** Whether to allow access when Arkose Labs is unavailable. */
|
|
2036
|
+
fail_open?: boolean | undefined;
|
|
2037
|
+
}
|
|
2038
|
+
/**
|
|
2039
|
+
* Arkose Labs provider configuration.
|
|
2040
|
+
*/
|
|
2041
|
+
export interface CaptchaPolicyActionArkoseInput {
|
|
2042
|
+
/** The Arkose Labs site key. */
|
|
2043
|
+
site_key?: string | undefined;
|
|
2044
|
+
/** The Arkose Labs private key. Encrypted at rest. */
|
|
2045
|
+
secret?: string | undefined;
|
|
2046
|
+
/** The Arkose Labs client subdomain. */
|
|
2047
|
+
client_subdomain?: string | undefined;
|
|
2048
|
+
/** The Arkose Labs verify subdomain. */
|
|
2049
|
+
verify_subdomain?: string | undefined;
|
|
2050
|
+
/** Whether to allow access when Arkose Labs is unavailable. */
|
|
2051
|
+
fail_open?: boolean | undefined;
|
|
2052
|
+
}
|
|
2053
|
+
/**
|
|
2054
|
+
* Auth Challenge CAPTCHA provider configuration.
|
|
2055
|
+
*/
|
|
2056
|
+
export interface CaptchaPolicyActionAuthChallenge {
|
|
2057
|
+
/** Whether to allow access when the challenge provider is unavailable. */
|
|
2058
|
+
fail_open?: boolean | undefined;
|
|
2059
|
+
}
|
|
2060
|
+
/**
|
|
2061
|
+
* Friendly Captcha provider configuration.
|
|
2062
|
+
*/
|
|
2063
|
+
export interface CaptchaPolicyActionFriendlyCaptcha {
|
|
2064
|
+
/** The Friendly Captcha site key. */
|
|
2065
|
+
site_key?: string | undefined;
|
|
2066
|
+
}
|
|
2067
|
+
/**
|
|
2068
|
+
* Friendly Captcha provider configuration.
|
|
2069
|
+
*/
|
|
2070
|
+
export interface CaptchaPolicyActionFriendlyCaptchaInput {
|
|
2071
|
+
/** The Friendly Captcha site key. */
|
|
2072
|
+
site_key?: string | undefined;
|
|
2073
|
+
/** The Friendly Captcha secret key. Encrypted at rest. */
|
|
2074
|
+
secret?: string | undefined;
|
|
2075
|
+
}
|
|
2076
|
+
/**
|
|
2077
|
+
* hCaptcha provider configuration.
|
|
2078
|
+
*/
|
|
2079
|
+
export interface CaptchaPolicyActionHcaptcha {
|
|
2080
|
+
/** The hCaptcha site key. */
|
|
2081
|
+
site_key?: string | undefined;
|
|
2082
|
+
}
|
|
2083
|
+
/**
|
|
2084
|
+
* hCaptcha provider configuration.
|
|
2085
|
+
*/
|
|
2086
|
+
export interface CaptchaPolicyActionHcaptchaInput {
|
|
2087
|
+
/** The hCaptcha site key. */
|
|
2088
|
+
site_key?: string | undefined;
|
|
2089
|
+
/** The hCaptcha secret key. Encrypted at rest. */
|
|
2090
|
+
secret?: string | undefined;
|
|
2091
|
+
}
|
|
2092
|
+
/**
|
|
2093
|
+
* reCAPTCHA Enterprise provider configuration.
|
|
2094
|
+
*/
|
|
2095
|
+
export interface CaptchaPolicyActionRecaptchaEnterprise {
|
|
2096
|
+
/** The reCAPTCHA Enterprise site key. */
|
|
2097
|
+
site_key?: string | undefined;
|
|
2098
|
+
/** The Google Cloud project ID. */
|
|
2099
|
+
project_id?: string | undefined;
|
|
2100
|
+
}
|
|
2101
|
+
/**
|
|
2102
|
+
* reCAPTCHA Enterprise provider configuration.
|
|
2103
|
+
*/
|
|
2104
|
+
export interface CaptchaPolicyActionRecaptchaEnterpriseInput {
|
|
2105
|
+
/** The reCAPTCHA Enterprise site key. */
|
|
2106
|
+
site_key?: string | undefined;
|
|
2107
|
+
/** The Google Cloud project ID. */
|
|
2108
|
+
project_id?: string | undefined;
|
|
2109
|
+
/** The reCAPTCHA Enterprise API key. Encrypted at rest. */
|
|
2110
|
+
api_key?: string | undefined;
|
|
2111
|
+
}
|
|
2112
|
+
/**
|
|
2113
|
+
* reCAPTCHA v2 provider configuration.
|
|
2114
|
+
*/
|
|
2115
|
+
export interface CaptchaPolicyActionRecaptchaV2 {
|
|
2116
|
+
/** The reCAPTCHA v2 site key. */
|
|
2117
|
+
site_key?: string | undefined;
|
|
2118
|
+
}
|
|
2119
|
+
/**
|
|
2120
|
+
* reCAPTCHA v2 provider configuration.
|
|
2121
|
+
*/
|
|
2122
|
+
export interface CaptchaPolicyActionRecaptchaV2Input {
|
|
2123
|
+
/** The reCAPTCHA v2 site key. */
|
|
2124
|
+
site_key?: string | undefined;
|
|
2125
|
+
/** The reCAPTCHA v2 secret key. Encrypted at rest. */
|
|
2126
|
+
secret?: string | undefined;
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* Simple CAPTCHA provider configuration.
|
|
2130
|
+
*/
|
|
2131
|
+
export interface CaptchaPolicyActionSimpleCaptcha {
|
|
2132
|
+
}
|
|
1948
2133
|
export interface CertificateSubjectDnCredential {
|
|
1949
2134
|
credential_type: Management.CertificateSubjectDnCredentialTypeEnum;
|
|
1950
2135
|
/** Friendly name for a credential. */
|
|
@@ -1974,6 +2159,12 @@ export interface ChangePasswordTicketResponseContent {
|
|
|
1974
2159
|
/** Accepts any additional properties */
|
|
1975
2160
|
[key: string]: any;
|
|
1976
2161
|
}
|
|
2162
|
+
/** Indicates who created the client. The value <code>admin</code> indicates the client was registered via the Management API. The value <code>client</code> indicates the client was registered dynamically. */
|
|
2163
|
+
export declare const CimdExternalMetadataCreatedByEnum: {
|
|
2164
|
+
readonly Admin: "admin";
|
|
2165
|
+
readonly Client: "client";
|
|
2166
|
+
};
|
|
2167
|
+
export type CimdExternalMetadataCreatedByEnum = (typeof CimdExternalMetadataCreatedByEnum)[keyof typeof CimdExternalMetadataCreatedByEnum];
|
|
1977
2168
|
/**
|
|
1978
2169
|
* Client authentication methods derived from the JWKS document
|
|
1979
2170
|
*/
|
|
@@ -2146,6 +2337,7 @@ export interface Client {
|
|
|
2146
2337
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
2147
2338
|
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
2148
2339
|
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
2340
|
+
external_metadata_status?: Management.ClientExternalMetadataStatusEnum | undefined;
|
|
2149
2341
|
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
2150
2342
|
external_client_id?: string | undefined;
|
|
2151
2343
|
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
@@ -2713,6 +2905,12 @@ export declare const ClientExternalMetadataCreatedByEnum: {
|
|
|
2713
2905
|
readonly Client: "client";
|
|
2714
2906
|
};
|
|
2715
2907
|
export type ClientExternalMetadataCreatedByEnum = (typeof ClientExternalMetadataCreatedByEnum)[keyof typeof ClientExternalMetadataCreatedByEnum];
|
|
2908
|
+
/** Indicates whether the Client ID Metadata Document at <code>external_client_id</code> is currently reachable. For clients with <code>external_metadata_created_by</code> set to <code>client</code> the status is calculated from the document; for <code>admin</code> it is always <code>available</code>. When absent, the status is assumed to be <code>available</code>. */
|
|
2909
|
+
export declare const ClientExternalMetadataStatusEnum: {
|
|
2910
|
+
readonly Available: "available";
|
|
2911
|
+
readonly Unavailable: "unavailable";
|
|
2912
|
+
};
|
|
2913
|
+
export type ClientExternalMetadataStatusEnum = (typeof ClientExternalMetadataStatusEnum)[keyof typeof ClientExternalMetadataStatusEnum];
|
|
2716
2914
|
/** Indicates the type of external metadata used to register the client. This field is omitted for regular clients. The value <code>cimd</code> identifies clients registered via a Client ID Metadata Document. The value <code>dcr</code> identifies clients registered via Dynamic Client Registration. */
|
|
2717
2915
|
export declare const ClientExternalMetadataTypeEnum: {
|
|
2718
2916
|
readonly Cimd: "cimd";
|
|
@@ -2763,6 +2961,12 @@ export interface ClientGrantResponseContent {
|
|
|
2763
2961
|
/** If enabled, all scopes configured on the resource server are allowed for this grant. */
|
|
2764
2962
|
allow_all_scopes?: boolean | undefined;
|
|
2765
2963
|
}
|
|
2964
|
+
/** Field name to sort results by in ascending order. Defaults to insertion order (oldest first) if not provided. */
|
|
2965
|
+
export declare const ClientGrantSortFieldEnum: {
|
|
2966
|
+
readonly Audience: "audience";
|
|
2967
|
+
readonly UpdatedAt: "updated_at";
|
|
2968
|
+
};
|
|
2969
|
+
export type ClientGrantSortFieldEnum = (typeof ClientGrantSortFieldEnum)[keyof typeof ClientGrantSortFieldEnum];
|
|
2766
2970
|
/** The type of application access the client grant allows. */
|
|
2767
2971
|
export declare const ClientGrantSubjectTypeEnum: {
|
|
2768
2972
|
readonly Client: "client";
|
|
@@ -3021,6 +3225,126 @@ export declare const ClientOrganizationUsagePatchEnum: {
|
|
|
3021
3225
|
readonly Require: "require";
|
|
3022
3226
|
};
|
|
3023
3227
|
export type ClientOrganizationUsagePatchEnum = (typeof ClientOrganizationUsagePatchEnum)[keyof typeof ClientOrganizationUsagePatchEnum];
|
|
3228
|
+
export interface ClientProfile {
|
|
3229
|
+
id: Management.ClientProfileId;
|
|
3230
|
+
name: Management.ClientProfileName;
|
|
3231
|
+
description?: ((Management.ClientProfileDescription | undefined) | null) | undefined;
|
|
3232
|
+
client_configuration: Management.ClientProfileClientConfiguration;
|
|
3233
|
+
apply_policy: Management.ClientProfileApplyPolicy;
|
|
3234
|
+
/** Timestamp of creation. */
|
|
3235
|
+
created_at?: string | undefined;
|
|
3236
|
+
/** Timestamp of last update. */
|
|
3237
|
+
updated_at?: string | undefined;
|
|
3238
|
+
}
|
|
3239
|
+
/**
|
|
3240
|
+
* Runtime matching rules that determine which clients this profile governs.
|
|
3241
|
+
*/
|
|
3242
|
+
export interface ClientProfileApplyPolicy {
|
|
3243
|
+
external_metadata_type: Management.ClientProfileApplyPolicyExternalMetadataTypeEnum;
|
|
3244
|
+
external_metadata_created_by: Management.ClientProfileApplyPolicyExternalMetadataCreatedByEnum;
|
|
3245
|
+
}
|
|
3246
|
+
/** The external metadata client's creator to match. The value <code>client</code> indicates the client was registered dynamically. */
|
|
3247
|
+
export declare const ClientProfileApplyPolicyExternalMetadataCreatedByEnum: {
|
|
3248
|
+
readonly Client: "client";
|
|
3249
|
+
};
|
|
3250
|
+
export type ClientProfileApplyPolicyExternalMetadataCreatedByEnum = (typeof ClientProfileApplyPolicyExternalMetadataCreatedByEnum)[keyof typeof ClientProfileApplyPolicyExternalMetadataCreatedByEnum];
|
|
3251
|
+
/** The client's type of external metadata to match. The value <code>cimd</code> identifies clients registered via a Client ID Metadata Document. */
|
|
3252
|
+
export declare const ClientProfileApplyPolicyExternalMetadataTypeEnum: {
|
|
3253
|
+
readonly Cimd: "cimd";
|
|
3254
|
+
};
|
|
3255
|
+
export type ClientProfileApplyPolicyExternalMetadataTypeEnum = (typeof ClientProfileApplyPolicyExternalMetadataTypeEnum)[keyof typeof ClientProfileApplyPolicyExternalMetadataTypeEnum];
|
|
3256
|
+
/**
|
|
3257
|
+
* Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.
|
|
3258
|
+
*/
|
|
3259
|
+
export interface ClientProfileClientConfiguration {
|
|
3260
|
+
refresh_token?: Management.ClientProfileClientConfigurationRefreshToken | undefined;
|
|
3261
|
+
organization_usage?: Management.ClientProfileClientConfigurationOrganizationUsage | undefined;
|
|
3262
|
+
organization_require_behavior?: Management.ClientProfileClientConfigurationOrganizationRequireBehavior | undefined;
|
|
3263
|
+
organization_discovery_methods?: Management.ClientProfileClientConfigurationOrganizationDiscoveryMethods | undefined;
|
|
3264
|
+
require_proof_of_possession?: Management.ClientProfileClientConfigurationRequireProofOfPossession | undefined;
|
|
3265
|
+
}
|
|
3266
|
+
/** A method used to discover a user's organization. */
|
|
3267
|
+
export declare const ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum: {
|
|
3268
|
+
readonly Email: "email";
|
|
3269
|
+
readonly OrganizationName: "organization_name";
|
|
3270
|
+
};
|
|
3271
|
+
export type ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum = (typeof ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum)[keyof typeof ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum];
|
|
3272
|
+
/**
|
|
3273
|
+
* Default organization discovery methods applied to matched clients.
|
|
3274
|
+
*/
|
|
3275
|
+
export interface ClientProfileClientConfigurationOrganizationDiscoveryMethods {
|
|
3276
|
+
default_value?: Management.ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum[] | undefined;
|
|
3277
|
+
}
|
|
3278
|
+
/**
|
|
3279
|
+
* Default organization prompt behavior applied to matched clients.
|
|
3280
|
+
*/
|
|
3281
|
+
export interface ClientProfileClientConfigurationOrganizationRequireBehavior {
|
|
3282
|
+
default_value?: Management.ClientProfileClientConfigurationOrganizationRequireBehaviorEnum | undefined;
|
|
3283
|
+
}
|
|
3284
|
+
/** When an organization is required, how matched clients prompt for it. */
|
|
3285
|
+
export declare const ClientProfileClientConfigurationOrganizationRequireBehaviorEnum: {
|
|
3286
|
+
readonly NoPrompt: "no_prompt";
|
|
3287
|
+
readonly PreLoginPrompt: "pre_login_prompt";
|
|
3288
|
+
readonly PostLoginPrompt: "post_login_prompt";
|
|
3289
|
+
};
|
|
3290
|
+
export type ClientProfileClientConfigurationOrganizationRequireBehaviorEnum = (typeof ClientProfileClientConfigurationOrganizationRequireBehaviorEnum)[keyof typeof ClientProfileClientConfigurationOrganizationRequireBehaviorEnum];
|
|
3291
|
+
/**
|
|
3292
|
+
* Default organization usage applied to matched clients.
|
|
3293
|
+
*/
|
|
3294
|
+
export interface ClientProfileClientConfigurationOrganizationUsage {
|
|
3295
|
+
default_value?: Management.ClientProfileClientConfigurationOrganizationUsageEnum | undefined;
|
|
3296
|
+
}
|
|
3297
|
+
/** How matched clients handle organizations. */
|
|
3298
|
+
export declare const ClientProfileClientConfigurationOrganizationUsageEnum: {
|
|
3299
|
+
readonly Deny: "deny";
|
|
3300
|
+
readonly Allow: "allow";
|
|
3301
|
+
readonly Require: "require";
|
|
3302
|
+
};
|
|
3303
|
+
export type ClientProfileClientConfigurationOrganizationUsageEnum = (typeof ClientProfileClientConfigurationOrganizationUsageEnum)[keyof typeof ClientProfileClientConfigurationOrganizationUsageEnum];
|
|
3304
|
+
/**
|
|
3305
|
+
* Refresh token settings. Omit any sub-field to use the client's own value.
|
|
3306
|
+
*/
|
|
3307
|
+
export interface ClientProfileClientConfigurationRefreshToken {
|
|
3308
|
+
token_lifetime?: Management.ClientProfileRefreshTokenTokenLifetime | undefined;
|
|
3309
|
+
idle_token_lifetime?: Management.ClientProfileRefreshTokenIdleTokenLifetime | undefined;
|
|
3310
|
+
leeway?: Management.ClientProfileRefreshTokenLeeway | undefined;
|
|
3311
|
+
}
|
|
3312
|
+
/**
|
|
3313
|
+
* Whether matched clients default to requiring proof of possession.
|
|
3314
|
+
*/
|
|
3315
|
+
export interface ClientProfileClientConfigurationRequireProofOfPossession {
|
|
3316
|
+
default_value?: boolean | undefined;
|
|
3317
|
+
}
|
|
3318
|
+
/**
|
|
3319
|
+
* Optional description of the client profile.
|
|
3320
|
+
*/
|
|
3321
|
+
export type ClientProfileDescription = (string | null) | undefined;
|
|
3322
|
+
/**
|
|
3323
|
+
* Client Profile identifier.
|
|
3324
|
+
*/
|
|
3325
|
+
export type ClientProfileId = string;
|
|
3326
|
+
/**
|
|
3327
|
+
* Display name of the client profile.
|
|
3328
|
+
*/
|
|
3329
|
+
export type ClientProfileName = string;
|
|
3330
|
+
/**
|
|
3331
|
+
* Default idle refresh token lifetime, in seconds, applied to matched clients.
|
|
3332
|
+
*/
|
|
3333
|
+
export interface ClientProfileRefreshTokenIdleTokenLifetime {
|
|
3334
|
+
default_value?: number | undefined;
|
|
3335
|
+
}
|
|
3336
|
+
/**
|
|
3337
|
+
* Default refresh token rotation leeway, in seconds, applied to matched clients.
|
|
3338
|
+
*/
|
|
3339
|
+
export interface ClientProfileRefreshTokenLeeway {
|
|
3340
|
+
default_value?: number | undefined;
|
|
3341
|
+
}
|
|
3342
|
+
/**
|
|
3343
|
+
* Default refresh token lifetime, in seconds, applied to matched clients.
|
|
3344
|
+
*/
|
|
3345
|
+
export interface ClientProfileRefreshTokenTokenLifetime {
|
|
3346
|
+
default_value?: number | undefined;
|
|
3347
|
+
}
|
|
3024
3348
|
/** Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. `open_redirect_protection` shows an error page instead of redirecting, and hides the callback domain from email templates. `allow_always` enables standard redirect behavior. Defaults to `open_redirect_protection` for third-party clients. Only applies when `is_first_party` is `false` and `third_party_security_mode` is `strict`. To learn more, read <a href="https://auth0.com/docs/get-started/applications/third-party-applications/security-controls#redirect-protection">Redirect protection</a>. */
|
|
3025
3349
|
export declare const ClientRedirectionPolicyEnum: {
|
|
3026
3350
|
readonly AllowAlways: "allow_always";
|
|
@@ -3153,6 +3477,7 @@ export interface ClientSearchResponse {
|
|
|
3153
3477
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
3154
3478
|
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
3155
3479
|
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
3480
|
+
external_metadata_status?: Management.ClientExternalMetadataStatusEnum | undefined;
|
|
3156
3481
|
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
3157
3482
|
external_client_id?: string | undefined;
|
|
3158
3483
|
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
@@ -7703,6 +8028,7 @@ export interface CreateClientResponseContent {
|
|
|
7703
8028
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
7704
8029
|
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
7705
8030
|
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
8031
|
+
external_metadata_status?: Management.ClientExternalMetadataStatusEnum | undefined;
|
|
7706
8032
|
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
7707
8033
|
external_client_id?: string | undefined;
|
|
7708
8034
|
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
@@ -28015,6 +28341,7 @@ export interface GetClientResponseContent {
|
|
|
28015
28341
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
28016
28342
|
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
28017
28343
|
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
28344
|
+
external_metadata_status?: Management.ClientExternalMetadataStatusEnum | undefined;
|
|
28018
28345
|
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
28019
28346
|
external_client_id?: string | undefined;
|
|
28020
28347
|
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
@@ -29043,6 +29370,8 @@ export interface GetTenantSettingsResponseContent {
|
|
|
29043
29370
|
resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile | undefined;
|
|
29044
29371
|
/** Whether the authorization server supports retrieving client metadata from a client_id URL. */
|
|
29045
29372
|
client_id_metadata_document_supported?: boolean | undefined;
|
|
29373
|
+
/** Whether the authorization server supports registering clients dynamically from a client_id URL. Requires client_id_metadata_document_supported to be enabled. */
|
|
29374
|
+
client_id_metadata_document_dynamic_registration_supported?: boolean | undefined;
|
|
29046
29375
|
/** Whether Phone Consolidated Experience is enabled for this tenant. */
|
|
29047
29376
|
phone_consolidated_experience?: boolean | undefined;
|
|
29048
29377
|
/** Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant. */
|
|
@@ -29662,6 +29991,10 @@ export interface ListAgentsResponseContent {
|
|
|
29662
29991
|
/** A cursor to be used as the "from" query parameter for the next page of results. Omitted when there are no further results. */
|
|
29663
29992
|
next?: string | undefined;
|
|
29664
29993
|
}
|
|
29994
|
+
/**
|
|
29995
|
+
* List of CAPTCHA attack protection policies for the tenant, sorted by priority ascending.
|
|
29996
|
+
*/
|
|
29997
|
+
export type ListAttackProtectionCaptchaPoliciesResponseContent = Management.AttackProtectionCaptchaPolicy[];
|
|
29665
29998
|
export interface ListBrandingPhoneProvidersResponseContent {
|
|
29666
29999
|
providers?: Management.PhoneProviderSchemaMasked[] | undefined;
|
|
29667
30000
|
}
|
|
@@ -29682,6 +30015,14 @@ export interface ListClientGrantPaginatedResponseContent {
|
|
|
29682
30015
|
next?: string | undefined;
|
|
29683
30016
|
client_grants?: Management.ClientGrantResponseContent[] | undefined;
|
|
29684
30017
|
}
|
|
30018
|
+
/**
|
|
30019
|
+
* Checkpoint paginated list of client profiles.
|
|
30020
|
+
*/
|
|
30021
|
+
export interface ListClientProfilesPaginatedResponseContent {
|
|
30022
|
+
/** A cursor to be used as the "from" query parameter for the next page of results. */
|
|
30023
|
+
next?: string | undefined;
|
|
30024
|
+
client_profiles: Management.ClientProfile[];
|
|
30025
|
+
}
|
|
29685
30026
|
export interface ListClientsOffsetPaginatedResponseContent {
|
|
29686
30027
|
start?: number | undefined;
|
|
29687
30028
|
limit?: number | undefined;
|
|
@@ -31341,6 +31682,7 @@ export type PreferredAuthenticationMethodEnum = (typeof PreferredAuthenticationM
|
|
|
31341
31682
|
export interface PreviewCimdMetadataResponseContent {
|
|
31342
31683
|
/** The client_id of an existing client registered with this external_client_id, if one exists. */
|
|
31343
31684
|
client_id?: string | undefined;
|
|
31685
|
+
external_metadata_created_by?: Management.CimdExternalMetadataCreatedByEnum | undefined;
|
|
31344
31686
|
/** Array of retrieval errors (populated when the metadata document could not be fetched). When present, validation is omitted. */
|
|
31345
31687
|
errors?: string[] | undefined;
|
|
31346
31688
|
validation?: Management.CimdValidationResult | undefined;
|
|
@@ -32092,6 +32434,7 @@ export interface RotateClientSecretResponseContent {
|
|
|
32092
32434
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
32093
32435
|
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
32094
32436
|
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
32437
|
+
external_metadata_status?: Management.ClientExternalMetadataStatusEnum | undefined;
|
|
32095
32438
|
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
32096
32439
|
external_client_id?: string | undefined;
|
|
32097
32440
|
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
@@ -32296,6 +32639,12 @@ export declare const ScreenGroupNameEnum: {
|
|
|
32296
32639
|
readonly AsyncApprovalWrongUser: "async-approval-wrong-user";
|
|
32297
32640
|
};
|
|
32298
32641
|
export type ScreenGroupNameEnum = (typeof ScreenGroupNameEnum)[keyof typeof ScreenGroupNameEnum];
|
|
32642
|
+
export interface SearchClientGrantsResponseContent {
|
|
32643
|
+
/** Array of client grant objects matching the search criteria. */
|
|
32644
|
+
client_grants: Management.ClientGrantResponseContent[];
|
|
32645
|
+
/** Cursor for retrieving the next page of results. Omitted if there are no more results. */
|
|
32646
|
+
next?: string | undefined;
|
|
32647
|
+
}
|
|
32299
32648
|
export interface SearchClientsResponseContent {
|
|
32300
32649
|
/** Array of client objects matching the search criteria. */
|
|
32301
32650
|
clients: Management.ClientSearchResponse[];
|
|
@@ -33845,6 +34194,7 @@ export interface UpdateClientResponseContent {
|
|
|
33845
34194
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
33846
34195
|
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
33847
34196
|
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
34197
|
+
external_metadata_status?: Management.ClientExternalMetadataStatusEnum | undefined;
|
|
33848
34198
|
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
33849
34199
|
external_client_id?: string | undefined;
|
|
33850
34200
|
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
@@ -34893,6 +35243,8 @@ export interface UpdateTenantSettingsResponseContent {
|
|
|
34893
35243
|
resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile | undefined;
|
|
34894
35244
|
/** Whether the authorization server supports retrieving client metadata from a client_id URL. */
|
|
34895
35245
|
client_id_metadata_document_supported?: boolean | undefined;
|
|
35246
|
+
/** Whether the authorization server supports registering clients dynamically from a client_id URL. Requires client_id_metadata_document_supported to be enabled. */
|
|
35247
|
+
client_id_metadata_document_dynamic_registration_supported?: boolean | undefined;
|
|
34896
35248
|
/** Whether Phone Consolidated Experience is enabled for this tenant. */
|
|
34897
35249
|
phone_consolidated_experience?: boolean | undefined;
|
|
34898
35250
|
/** Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant. */
|