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
|
@@ -22,7 +22,7 @@ export class CredentialsClient {
|
|
|
22
22
|
/**
|
|
23
23
|
* Get the details of a client credential.
|
|
24
24
|
*
|
|
25
|
-
*
|
|
25
|
+
* **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
|
|
26
26
|
*
|
|
27
27
|
* @param {string} client_id - ID of the client.
|
|
28
28
|
* @param {CredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -81,37 +81,61 @@ export class CredentialsClient {
|
|
|
81
81
|
/**
|
|
82
82
|
* Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
* **Public Key**
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
* Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
|
|
87
|
+
*
|
|
88
|
+
* Sample:
|
|
89
|
+
*
|
|
90
|
+
* ```json
|
|
91
|
+
* {
|
|
87
92
|
* "credential_type": "public_key",
|
|
88
93
|
* "name": "string",
|
|
89
94
|
* "pem": "string",
|
|
90
95
|
* "alg": "RS256",
|
|
91
96
|
* "parse_expiry_from_cert": false,
|
|
92
97
|
* "expires_at": "2022-12-31T23:59:59Z"
|
|
93
|
-
* }
|
|
94
|
-
*
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* **Certificate (CA-signed & self-signed)**
|
|
102
|
+
*
|
|
103
|
+
* Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
|
|
104
|
+
*
|
|
105
|
+
* CA-signed Certificate Sample (pem):
|
|
95
106
|
*
|
|
96
|
-
*
|
|
107
|
+
* ```json
|
|
108
|
+
* {
|
|
97
109
|
* "credential_type": "x509_cert",
|
|
98
110
|
* "name": "string",
|
|
99
111
|
* "pem": "string"
|
|
100
|
-
* }
|
|
112
|
+
* }
|
|
113
|
+
* ```
|
|
114
|
+
*
|
|
115
|
+
* CA-signed Certificate Sample (subject_dn):
|
|
116
|
+
*
|
|
117
|
+
* ```json
|
|
118
|
+
* {
|
|
101
119
|
* "credential_type": "cert_subject_dn",
|
|
102
120
|
* "name": "string",
|
|
103
121
|
* "subject_dn": "string"
|
|
104
|
-
* }
|
|
122
|
+
* }
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
125
|
+
* Self-signed Certificate Sample:
|
|
126
|
+
*
|
|
127
|
+
* ```json
|
|
128
|
+
* {
|
|
105
129
|
* "credential_type": "cert_subject_dn",
|
|
106
130
|
* "name": "string",
|
|
107
131
|
* "pem": "string"
|
|
108
|
-
* }
|
|
132
|
+
* }
|
|
133
|
+
* ```
|
|
109
134
|
*
|
|
110
135
|
* The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* </ul>
|
|
136
|
+
*
|
|
137
|
+
* - To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
|
|
138
|
+
* - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
|
|
115
139
|
*
|
|
116
140
|
* @param {string} client_id - ID of the client.
|
|
117
141
|
* @param {Management.PostClientCredentialRequestContent} request
|
|
@@ -182,7 +206,7 @@ export class CredentialsClient {
|
|
|
182
206
|
/**
|
|
183
207
|
* Get the details of a client credential.
|
|
184
208
|
*
|
|
185
|
-
*
|
|
209
|
+
* **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
|
|
186
210
|
*
|
|
187
211
|
* @param {string} client_id - ID of the client.
|
|
188
212
|
* @param {string} credential_id - ID of the credential.
|
|
@@ -118,6 +118,7 @@ export declare class ConnectionProfilesClient {
|
|
|
118
118
|
* @throws {@link Management.BadRequestError}
|
|
119
119
|
* @throws {@link Management.UnauthorizedError}
|
|
120
120
|
* @throws {@link Management.ForbiddenError}
|
|
121
|
+
* @throws {@link Management.NotFoundError}
|
|
121
122
|
* @throws {@link Management.TooManyRequestsError}
|
|
122
123
|
*
|
|
123
124
|
* @example
|
|
@@ -408,6 +408,7 @@ export class ConnectionProfilesClient {
|
|
|
408
408
|
* @throws {@link Management.BadRequestError}
|
|
409
409
|
* @throws {@link Management.UnauthorizedError}
|
|
410
410
|
* @throws {@link Management.ForbiddenError}
|
|
411
|
+
* @throws {@link Management.NotFoundError}
|
|
411
412
|
* @throws {@link Management.TooManyRequestsError}
|
|
412
413
|
*
|
|
413
414
|
* @example
|
|
@@ -449,6 +450,8 @@ export class ConnectionProfilesClient {
|
|
|
449
450
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
450
451
|
case 403:
|
|
451
452
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
453
|
+
case 404:
|
|
454
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
452
455
|
case 429:
|
|
453
456
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
454
457
|
default:
|
|
@@ -20,6 +20,7 @@ export declare class UsersClient {
|
|
|
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
|
|
@@ -29,6 +29,7 @@ export class UsersClient {
|
|
|
29
29
|
* @throws {@link Management.BadRequestError}
|
|
30
30
|
* @throws {@link Management.UnauthorizedError}
|
|
31
31
|
* @throws {@link Management.ForbiddenError}
|
|
32
|
+
* @throws {@link Management.NotFoundError}
|
|
32
33
|
* @throws {@link Management.TooManyRequestsError}
|
|
33
34
|
*
|
|
34
35
|
* @example
|
|
@@ -74,6 +75,8 @@ export class UsersClient {
|
|
|
74
75
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
75
76
|
case 403:
|
|
76
77
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
78
|
+
case 404:
|
|
79
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
77
80
|
case 429:
|
|
78
81
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
79
82
|
default:
|
|
@@ -118,6 +118,7 @@ export declare class CustomDomainsClient {
|
|
|
118
118
|
* @throws {@link Management.BadRequestError}
|
|
119
119
|
* @throws {@link Management.UnauthorizedError}
|
|
120
120
|
* @throws {@link Management.ForbiddenError}
|
|
121
|
+
* @throws {@link Management.ConflictError}
|
|
121
122
|
* @throws {@link Management.TooManyRequestsError}
|
|
122
123
|
*
|
|
123
124
|
* @example
|
|
@@ -360,6 +360,7 @@ export class CustomDomainsClient {
|
|
|
360
360
|
* @throws {@link Management.BadRequestError}
|
|
361
361
|
* @throws {@link Management.UnauthorizedError}
|
|
362
362
|
* @throws {@link Management.ForbiddenError}
|
|
363
|
+
* @throws {@link Management.ConflictError}
|
|
363
364
|
* @throws {@link Management.TooManyRequestsError}
|
|
364
365
|
*
|
|
365
366
|
* @example
|
|
@@ -395,6 +396,8 @@ export class CustomDomainsClient {
|
|
|
395
396
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
396
397
|
case 403:
|
|
397
398
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
399
|
+
case 409:
|
|
400
|
+
throw new Management.ConflictError(_response.error.body, _response.rawResponse);
|
|
398
401
|
case 429:
|
|
399
402
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
400
403
|
default:
|
|
@@ -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.
|
|
@@ -20,7 +20,7 @@ export class ProviderClient {
|
|
|
20
20
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieve details of the
|
|
23
|
+
* 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.
|
|
24
24
|
*
|
|
25
25
|
* @param {Management.GetEmailProviderRequestParameters} request
|
|
26
26
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -95,48 +95,31 @@ export class ProviderClient {
|
|
|
95
95
|
});
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* Create an
|
|
99
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* <li>
|
|
115
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
116
|
-
* <code>smtp_pass</code>
|
|
117
|
-
* </li>
|
|
118
|
-
* </ul>
|
|
119
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
98
|
+
* Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
99
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
100
|
+
*
|
|
101
|
+
* - `mandrill` requires `api_key`
|
|
102
|
+
* - `sendgrid` requires `api_key`
|
|
103
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
104
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
105
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
106
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
107
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
108
|
+
* `null` are the only valid values for `region`.
|
|
109
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
110
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
111
|
+
* `smtp_pass`
|
|
112
|
+
*
|
|
113
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
120
114
|
* options, which will be used when sending an email:
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* <li>
|
|
130
|
-
* When using Sparkpost host, you may provide value for
|
|
131
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
132
|
-
* </li>
|
|
133
|
-
* </ul>
|
|
134
|
-
* </li>
|
|
135
|
-
* <li>
|
|
136
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
137
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
138
|
-
* </li>
|
|
139
|
-
* </ul>
|
|
115
|
+
*
|
|
116
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
117
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
118
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
119
|
+
* - When using Sparkpost host, you may provide value for
|
|
120
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
121
|
+
* - For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
122
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
140
123
|
*
|
|
141
124
|
* @param {Management.CreateEmailProviderRequestContent} request
|
|
142
125
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -266,46 +249,32 @@ export class ProviderClient {
|
|
|
266
249
|
});
|
|
267
250
|
}
|
|
268
251
|
/**
|
|
269
|
-
* Update an
|
|
270
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* <li>
|
|
286
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
287
|
-
* <code>smtp_pass</code>
|
|
288
|
-
* </li>
|
|
289
|
-
* </ul>
|
|
290
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
252
|
+
* Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
253
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
254
|
+
*
|
|
255
|
+
* - `mandrill` requires `api_key`
|
|
256
|
+
* - `sendgrid` requires `api_key`
|
|
257
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
258
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
259
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
260
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
261
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
262
|
+
* `null` are the only valid values for `region`.
|
|
263
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
264
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
265
|
+
* `smtp_pass`
|
|
266
|
+
*
|
|
267
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
291
268
|
* options, which will be used when sending an email:
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
*
|
|
300
|
-
*
|
|
301
|
-
* When using Sparkpost host, you may provide value for
|
|
302
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
303
|
-
* </li>
|
|
304
|
-
* </ul>
|
|
305
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
306
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
307
|
-
* </li>
|
|
308
|
-
* </ul>
|
|
269
|
+
*
|
|
270
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
271
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
272
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
273
|
+
* - When using Sparkpost host, you may provide value for
|
|
274
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
275
|
+
*
|
|
276
|
+
* For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
277
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
309
278
|
*
|
|
310
279
|
* @param {Management.UpdateEmailProviderRequestContent} request
|
|
311
280
|
* @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
|
|
@@ -29,6 +29,7 @@ export class MembersClient {
|
|
|
29
29
|
* @throws {@link Management.BadRequestError}
|
|
30
30
|
* @throws {@link Management.UnauthorizedError}
|
|
31
31
|
* @throws {@link Management.ForbiddenError}
|
|
32
|
+
* @throws {@link Management.NotFoundError}
|
|
32
33
|
* @throws {@link Management.TooManyRequestsError}
|
|
33
34
|
*
|
|
34
35
|
* @example
|
|
@@ -81,6 +82,8 @@ export class MembersClient {
|
|
|
81
82
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
82
83
|
case 403:
|
|
83
84
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
85
|
+
case 404:
|
|
86
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
84
87
|
case 429:
|
|
85
88
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
86
89
|
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
|