@pulumi/auth0 2.14.0-alpha.1663280530 → 2.14.0-alpha.1666810964

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.
Files changed (104) hide show
  1. package/action.d.ts +25 -72
  2. package/action.js +2 -50
  3. package/action.js.map +1 -1
  4. package/attackProtection.d.ts +9 -8
  5. package/attackProtection.js +4 -4
  6. package/attackProtection.js.map +1 -1
  7. package/branding.d.ts +31 -30
  8. package/branding.js +14 -8
  9. package/branding.js.map +1 -1
  10. package/brandingTheme.d.ts +156 -0
  11. package/brandingTheme.js +165 -0
  12. package/brandingTheme.js.map +1 -0
  13. package/client.d.ts +145 -126
  14. package/client.js +26 -22
  15. package/client.js.map +1 -1
  16. package/clientGrant.d.ts +12 -13
  17. package/clientGrant.js +3 -4
  18. package/clientGrant.js.map +1 -1
  19. package/config/vars.d.ts +22 -0
  20. package/config/vars.js +6 -0
  21. package/config/vars.js.map +1 -1
  22. package/connection.d.ts +256 -41
  23. package/connection.js +236 -4
  24. package/connection.js.map +1 -1
  25. package/customDomain.d.ts +42 -18
  26. package/customDomain.js +6 -3
  27. package/customDomain.js.map +1 -1
  28. package/customDomainVerification.d.ts +15 -9
  29. package/customDomainVerification.js +4 -4
  30. package/customDomainVerification.js.map +1 -1
  31. package/email.d.ts +37 -18
  32. package/email.js +23 -5
  33. package/email.js.map +1 -1
  34. package/emailTemplate.d.ts +29 -32
  35. package/emailTemplate.js +2 -5
  36. package/emailTemplate.js.map +1 -1
  37. package/getClient.d.ts +111 -6
  38. package/getClient.js +3 -1
  39. package/getClient.js.map +1 -1
  40. package/getGlobalClient.d.ts +98 -31
  41. package/getGlobalClient.js +3 -11
  42. package/getGlobalClient.js.map +1 -1
  43. package/getTenant.d.ts +3 -3
  44. package/getTenant.js +1 -1
  45. package/globalClient.d.ts +333 -2
  46. package/globalClient.js +7 -3
  47. package/globalClient.js.map +1 -1
  48. package/guardian.d.ts +32 -56
  49. package/guardian.js +3 -4
  50. package/guardian.js.map +1 -1
  51. package/hook.d.ts +12 -18
  52. package/hook.js +9 -10
  53. package/hook.js.map +1 -1
  54. package/index.d.ts +91 -30
  55. package/index.js +94 -101
  56. package/index.js.map +1 -1
  57. package/logStream.d.ts +34 -18
  58. package/logStream.js +17 -2
  59. package/logStream.js.map +1 -1
  60. package/organization.d.ts +22 -55
  61. package/organization.js +8 -17
  62. package/organization.js.map +1 -1
  63. package/organizationConnection.d.ts +7 -5
  64. package/organizationConnection.js +7 -5
  65. package/organizationConnection.js.map +1 -1
  66. package/organizationMember.d.ts +27 -15
  67. package/organizationMember.js +18 -6
  68. package/organizationMember.js.map +1 -1
  69. package/package.json +2 -2
  70. package/package.json.dev +2 -2
  71. package/prompt.d.ts +12 -12
  72. package/prompt.js +4 -4
  73. package/promptCustomText.d.ts +8 -9
  74. package/promptCustomText.js +2 -3
  75. package/promptCustomText.js.map +1 -1
  76. package/provider.d.ts +41 -0
  77. package/provider.js +1 -0
  78. package/provider.js.map +1 -1
  79. package/resourceServer.d.ts +47 -46
  80. package/resourceServer.js +4 -1
  81. package/resourceServer.js.map +1 -1
  82. package/role.d.ts +13 -17
  83. package/role.js +2 -4
  84. package/role.js.map +1 -1
  85. package/rule.d.ts +19 -25
  86. package/rule.js +6 -12
  87. package/rule.js.map +1 -1
  88. package/ruleConfig.d.ts +12 -14
  89. package/ruleConfig.js +9 -9
  90. package/ruleConfig.js.map +1 -1
  91. package/tenant.d.ts +91 -80
  92. package/tenant.js +35 -25
  93. package/tenant.js.map +1 -1
  94. package/triggerBinding.d.ts +19 -26
  95. package/triggerBinding.js +11 -16
  96. package/triggerBinding.js.map +1 -1
  97. package/types/index.js.map +1 -1
  98. package/types/input.d.ts +488 -425
  99. package/types/output.d.ts +500 -435
  100. package/user.d.ts +87 -44
  101. package/user.js +6 -6
  102. package/user.js.map +1 -1
  103. package/utilities.js +13 -1
  104. package/utilities.js.map +1 -1
