auth0 5.11.0 → 5.12.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/lib/retry.d.ts +7 -2
- package/dist/cjs/lib/retry.js +35 -5
- package/dist/cjs/management/api/requests/requests.d.ts +12 -2
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.ts +6 -6
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +6 -6
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +4 -4
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +68 -85
- package/dist/cjs/management/api/resources/clients/client/Client.js +68 -85
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +4 -9
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +4 -9
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.d.ts +38 -14
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +38 -14
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/connections/resources/users/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/customDomains/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.d.ts +50 -81
- package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +50 -81
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.d.ts +5 -3
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.js +9 -3
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.d.ts +5 -0
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +15 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.js +9 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.d.ts +10 -12
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +12 -12
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/userGrants/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/userGrants/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +6 -0
- package/dist/cjs/management/api/types/types.d.ts +131 -77
- package/dist/cjs/management/api/types/types.js +29 -45
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/lib/retry.d.mts +7 -2
- package/dist/esm/lib/retry.mjs +35 -5
- package/dist/esm/management/api/requests/requests.d.mts +12 -2
- package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.mts +6 -6
- package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +6 -6
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +4 -4
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +68 -85
- package/dist/esm/management/api/resources/clients/client/Client.mjs +68 -85
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +4 -9
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +4 -9
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.d.mts +38 -14
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +38 -14
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/connections/resources/users/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/customDomains/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/emails/resources/provider/client/Client.d.mts +50 -81
- package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +50 -81
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.d.mts +5 -3
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.mjs +9 -3
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.d.mts +5 -0
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +15 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.mjs +9 -0
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.d.mts +10 -12
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +12 -12
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/userGrants/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/userGrants/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +6 -0
- package/dist/esm/management/api/types/types.d.mts +131 -77
- package/dist/esm/management/api/types/types.mjs +16 -32
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +223 -261
|
@@ -11,7 +11,7 @@ export declare class ProviderClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ProviderClient.Options>;
|
|
12
12
|
constructor(options: ProviderClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve details of the
|
|
14
|
+
* Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.GetEmailProviderRequestParameters} request
|
|
17
17
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,48 +31,31 @@ export declare class ProviderClient {
|
|
|
31
31
|
get(request?: Management.GetEmailProviderRequestParameters, requestOptions?: ProviderClient.RequestOptions): core.HttpResponsePromise<Management.GetEmailProviderResponseContent>;
|
|
32
32
|
private __get;
|
|
33
33
|
/**
|
|
34
|
-
* Create an
|
|
35
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* <li>
|
|
51
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
52
|
-
* <code>smtp_pass</code>
|
|
53
|
-
* </li>
|
|
54
|
-
* </ul>
|
|
55
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
34
|
+
* Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
35
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
36
|
+
*
|
|
37
|
+
* - `mandrill` requires `api_key`
|
|
38
|
+
* - `sendgrid` requires `api_key`
|
|
39
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
40
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
41
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
42
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
43
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
44
|
+
* `null` are the only valid values for `region`.
|
|
45
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
46
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
47
|
+
* `smtp_pass`
|
|
48
|
+
*
|
|
49
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
56
50
|
* options, which will be used when sending an email:
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* <li>
|
|
66
|
-
* When using Sparkpost host, you may provide value for
|
|
67
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
68
|
-
* </li>
|
|
69
|
-
* </ul>
|
|
70
|
-
* </li>
|
|
71
|
-
* <li>
|
|
72
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
73
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
74
|
-
* </li>
|
|
75
|
-
* </ul>
|
|
51
|
+
*
|
|
52
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
53
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
54
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
55
|
+
* - When using Sparkpost host, you may provide value for
|
|
56
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
57
|
+
* - For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
58
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
76
59
|
*
|
|
77
60
|
* @param {Management.CreateEmailProviderRequestContent} request
|
|
78
61
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -110,46 +93,32 @@ export declare class ProviderClient {
|
|
|
110
93
|
delete(requestOptions?: ProviderClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
111
94
|
private __delete;
|
|
112
95
|
/**
|
|
113
|
-
* Update an
|
|
114
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* <li>
|
|
130
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
131
|
-
* <code>smtp_pass</code>
|
|
132
|
-
* </li>
|
|
133
|
-
* </ul>
|
|
134
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
96
|
+
* Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
97
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
98
|
+
*
|
|
99
|
+
* - `mandrill` requires `api_key`
|
|
100
|
+
* - `sendgrid` requires `api_key`
|
|
101
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
102
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
103
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
104
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
105
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
106
|
+
* `null` are the only valid values for `region`.
|
|
107
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
108
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
109
|
+
* `smtp_pass`
|
|
110
|
+
*
|
|
111
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
135
112
|
* options, which will be used when sending an email:
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* When using Sparkpost host, you may provide value for
|
|
146
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
147
|
-
* </li>
|
|
148
|
-
* </ul>
|
|
149
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
150
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
151
|
-
* </li>
|
|
152
|
-
* </ul>
|
|
113
|
+
*
|
|
114
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
115
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
116
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
117
|
+
* - When using Sparkpost host, you may provide value for
|
|
118
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
119
|
+
*
|
|
120
|
+
* For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
121
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
153
122
|
*
|
|
154
123
|
* @param {Management.UpdateEmailProviderRequestContent} request
|
|
155
124
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class ProviderClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve details of the
|
|
59
|
+
* Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
|
|
60
60
|
*
|
|
61
61
|
* @param {Management.GetEmailProviderRequestParameters} request
|
|
62
62
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -131,48 +131,31 @@ class ProviderClient {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Create an
|
|
135
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* <li>
|
|
151
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
152
|
-
* <code>smtp_pass</code>
|
|
153
|
-
* </li>
|
|
154
|
-
* </ul>
|
|
155
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
134
|
+
* Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
135
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
136
|
+
*
|
|
137
|
+
* - `mandrill` requires `api_key`
|
|
138
|
+
* - `sendgrid` requires `api_key`
|
|
139
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
140
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
141
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
142
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
143
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
144
|
+
* `null` are the only valid values for `region`.
|
|
145
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
146
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
147
|
+
* `smtp_pass`
|
|
148
|
+
*
|
|
149
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
156
150
|
* options, which will be used when sending an email:
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
* <li>
|
|
166
|
-
* When using Sparkpost host, you may provide value for
|
|
167
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
168
|
-
* </li>
|
|
169
|
-
* </ul>
|
|
170
|
-
* </li>
|
|
171
|
-
* <li>
|
|
172
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
173
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
174
|
-
* </li>
|
|
175
|
-
* </ul>
|
|
151
|
+
*
|
|
152
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
153
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
154
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
155
|
+
* - When using Sparkpost host, you may provide value for
|
|
156
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
157
|
+
* - For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
158
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
176
159
|
*
|
|
177
160
|
* @param {Management.CreateEmailProviderRequestContent} request
|
|
178
161
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -302,46 +285,32 @@ class ProviderClient {
|
|
|
302
285
|
});
|
|
303
286
|
}
|
|
304
287
|
/**
|
|
305
|
-
* Update an
|
|
306
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
307
|
-
*
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
* <li>
|
|
322
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
323
|
-
* <code>smtp_pass</code>
|
|
324
|
-
* </li>
|
|
325
|
-
* </ul>
|
|
326
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
288
|
+
* Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
289
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
290
|
+
*
|
|
291
|
+
* - `mandrill` requires `api_key`
|
|
292
|
+
* - `sendgrid` requires `api_key`
|
|
293
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
294
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
295
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
296
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
297
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
298
|
+
* `null` are the only valid values for `region`.
|
|
299
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
300
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
301
|
+
* `smtp_pass`
|
|
302
|
+
*
|
|
303
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
327
304
|
* options, which will be used when sending an email:
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
* When using Sparkpost host, you may provide value for
|
|
338
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
339
|
-
* </li>
|
|
340
|
-
* </ul>
|
|
341
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
342
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
343
|
-
* </li>
|
|
344
|
-
* </ul>
|
|
305
|
+
*
|
|
306
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
307
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
308
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
309
|
+
* - When using Sparkpost host, you may provide value for
|
|
310
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
311
|
+
*
|
|
312
|
+
* For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
313
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
345
314
|
*
|
|
346
315
|
* @param {Management.UpdateEmailProviderRequestContent} request
|
|
347
316
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,6 +20,7 @@ export declare class MembersClient {
|
|
|
20
20
|
* @throws {@link Management.BadRequestError}
|
|
21
21
|
* @throws {@link Management.UnauthorizedError}
|
|
22
22
|
* @throws {@link Management.ForbiddenError}
|
|
23
|
+
* @throws {@link Management.NotFoundError}
|
|
23
24
|
* @throws {@link Management.TooManyRequestsError}
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
@@ -65,6 +65,7 @@ class MembersClient {
|
|
|
65
65
|
* @throws {@link Management.BadRequestError}
|
|
66
66
|
* @throws {@link Management.UnauthorizedError}
|
|
67
67
|
* @throws {@link Management.ForbiddenError}
|
|
68
|
+
* @throws {@link Management.NotFoundError}
|
|
68
69
|
* @throws {@link Management.TooManyRequestsError}
|
|
69
70
|
*
|
|
70
71
|
* @example
|
|
@@ -117,6 +118,8 @@ class MembersClient {
|
|
|
117
118
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
118
119
|
case 403:
|
|
119
120
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
121
|
+
case 404:
|
|
122
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
120
123
|
case 429:
|
|
121
124
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
122
125
|
default:
|
|
@@ -11,7 +11,7 @@ export declare class RolesClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<RolesClient.Options>;
|
|
12
12
|
constructor(options: RolesClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Lists the
|
|
14
|
+
* Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assigned to a group.
|
|
15
15
|
*
|
|
16
16
|
* @param {string} id - Unique identifier for the group (service-generated).
|
|
17
17
|
* @param {Management.ListGroupRolesRequestParameters} request
|
|
@@ -20,6 +20,7 @@ export declare class RolesClient {
|
|
|
20
20
|
* @throws {@link Management.BadRequestError}
|
|
21
21
|
* @throws {@link Management.UnauthorizedError}
|
|
22
22
|
* @throws {@link Management.ForbiddenError}
|
|
23
|
+
* @throws {@link Management.NotFoundError}
|
|
23
24
|
* @throws {@link Management.TooManyRequestsError}
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
@@ -30,7 +31,7 @@ export declare class RolesClient {
|
|
|
30
31
|
*/
|
|
31
32
|
list(id: string, request?: Management.ListGroupRolesRequestParameters, requestOptions?: RolesClient.RequestOptions): Promise<core.Page<Management.Role, Management.ListGroupRolesResponseContent>>;
|
|
32
33
|
/**
|
|
33
|
-
* Assign one or more
|
|
34
|
+
* Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a specified group.
|
|
34
35
|
*
|
|
35
36
|
* @param {string} id - Unique identifier for the group (service-generated).
|
|
36
37
|
* @param {Management.CreateGroupRolesRequestParameters} request
|
|
@@ -50,7 +51,7 @@ export declare class RolesClient {
|
|
|
50
51
|
create(id: string, request: Management.CreateGroupRolesRequestParameters, requestOptions?: RolesClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
51
52
|
private __create;
|
|
52
53
|
/**
|
|
53
|
-
* Unassign one or more
|
|
54
|
+
* Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a specified group.
|
|
54
55
|
*
|
|
55
56
|
* @param {string} id - Unique identifier for the group (service-generated).
|
|
56
57
|
* @param {Management.DeleteGroupRolesRequestContent} request
|
|
@@ -59,6 +60,7 @@ export declare class RolesClient {
|
|
|
59
60
|
* @throws {@link Management.BadRequestError}
|
|
60
61
|
* @throws {@link Management.UnauthorizedError}
|
|
61
62
|
* @throws {@link Management.ForbiddenError}
|
|
63
|
+
* @throws {@link Management.NotFoundError}
|
|
62
64
|
* @throws {@link Management.TooManyRequestsError}
|
|
63
65
|
*
|
|
64
66
|
* @example
|
|
@@ -56,7 +56,7 @@ class RolesClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Lists the
|
|
59
|
+
* Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assigned to a group.
|
|
60
60
|
*
|
|
61
61
|
* @param {string} id - Unique identifier for the group (service-generated).
|
|
62
62
|
* @param {Management.ListGroupRolesRequestParameters} request
|
|
@@ -65,6 +65,7 @@ class RolesClient {
|
|
|
65
65
|
* @throws {@link Management.BadRequestError}
|
|
66
66
|
* @throws {@link Management.UnauthorizedError}
|
|
67
67
|
* @throws {@link Management.ForbiddenError}
|
|
68
|
+
* @throws {@link Management.NotFoundError}
|
|
68
69
|
* @throws {@link Management.TooManyRequestsError}
|
|
69
70
|
*
|
|
70
71
|
* @example
|
|
@@ -113,6 +114,8 @@ class RolesClient {
|
|
|
113
114
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
114
115
|
case 403:
|
|
115
116
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
117
|
+
case 404:
|
|
118
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
116
119
|
case 429:
|
|
117
120
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
118
121
|
default:
|
|
@@ -138,7 +141,7 @@ class RolesClient {
|
|
|
138
141
|
});
|
|
139
142
|
}
|
|
140
143
|
/**
|
|
141
|
-
* Assign one or more
|
|
144
|
+
* Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a specified group.
|
|
142
145
|
*
|
|
143
146
|
* @param {string} id - Unique identifier for the group (service-generated).
|
|
144
147
|
* @param {Management.CreateGroupRolesRequestParameters} request
|
|
@@ -204,7 +207,7 @@ class RolesClient {
|
|
|
204
207
|
});
|
|
205
208
|
}
|
|
206
209
|
/**
|
|
207
|
-
* Unassign one or more
|
|
210
|
+
* Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a specified group.
|
|
208
211
|
*
|
|
209
212
|
* @param {string} id - Unique identifier for the group (service-generated).
|
|
210
213
|
* @param {Management.DeleteGroupRolesRequestContent} request
|
|
@@ -213,6 +216,7 @@ class RolesClient {
|
|
|
213
216
|
* @throws {@link Management.BadRequestError}
|
|
214
217
|
* @throws {@link Management.UnauthorizedError}
|
|
215
218
|
* @throws {@link Management.ForbiddenError}
|
|
219
|
+
* @throws {@link Management.NotFoundError}
|
|
216
220
|
* @throws {@link Management.TooManyRequestsError}
|
|
217
221
|
*
|
|
218
222
|
* @example
|
|
@@ -253,6 +257,8 @@ class RolesClient {
|
|
|
253
257
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
254
258
|
case 403:
|
|
255
259
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
260
|
+
case 404:
|
|
261
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
256
262
|
case 429:
|
|
257
263
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
258
264
|
default:
|
|
@@ -94,6 +94,7 @@ export declare class OrganizationsClient {
|
|
|
94
94
|
* @throws {@link Management.BadRequestError}
|
|
95
95
|
* @throws {@link Management.UnauthorizedError}
|
|
96
96
|
* @throws {@link Management.ForbiddenError}
|
|
97
|
+
* @throws {@link Management.NotFoundError}
|
|
97
98
|
* @throws {@link Management.TooManyRequestsError}
|
|
98
99
|
*
|
|
99
100
|
* @example
|
|
@@ -110,6 +111,7 @@ export declare class OrganizationsClient {
|
|
|
110
111
|
* @throws {@link Management.BadRequestError}
|
|
111
112
|
* @throws {@link Management.UnauthorizedError}
|
|
112
113
|
* @throws {@link Management.ForbiddenError}
|
|
114
|
+
* @throws {@link Management.NotFoundError}
|
|
113
115
|
* @throws {@link Management.TooManyRequestsError}
|
|
114
116
|
*
|
|
115
117
|
* @example
|
|
@@ -266,6 +266,7 @@ class OrganizationsClient {
|
|
|
266
266
|
* @throws {@link Management.BadRequestError}
|
|
267
267
|
* @throws {@link Management.UnauthorizedError}
|
|
268
268
|
* @throws {@link Management.ForbiddenError}
|
|
269
|
+
* @throws {@link Management.NotFoundError}
|
|
269
270
|
* @throws {@link Management.TooManyRequestsError}
|
|
270
271
|
*
|
|
271
272
|
* @example
|
|
@@ -304,6 +305,8 @@ class OrganizationsClient {
|
|
|
304
305
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
305
306
|
case 403:
|
|
306
307
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
308
|
+
case 404:
|
|
309
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
307
310
|
case 429:
|
|
308
311
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
309
312
|
default:
|
|
@@ -326,6 +329,7 @@ class OrganizationsClient {
|
|
|
326
329
|
* @throws {@link Management.BadRequestError}
|
|
327
330
|
* @throws {@link Management.UnauthorizedError}
|
|
328
331
|
* @throws {@link Management.ForbiddenError}
|
|
332
|
+
* @throws {@link Management.NotFoundError}
|
|
329
333
|
* @throws {@link Management.TooManyRequestsError}
|
|
330
334
|
*
|
|
331
335
|
* @example
|
|
@@ -364,6 +368,8 @@ class OrganizationsClient {
|
|
|
364
368
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
365
369
|
case 403:
|
|
366
370
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
371
|
+
case 404:
|
|
372
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
367
373
|
case 429:
|
|
368
374
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
369
375
|
default:
|
package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts
CHANGED
|
@@ -37,6 +37,7 @@ export declare class ConnectionsClient {
|
|
|
37
37
|
* @throws {@link Management.BadRequestError}
|
|
38
38
|
* @throws {@link Management.UnauthorizedError}
|
|
39
39
|
* @throws {@link Management.ForbiddenError}
|
|
40
|
+
* @throws {@link Management.NotFoundError}
|
|
40
41
|
* @throws {@link Management.ConflictError}
|
|
41
42
|
* @throws {@link Management.TooManyRequestsError}
|
|
42
43
|
*
|
package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js
CHANGED
|
@@ -149,6 +149,7 @@ class ConnectionsClient {
|
|
|
149
149
|
* @throws {@link Management.BadRequestError}
|
|
150
150
|
* @throws {@link Management.UnauthorizedError}
|
|
151
151
|
* @throws {@link Management.ForbiddenError}
|
|
152
|
+
* @throws {@link Management.NotFoundError}
|
|
152
153
|
* @throws {@link Management.ConflictError}
|
|
153
154
|
* @throws {@link Management.TooManyRequestsError}
|
|
154
155
|
*
|
|
@@ -193,6 +194,8 @@ class ConnectionsClient {
|
|
|
193
194
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
194
195
|
case 403:
|
|
195
196
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
197
|
+
case 404:
|
|
198
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
196
199
|
case 409:
|
|
197
200
|
throw new Management.ConflictError(_response.error.body, _response.rawResponse);
|
|
198
201
|
case 429:
|
|
@@ -20,6 +20,7 @@ export declare class EnabledConnectionsClient {
|
|
|
20
20
|
* @throws {@link Management.BadRequestError}
|
|
21
21
|
* @throws {@link Management.UnauthorizedError}
|
|
22
22
|
* @throws {@link Management.ForbiddenError}
|
|
23
|
+
* @throws {@link Management.NotFoundError}
|
|
23
24
|
* @throws {@link Management.TooManyRequestsError}
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
@@ -42,6 +43,7 @@ export declare class EnabledConnectionsClient {
|
|
|
42
43
|
* @throws {@link Management.BadRequestError}
|
|
43
44
|
* @throws {@link Management.UnauthorizedError}
|
|
44
45
|
* @throws {@link Management.ForbiddenError}
|
|
46
|
+
* @throws {@link Management.NotFoundError}
|
|
45
47
|
* @throws {@link Management.TooManyRequestsError}
|
|
46
48
|
*
|
|
47
49
|
* @example
|
|
@@ -60,6 +62,7 @@ export declare class EnabledConnectionsClient {
|
|
|
60
62
|
*
|
|
61
63
|
* @throws {@link Management.UnauthorizedError}
|
|
62
64
|
* @throws {@link Management.ForbiddenError}
|
|
65
|
+
* @throws {@link Management.NotFoundError}
|
|
63
66
|
* @throws {@link Management.TooManyRequestsError}
|
|
64
67
|
*
|
|
65
68
|
* @example
|
|
@@ -79,6 +82,7 @@ export declare class EnabledConnectionsClient {
|
|
|
79
82
|
* @throws {@link Management.BadRequestError}
|
|
80
83
|
* @throws {@link Management.UnauthorizedError}
|
|
81
84
|
* @throws {@link Management.ForbiddenError}
|
|
85
|
+
* @throws {@link Management.NotFoundError}
|
|
82
86
|
* @throws {@link Management.TooManyRequestsError}
|
|
83
87
|
*
|
|
84
88
|
* @example
|
|
@@ -97,6 +101,7 @@ export declare class EnabledConnectionsClient {
|
|
|
97
101
|
* @throws {@link Management.BadRequestError}
|
|
98
102
|
* @throws {@link Management.UnauthorizedError}
|
|
99
103
|
* @throws {@link Management.ForbiddenError}
|
|
104
|
+
* @throws {@link Management.NotFoundError}
|
|
100
105
|
* @throws {@link Management.TooManyRequestsError}
|
|
101
106
|
*
|
|
102
107
|
* @example
|