package/client.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
- import { input as inputs, output as outputs } from "./types";
2
+ import * as inputs from "./types/input";
3
+ import * as outputs from "./types/output";
3
4
  /**
4
- * With this resource, you can set up applications that use Auth0 for authentication and configure allowed callback URLs and secrets for these applications. Depending on your plan, you may also configure add-ons to allow your application to call another application's API (such as Firebase and AWS) on behalf of an authenticated user.
5
+ * With this resource, you can set up applications that use Auth0 for authentication and configure allowed callback URLs and secrets for these applications.
5
6
  *
6
7
  * ## Example Usage
7
8
  *
@@ -11,15 +12,10 @@ import { input as inputs, output as outputs } from "./types";
11
12
  *
12
13
  * const myClient = new auth0.Client("my_client", {
13
14
  * addons: {
14
- * firebase: {
15
- * client_email: "john.doe@example.com",
16
- * lifetime_in_seconds: 1,
17
- * private_key: "wer",
18
- * private_key_id: "qwreerwerwe",
19
- * },
20
15
  * samlp: {
21
16
  * audience: "https://example.com/saml",
22
17
  * createUpnClaim: false,
18
+ * issuer: "https://example.com",
23
19
  * mapIdentities: false,
24
20
  * mapUnknownClaimsAsIs: false,
25
21
  * mappings: {
@@ -29,10 +25,25 @@ import { input as inputs, output as outputs } from "./types";
29
25
  * nameIdentifierFormat: "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
30
26
  * nameIdentifierProbes: ["http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"],
31
27
  * passthroughClaimsWithNoMapping: false,
32
- * signingCert: "pemcertificate",
28
+ * signingCert: `-----BEGIN PUBLIC KEY-----
29
+ * MIGf...bpP/t3
30
+ * +JGNGIRMj1hF1rnb6QIDAQAB
31
+ * -----END PUBLIC KEY-----
32
+ * `,
33
+ * signingKey: [{
34
+ * cert: `-----BEGIN PUBLIC KEY-----
35
+ * MIGf...bpP/t3
36
+ * +JGNGIRMj1hF1rnb6QIDAQAB
37
+ * -----END PUBLIC KEY-----
38
+ * `,
39
+ * key: `-----BEGIN PRIVATE KEY-----
40
+ * MIGf...bpP/t3
41
+ * +JGNGIRMj1hF1rnb6QIDAQAB
42
+ * -----END PUBLIC KEY-----
43
+ * `,
44
+ * }],
33
45
  * },
34
46
  * },
35
- * allowedClients: ["https://allowed.example.com"],
36
47
  * allowedLogoutUrls: ["https://example.com"],
37
48
  * allowedOrigins: ["https://example.com"],
38
49
  * appType: "non_interactive",
@@ -40,10 +51,6 @@ import { input as inputs, output as outputs } from "./types";
40
51
  * clientMetadata: {
41
52
  * foo: "zoo",
42
53
  * },
43
- * clientSecretRotationTrigger: {
44
- * triggered_at: "2018-01-02T23:12:01Z",
45
- * triggered_by: "auth0",
46
- * },
47
54
  * customLoginPageOn: true,
48
55
  * description: "Test Applications Long Description",
49
56
  * grantTypes: [
@@ -53,7 +60,6 @@ import { input as inputs, output as outputs } from "./types";
53
60
  * "password",
54
61
  * "refresh_token",
55
62
  * ],
56
- * initiateLoginUri: "https://example.com/login",
57
63
  * isFirstParty: true,
58
64
  * isTokenEndpointIpHeaderTrusted: true,
59
65
  * jwtConfiguration: {
@@ -71,16 +77,11 @@ import { input as inputs, output as outputs } from "./types";
71
77
  * },
72
78
  * },
73
79
  * oidcConformant: false,
74
- * organizationRequireBehavior: "no_prompt",
75
- * organizationUsage: "deny",
76
80
  * refreshToken: {
77
81
  * expirationType: "expiring",
78
- * idleTokenLifetime: 1296000,
79
- * infiniteIdleTokenLifetime: true,
80
- * infiniteTokenLifetime: false,
81
- * leeway: 15,
82
+ * leeway: 0,
82
83
  * rotationType: "rotating",
83
- * tokenLifetime: 84600,
84
+ * tokenLifetime: 2592000,
84
85
  * },
85
86
  * tokenEndpointAuthMethod: "client_secret_post",
86
87
  * webOrigins: ["https://example.com"],
@@ -89,7 +90,7 @@ import { input as inputs, output as outputs } from "./types";
89
90
  *
90
91
  * ## Import
91
92
  *
92
- * A client can be imported using the client's ID, e.g.
93
+ * A client can be imported using the client's ID. # Example
93
94
  *
94
95
  * ```sh
95
96
  * $ pulumi import auth0:index/client:Client my_client AaiyAPdpYdesoKnqjj8HJqRn4T5titww
@@ -112,149 +113,156 @@ export declare class Client extends pulumi.CustomResource {
112
113
  */
113
114
  static isInstance(obj: any): obj is Client;
114
115
  /**
115
- * List(Resource). Configuration settings for add-ons for this client. For details, see Add-ons.
116
+ * Addons enabled for this client and their associated configurations.
116
117
  */
117
- readonly addons: pulumi.Output<outputs.ClientAddons | undefined>;
118
+ readonly addons: pulumi.Output<outputs.ClientAddons>;
118
119
  /**
119
- * List(String). List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.
120
+ * List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.
120
121
  */
121
122
  readonly allowedClients: pulumi.Output<string[] | undefined>;
122
123
  /**
123
- * List(String). URLs that Auth0 may redirect to after logout.
124
+ * URLs that Auth0 may redirect to after logout.
124
125
  */
125
126
  readonly allowedLogoutUrls: pulumi.Output<string[] | undefined>;
126
127
  /**
127
- * List(String). URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
128
+ * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
128
129
  */
129
130
  readonly allowedOrigins: pulumi.Output<string[] | undefined>;
130
131
  /**
131
- * String. Type of application the client represents. Options include `native`, `spa`, `regularWeb`, `nonInteractive`, `rms`, `box`, `cloudbees`, `concur`, `dropbox`, `mscrm`, `echosign`, `egnyte`, `newrelic`, `office365`, `salesforce`, `sentry`, `sharepoint`, `slack`, `springcm`, `ssoIntegration`, `zendesk`, `zoom`.
132
+ * Type of application the client represents. Possible values are: `native`, `spa`, `regularWeb`, `nonInteractive`, `ssoIntegration`. Specific SSO integrations types accepted as well are: `rms`, `box`, `cloudbees`, `concur`, `dropbox`, `mscrm`, `echosign`, `egnyte`, `newrelic`, `office365`, `salesforce`, `sentry`, `sharepoint`, `slack`, `springcm`, `zendesk`, `zoom`.
132
133
  */
133
134
  readonly appType: pulumi.Output<string | undefined>;
134
135
  /**
135
- * List(String). URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.
136
+ * URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.
136
137
  */
137
138
  readonly callbacks: pulumi.Output<string[] | undefined>;
138
139
  /**
139
- * String. ID of the client.
140
- * * `clientSecret`<sup>1</sup> - String. Secret for the client; keep this private.
140
+ * List of audiences/realms for SAML protocol. Used by the wsfed addon.
141
+ */
142
+ readonly clientAliases: pulumi.Output<string[] | undefined>;
143
+ /**
144
+ * The ID of the client.
141
145
  */
142
146
  readonly clientId: pulumi.Output<string>;
143
147
  /**
144
- * Map(String)
148
+ * 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]`.
145
149
  */
146
150
  readonly clientMetadata: pulumi.Output<{
147
151
  [key: string]: any;
148
152
  } | undefined>;
153
+ /**
154
+ * Secret for the client. Keep this private. To access this attribute you need to add the `read:client_keys` scope to the
155
+ * Terraform client. Otherwise, the attribute will contain an empty string.
156
+ */
149
157
  readonly clientSecret: pulumi.Output<string>;
150
158
  /**
151
- * Map. Custom metadata for the rotation. For more info: [rotate-client-secret](https://auth0.com/docs/get-started/applications/rotate-client-secret).
159
+ * Custom metadata for the rotation. For more info: [rotate-client-secret](https://auth0.com/docs/get-started/applications/rotate-client-secret).
152
160
  */
153
161
  readonly clientSecretRotationTrigger: pulumi.Output<{
154
162
  [key: string]: any;
155
163
  } | undefined>;
156
164
  /**
157
- * Boolean. Indicates whether or not the client can be used to make cross-origin authentication requests.
165
+ * Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
158
166
  */
159
167
  readonly crossOriginAuth: pulumi.Output<boolean | undefined>;
160
168
  /**
161
- * String. URL for the location on your site where the cross-origin verification takes place for the cross-origin auth flow. Used when performing auth in your own domain instead of through the Auth0-hosted login page.
169
+ * URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.
162
170
  */
163
171
  readonly crossOriginLoc: pulumi.Output<string | undefined>;
164
172
  /**
165
- * String. Content of the custom login page.
173
+ * The content (HTML, CSS, JS) of the custom login page.
166
174
  */
167
175
  readonly customLoginPage: pulumi.Output<string | undefined>;
168
176
  /**
169
- * Boolean. Indicates whether or not a custom login page is to be used.
177
+ * Indicates whether a custom login page is to be used.
170
178
  */
171
179
  readonly customLoginPageOn: pulumi.Output<boolean>;
172
180
  /**
173
- * String, (Max length = 140 characters). Description of the purpose of the client.
181
+ * Description of the purpose of the client.
174
182
  */
175
183
  readonly description: pulumi.Output<string>;
176
184
  /**
177
- * Map(String).
185
+ * Encryption used for WS-Fed responses with this client.
178
186
  */
179
187
  readonly encryptionKey: pulumi.Output<{
180
188
  [key: string]: string;
181
189
  } | undefined>;
182
190
  /**
183
- * String. Form template for WS-Federation protocol.
191
+ * HTML form template to be used for WS-Federation.
184
192
  */
185
193
  readonly formTemplate: pulumi.Output<string | undefined>;
186
194
  /**
187
- * List(String). Types of grants that this client is authorized to use.
195
+ * Types of grants that this client is authorized to use.
188
196
  */
189
197
  readonly grantTypes: pulumi.Output<string[]>;
190
198
  /**
191
- * String. Initiate login uri, must be https.
199
+ * Initiate login URI, must be HTTPS.
192
200
  */
193
201
  readonly initiateLoginUri: pulumi.Output<string | undefined>;
194
202
  /**
195
- * Boolean. Indicates whether or not this client is a first-party client.
203
+ * Indicates whether this client is a first-party client.
196
204
  */
197
205
  readonly isFirstParty: pulumi.Output<boolean>;
198
206
  /**
199
- * Boolean. Indicates whether or not the token endpoint IP header is trusted.
207
+ * Indicates whether the token endpoint IP header is trusted.
200
208
  */
201
209
  readonly isTokenEndpointIpHeaderTrusted: pulumi.Output<boolean>;
202
210
  /**
203
- * List(Resource). Configuration settings for the JWTs issued for this client. For details, see JWT Configuration.
211
+ * Configuration settings for the JWTs issued for this client.
204
212
  */
205
213
  readonly jwtConfiguration: pulumi.Output<outputs.ClientJwtConfiguration>;
206
214
  /**
207
- * String. URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.
215
+ * URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.
208
216
  */
209
217
  readonly logoUri: pulumi.Output<string | undefined>;
210
218
  /**
211
- * List(Resource). Configuration settings for mobile native applications. For details, see Mobile.
219
+ * Additional configuration for native mobile apps.
212
220
  */
213
221
  readonly mobile: pulumi.Output<outputs.ClientMobile>;
214
222
  /**
215
- * String. Name of the client.
223
+ * Name of the client.
216
224
  */
217
225
  readonly name: pulumi.Output<string>;
218
226
  /**
219
- * List(Resource). Configuration settings to toggle native social login for mobile native applications. For details, see Native Social Login
227
+ * Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to `false` in order to change the `appType`.
220
228
  */
221
229
  readonly nativeSocialLogin: pulumi.Output<outputs.ClientNativeSocialLogin>;
222
230
  /**
223
- * Boolean. Indicates whether or not this client will conform to strict OIDC specifications.
231
+ * Indicates whether this client will conform to strict OIDC specifications.
224
232
  */
225
233
  readonly oidcConformant: pulumi.Output<boolean>;
226
234
  /**
227
- * String. Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default) or `preLoginPrompt`.
235
+ * Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default) or `preLoginPrompt`.
228
236
  */
229
237
  readonly organizationRequireBehavior: pulumi.Output<string | undefined>;
230
238
  /**
231
- * String. Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`.
239
+ * Defines how to proceed during an authentication transaction with regards to an organization. Can be `deny` (default), `allow` or `require`.
232
240
  */
233
241
  readonly organizationUsage: pulumi.Output<string | undefined>;
234
242
  /**
235
- * List(Resource). Configuration settings for the refresh tokens issued for this client. For details, see Refresh Token Configuration.
243
+ * Configuration settings for the refresh tokens issued for this client.
236
244
  */
237
245
  readonly refreshToken: pulumi.Output<outputs.ClientRefreshToken>;
238
246
  /**
239
- * List(Map). List containing a map of the public cert of the signing key and the public cert of the signing key in pkcs7.
247
+ * List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
240
248
  */
241
249
  readonly signingKeys: pulumi.Output<{
242
250
  [key: string]: any;
243
251
  }[]>;
244
252
  /**
245
- * Boolean. Indicates whether or not the client should use Auth0 rather than the IdP to perform Single Sign-On (SSO). True = Use Auth0.
253
+ * Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).
246
254
  */
247
255
  readonly sso: pulumi.Output<boolean | undefined>;
248
256
  /**
249
- * Boolean. Indicates whether or not SSO is disabled.
257
+ * Indicates whether or not SSO is disabled.
250
258
  */
251
259
  readonly ssoDisabled: pulumi.Output<boolean | undefined>;
252
260
  /**
253
- * String. Defines the requested authentication method for the token endpoint. Options include `none` (public client without a client secret), `clientSecretPost` (client uses HTTP POST parameters), `clientSecretBasic` (client uses HTTP Basic).
261
+ * Defines the requested authentication method for the token endpoint. Options include `none` (public client without a client secret), `clientSecretPost` (client uses HTTP POST parameters), `clientSecretBasic` (client uses HTTP Basic).
254
262
  */
255
263
  readonly tokenEndpointAuthMethod: pulumi.Output<string>;
256
264
  /**
257
- * List(String). URLs that represent valid web origins for use with web message response mode.
265
+ * URLs that represent valid web origins for use with web message response mode.
258
266
  */
259
267
  readonly webOrigins: pulumi.Output<string[] | undefined>;
260
268
  /**
@@ -271,149 +279,156 @@ export declare class Client extends pulumi.CustomResource {
271
279
  */
272
280
  export interface ClientState {
273
281
  /**
274
- * List(Resource). Configuration settings for add-ons for this client. For details, see Add-ons.
282
+ * Addons enabled for this client and their associated configurations.
275
283
  */
276
284
  addons?: pulumi.Input<inputs.ClientAddons>;
277
285
  /**
278
- * List(String). List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.
286
+ * List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.
279
287
  */
280
288
  allowedClients?: pulumi.Input<pulumi.Input<string>[]>;
281
289
  /**
282
- * List(String). URLs that Auth0 may redirect to after logout.
290
+ * URLs that Auth0 may redirect to after logout.
283
291
  */
284
292
  allowedLogoutUrls?: pulumi.Input<pulumi.Input<string>[]>;
285
293
  /**
286
- * List(String). URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
294
+ * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
287
295
  */
288
296
  allowedOrigins?: pulumi.Input<pulumi.Input<string>[]>;
289
297
  /**
290
- * String. Type of application the client represents. Options include `native`, `spa`, `regularWeb`, `nonInteractive`, `rms`, `box`, `cloudbees`, `concur`, `dropbox`, `mscrm`, `echosign`, `egnyte`, `newrelic`, `office365`, `salesforce`, `sentry`, `sharepoint`, `slack`, `springcm`, `ssoIntegration`, `zendesk`, `zoom`.
298
+ * Type of application the client represents. Possible values are: `native`, `spa`, `regularWeb`, `nonInteractive`, `ssoIntegration`. Specific SSO integrations types accepted as well are: `rms`, `box`, `cloudbees`, `concur`, `dropbox`, `mscrm`, `echosign`, `egnyte`, `newrelic`, `office365`, `salesforce`, `sentry`, `sharepoint`, `slack`, `springcm`, `zendesk`, `zoom`.
291
299
  */
292
300
  appType?: pulumi.Input<string>;
293
301
  /**
294
- * List(String). URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.
302
+ * URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.
295
303
  */
296
304
  callbacks?: pulumi.Input<pulumi.Input<string>[]>;
297
305
  /**
298
- * String. ID of the client.
299
- * * `clientSecret`<sup>1</sup> - String. Secret for the client; keep this private.
306
+ * List of audiences/realms for SAML protocol. Used by the wsfed addon.
307
+ */
308
+ clientAliases?: pulumi.Input<pulumi.Input<string>[]>;
309
+ /**
310
+ * The ID of the client.
300
311
  */
301
312
  clientId?: pulumi.Input<string>;
302
313
  /**
303
- * Map(String)
314
+ * 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]`.
304
315
  */
305
316
  clientMetadata?: pulumi.Input<{
306
317
  [key: string]: any;
307
318
  }>;
319
+ /**
320
+ * Secret for the client. Keep this private. To access this attribute you need to add the `read:client_keys` scope to the
321
+ * Terraform client. Otherwise, the attribute will contain an empty string.
322
+ */
308
323
  clientSecret?: pulumi.Input<string>;
309
324
  /**
310
- * Map. Custom metadata for the rotation. For more info: [rotate-client-secret](https://auth0.com/docs/get-started/applications/rotate-client-secret).
325
+ * Custom metadata for the rotation. For more info: [rotate-client-secret](https://auth0.com/docs/get-started/applications/rotate-client-secret).
311
326
  */
312
327
  clientSecretRotationTrigger?: pulumi.Input<{
313
328
  [key: string]: any;
314
329
  }>;
315
330
  /**
316
- * Boolean. Indicates whether or not the client can be used to make cross-origin authentication requests.
331
+ * Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
317
332
  */
318
333
  crossOriginAuth?: pulumi.Input<boolean>;
319
334
  /**
320
- * String. URL for the location on your site where the cross-origin verification takes place for the cross-origin auth flow. Used when performing auth in your own domain instead of through the Auth0-hosted login page.
335
+ * URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.
321
336
  */
322
337
  crossOriginLoc?: pulumi.Input<string>;
323
338
  /**
324
- * String. Content of the custom login page.
339
+ * The content (HTML, CSS, JS) of the custom login page.
325
340
  */
326
341
  customLoginPage?: pulumi.Input<string>;
327
342
  /**
328
- * Boolean. Indicates whether or not a custom login page is to be used.
343
+ * Indicates whether a custom login page is to be used.
329
344
  */
330
345
  customLoginPageOn?: pulumi.Input<boolean>;
331
346
  /**
332
- * String, (Max length = 140 characters). Description of the purpose of the client.
347
+ * Description of the purpose of the client.
333
348
  */
334
349
  description?: pulumi.Input<string>;
335
350
  /**
336
- * Map(String).
351
+ * Encryption used for WS-Fed responses with this client.
337
352
  */
338
353
  encryptionKey?: pulumi.Input<{
339
354
  [key: string]: pulumi.Input<string>;
340
355
  }>;
341
356
  /**
342
- * String. Form template for WS-Federation protocol.
357
+ * HTML form template to be used for WS-Federation.
343
358
  */
344
359
  formTemplate?: pulumi.Input<string>;
345
360
  /**
346
- * List(String). Types of grants that this client is authorized to use.
361
+ * Types of grants that this client is authorized to use.
347
362
  */
348
363
  grantTypes?: pulumi.Input<pulumi.Input<string>[]>;
349
364
  /**
350
- * String. Initiate login uri, must be https.
365
+ * Initiate login URI, must be HTTPS.
351
366
  */
352
367
  initiateLoginUri?: pulumi.Input<string>;
353
368
  /**
354
- * Boolean. Indicates whether or not this client is a first-party client.
369
+ * Indicates whether this client is a first-party client.
355
370
  */
356
371
  isFirstParty?: pulumi.Input<boolean>;
357
372
  /**
358
- * Boolean. Indicates whether or not the token endpoint IP header is trusted.
373
+ * Indicates whether the token endpoint IP header is trusted.
359
374
  */
360
375
  isTokenEndpointIpHeaderTrusted?: pulumi.Input<boolean>;
361
376
  /**
362
- * List(Resource). Configuration settings for the JWTs issued for this client. For details, see JWT Configuration.
377
+ * Configuration settings for the JWTs issued for this client.
363
378
  */
364
379
  jwtConfiguration?: pulumi.Input<inputs.ClientJwtConfiguration>;
365
380
  /**
366
- * String. URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.
381
+ * URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.
367
382
  */
368
383
  logoUri?: pulumi.Input<string>;
369
384
  /**
370
- * List(Resource). Configuration settings for mobile native applications. For details, see Mobile.
385
+ * Additional configuration for native mobile apps.
371
386
  */
372
387
  mobile?: pulumi.Input<inputs.ClientMobile>;
373
388
  /**
374
- * String. Name of the client.
389
+ * Name of the client.
375
390
  */
376
391
  name?: pulumi.Input<string>;
377
392
  /**
378
- * List(Resource). Configuration settings to toggle native social login for mobile native applications. For details, see Native Social Login
393
+ * Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to `false` in order to change the `appType`.
379
394
  */
380
395
  nativeSocialLogin?: pulumi.Input<inputs.ClientNativeSocialLogin>;
381
396
  /**
382
- * Boolean. Indicates whether or not this client will conform to strict OIDC specifications.
397
+ * Indicates whether this client will conform to strict OIDC specifications.
383
398
  */
384
399
  oidcConformant?: pulumi.Input<boolean>;
385
400
  /**
386
- * String. Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default) or `preLoginPrompt`.
401
+ * Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default) or `preLoginPrompt`.
387
402
  */
388
403
  organizationRequireBehavior?: pulumi.Input<string>;
389
404
  /**
390
- * String. Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`.
405
+ * Defines how to proceed during an authentication transaction with regards to an organization. Can be `deny` (default), `allow` or `require`.
391
406
  */
392
407
  organizationUsage?: pulumi.Input<string>;
393
408
  /**
394
- * List(Resource). Configuration settings for the refresh tokens issued for this client. For details, see Refresh Token Configuration.
409
+ * Configuration settings for the refresh tokens issued for this client.
395
410
  */
396
411
  refreshToken?: pulumi.Input<inputs.ClientRefreshToken>;
397
412
  /**
398
- * List(Map). List containing a map of the public cert of the signing key and the public cert of the signing key in pkcs7.
413
+ * List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
399
414
  */
400
415
  signingKeys?: pulumi.Input<pulumi.Input<{
401
416
  [key: string]: any;
402
417
  }>[]>;
403
418
  /**
404
- * Boolean. Indicates whether or not the client should use Auth0 rather than the IdP to perform Single Sign-On (SSO). True = Use Auth0.
419
+ * Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).
405
420
  */
406
421
  sso?: pulumi.Input<boolean>;
407
422
  /**
408
- * Boolean. Indicates whether or not SSO is disabled.
423
+ * Indicates whether or not SSO is disabled.
409
424
  */
410
425
  ssoDisabled?: pulumi.Input<boolean>;
411
426
  /**
412
- * String. Defines the requested authentication method for the token endpoint. Options include `none` (public client without a client secret), `clientSecretPost` (client uses HTTP POST parameters), `clientSecretBasic` (client uses HTTP Basic).
427
+ * Defines the requested authentication method for the token endpoint. Options include `none` (public client without a client secret), `clientSecretPost` (client uses HTTP POST parameters), `clientSecretBasic` (client uses HTTP Basic).
413
428
  */
414
429
  tokenEndpointAuthMethod?: pulumi.Input<string>;
415
430
  /**
416
- * List(String). URLs that represent valid web origins for use with web message response mode.
431
+ * URLs that represent valid web origins for use with web message response mode.
417
432
  */
418
433
  webOrigins?: pulumi.Input<pulumi.Input<string>[]>;
419
434
  }
@@ -422,137 +437,141 @@ export interface ClientState {
422
437
  */
423
438
  export interface ClientArgs {
424
439
  /**
425
- * List(Resource). Configuration settings for add-ons for this client. For details, see Add-ons.
440
+ * Addons enabled for this client and their associated configurations.
426
441
  */
427
442
  addons?: pulumi.Input<inputs.ClientAddons>;
428
443
  /**
429
- * List(String). List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.
444
+ * List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.
430
445
  */
431
446
  allowedClients?: pulumi.Input<pulumi.Input<string>[]>;
432
447
  /**
433
- * List(String). URLs that Auth0 may redirect to after logout.
448
+ * URLs that Auth0 may redirect to after logout.
434
449
  */
435
450
  allowedLogoutUrls?: pulumi.Input<pulumi.Input<string>[]>;
436
451
  /**
437
- * List(String). URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
452
+ * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
438
453
  */
439
454
  allowedOrigins?: pulumi.Input<pulumi.Input<string>[]>;
440
455
  /**
441
- * String. Type of application the client represents. Options include `native`, `spa`, `regularWeb`, `nonInteractive`, `rms`, `box`, `cloudbees`, `concur`, `dropbox`, `mscrm`, `echosign`, `egnyte`, `newrelic`, `office365`, `salesforce`, `sentry`, `sharepoint`, `slack`, `springcm`, `ssoIntegration`, `zendesk`, `zoom`.
456
+ * Type of application the client represents. Possible values are: `native`, `spa`, `regularWeb`, `nonInteractive`, `ssoIntegration`. Specific SSO integrations types accepted as well are: `rms`, `box`, `cloudbees`, `concur`, `dropbox`, `mscrm`, `echosign`, `egnyte`, `newrelic`, `office365`, `salesforce`, `sentry`, `sharepoint`, `slack`, `springcm`, `zendesk`, `zoom`.
442
457
  */
443
458
  appType?: pulumi.Input<string>;
444
459
  /**
445
- * List(String). URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.
460
+ * URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.
446
461
  */
447
462
  callbacks?: pulumi.Input<pulumi.Input<string>[]>;
448
463
  /**
449
- * Map(String)
464
+ * List of audiences/realms for SAML protocol. Used by the wsfed addon.
465
+ */
466
+ clientAliases?: pulumi.Input<pulumi.Input<string>[]>;
467
+ /**
468
+ * 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]`.
450
469
  */
451
470
  clientMetadata?: pulumi.Input<{
452
471
  [key: string]: any;
453
472
  }>;
454
473
  /**
455
- * Map. Custom metadata for the rotation. For more info: [rotate-client-secret](https://auth0.com/docs/get-started/applications/rotate-client-secret).
474
+ * Custom metadata for the rotation. For more info: [rotate-client-secret](https://auth0.com/docs/get-started/applications/rotate-client-secret).
456
475
  */
457
476
  clientSecretRotationTrigger?: pulumi.Input<{
458
477
  [key: string]: any;
459
478
  }>;
460
479
  /**
461
- * Boolean. Indicates whether or not the client can be used to make cross-origin authentication requests.
480
+ * Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
462
481
  */
463
482
  crossOriginAuth?: pulumi.Input<boolean>;
464
483
  /**
465
- * String. URL for the location on your site where the cross-origin verification takes place for the cross-origin auth flow. Used when performing auth in your own domain instead of through the Auth0-hosted login page.
484
+ * URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.
466
485
  */
467
486
  crossOriginLoc?: pulumi.Input<string>;
468
487
  /**
469
- * String. Content of the custom login page.
488
+ * The content (HTML, CSS, JS) of the custom login page.
470
489
  */
471
490
  customLoginPage?: pulumi.Input<string>;
472
491
  /**
473
- * Boolean. Indicates whether or not a custom login page is to be used.
492
+ * Indicates whether a custom login page is to be used.
474
493
  */
475
494
  customLoginPageOn?: pulumi.Input<boolean>;
476
495
  /**
477
- * String, (Max length = 140 characters). Description of the purpose of the client.
496
+ * Description of the purpose of the client.
478
497
  */
479
498
  description?: pulumi.Input<string>;
480
499
  /**
481
- * Map(String).
500
+ * Encryption used for WS-Fed responses with this client.
482
501
  */
483
502
  encryptionKey?: pulumi.Input<{
484
503
  [key: string]: pulumi.Input<string>;
485
504
  }>;
486
505
  /**
487
- * String. Form template for WS-Federation protocol.
506
+ * HTML form template to be used for WS-Federation.
488
507
  */
489
508
  formTemplate?: pulumi.Input<string>;
490
509
  /**
491
- * List(String). Types of grants that this client is authorized to use.
510
+ * Types of grants that this client is authorized to use.
492
511
  */
493
512
  grantTypes?: pulumi.Input<pulumi.Input<string>[]>;
494
513
  /**
495
- * String. Initiate login uri, must be https.
514
+ * Initiate login URI, must be HTTPS.
496
515
  */
497
516
  initiateLoginUri?: pulumi.Input<string>;
498
517
  /**
499
- * Boolean. Indicates whether or not this client is a first-party client.
518
+ * Indicates whether this client is a first-party client.
500
519
  */
501
520
  isFirstParty?: pulumi.Input<boolean>;
502
521
  /**
503
- * Boolean. Indicates whether or not the token endpoint IP header is trusted.
522
+ * Indicates whether the token endpoint IP header is trusted.
504
523
  */
505
524
  isTokenEndpointIpHeaderTrusted?: pulumi.Input<boolean>;
506
525
  /**
507
- * List(Resource). Configuration settings for the JWTs issued for this client. For details, see JWT Configuration.
526
+ * Configuration settings for the JWTs issued for this client.
508
527
  */
509
528
  jwtConfiguration?: pulumi.Input<inputs.ClientJwtConfiguration>;
510
529
  /**
511
- * String. URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.
530
+ * URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.
512
531
  */
513
532
  logoUri?: pulumi.Input<string>;
514
533
  /**
515
- * List(Resource). Configuration settings for mobile native applications. For details, see Mobile.
534
+ * Additional configuration for native mobile apps.
516
535
  */
517
536
  mobile?: pulumi.Input<inputs.ClientMobile>;
518
537
  /**
519
- * String. Name of the client.
538
+ * Name of the client.
520
539
  */
521
540
  name?: pulumi.Input<string>;
522
541
  /**
523
- * List(Resource). Configuration settings to toggle native social login for mobile native applications. For details, see Native Social Login
542
+ * Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to `false` in order to change the `appType`.
524
543
  */
525
544
  nativeSocialLogin?: pulumi.Input<inputs.ClientNativeSocialLogin>;
526
545
  /**
527
- * Boolean. Indicates whether or not this client will conform to strict OIDC specifications.
546
+ * Indicates whether this client will conform to strict OIDC specifications.
528
547
  */
529
548
  oidcConformant?: pulumi.Input<boolean>;
530
549
  /**
531
- * String. Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default) or `preLoginPrompt`.
550
+ * Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default) or `preLoginPrompt`.
532
551
  */
533
552
  organizationRequireBehavior?: pulumi.Input<string>;
534
553
  /**
535
- * String. Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`.
554
+ * Defines how to proceed during an authentication transaction with regards to an organization. Can be `deny` (default), `allow` or `require`.
536
555
  */
537
556
  organizationUsage?: pulumi.Input<string>;
538
557
  /**
539
- * List(Resource). Configuration settings for the refresh tokens issued for this client. For details, see Refresh Token Configuration.
558
+ * Configuration settings for the refresh tokens issued for this client.
540
559
  */
541
560
  refreshToken?: pulumi.Input<inputs.ClientRefreshToken>;
542
561
  /**
543
- * Boolean. Indicates whether or not the client should use Auth0 rather than the IdP to perform Single Sign-On (SSO). True = Use Auth0.
562
+ * Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).
544
563
  */
545
564
  sso?: pulumi.Input<boolean>;
546
565
  /**
547
- * Boolean. Indicates whether or not SSO is disabled.
566
+ * Indicates whether or not SSO is disabled.
548
567
  */
549
568
  ssoDisabled?: pulumi.Input<boolean>;
550
569
  /**
551
- * String. Defines the requested authentication method for the token endpoint. Options include `none` (public client without a client secret), `clientSecretPost` (client uses HTTP POST parameters), `clientSecretBasic` (client uses HTTP Basic).
570
+ * Defines the requested authentication method for the token endpoint. Options include `none` (public client without a client secret), `clientSecretPost` (client uses HTTP POST parameters), `clientSecretBasic` (client uses HTTP Basic).
552
571
  */
553
572
  tokenEndpointAuthMethod?: pulumi.Input<string>;
554
573
  /**
555
- * List(String). URLs that represent valid web origins for use with web message response mode.
574
+ * URLs that represent valid web origins for use with web message response mode.
556
575
  */
557
576
  webOrigins?: pulumi.Input<pulumi.Input<string>[]>;
558
577
  }