auth0 5.11.0 → 5.13.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/models.d.ts +7 -7
- 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 +28 -4
- package/dist/cjs/management/api/resources/attackProtection/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/attackProtection/client/Client.js +7 -2
- package/dist/cjs/management/api/resources/attackProtection/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/attackProtection/resources/phoneProviderProtection/client/Client.d.ts +45 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/phoneProviderProtection/client/Client.js +180 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/phoneProviderProtection/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/phoneProviderProtection/client/index.js +2 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/phoneProviderProtection/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/phoneProviderProtection/index.js +17 -0
- 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 +69 -85
- package/dist/cjs/management/api/resources/clients/client/Client.js +71 -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/emailTemplates/client/Client.d.ts +4 -4
- package/dist/cjs/management/api/resources/emailTemplates/client/Client.js +4 -4
- 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/keys/resources/signing/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/keys/resources/signing/client/Client.js +3 -0
- 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/connectedAccounts/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/connectedAccounts/client/Client.js +3 -0
- 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 +281 -109
- package/dist/cjs/management/api/types/types.js +36 -46
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/lib/models.d.mts +7 -7
- 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 +28 -4
- package/dist/esm/management/api/resources/attackProtection/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/attackProtection/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/attackProtection/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/phoneProviderProtection/client/Client.d.mts +45 -0
- package/dist/esm/management/api/resources/attackProtection/resources/phoneProviderProtection/client/Client.mjs +143 -0
- package/dist/esm/management/api/resources/attackProtection/resources/phoneProviderProtection/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/phoneProviderProtection/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/phoneProviderProtection/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/phoneProviderProtection/index.mjs +1 -0
- 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 +69 -85
- package/dist/esm/management/api/resources/clients/client/Client.mjs +71 -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/emailTemplates/client/Client.d.mts +4 -4
- package/dist/esm/management/api/resources/emailTemplates/client/Client.mjs +4 -4
- 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/keys/resources/signing/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/keys/resources/signing/client/Client.mjs +3 -0
- 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/connectedAccounts/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/connectedAccounts/client/Client.mjs +3 -0
- 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 +281 -109
- package/dist/esm/management/api/types/types.mjs +23 -33
- 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 +349 -265
|
@@ -56,7 +56,7 @@ class ProvidersClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve a list of
|
|
59
|
+
* Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
|
|
60
60
|
*
|
|
61
61
|
* @param {Management.ListBrandingPhoneProvidersRequestParameters} request
|
|
62
62
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -126,8 +126,8 @@ class ProvidersClient {
|
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
|
-
* Create a
|
|
130
|
-
* The
|
|
129
|
+
* Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
|
|
130
|
+
* The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
|
|
131
131
|
*
|
|
132
132
|
* @param {Management.CreateBrandingPhoneProviderRequestContent} request
|
|
133
133
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -198,7 +198,7 @@ class ProvidersClient {
|
|
|
198
198
|
});
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* Retrieve
|
|
201
|
+
* Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
|
|
202
202
|
*
|
|
203
203
|
* @param {string} id
|
|
204
204
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -318,8 +318,8 @@ class ProvidersClient {
|
|
|
318
318
|
});
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
|
-
* Update a
|
|
322
|
-
* The
|
|
321
|
+
* Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
|
|
322
|
+
* The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
|
|
323
323
|
*
|
|
324
324
|
* @param {string} id
|
|
325
325
|
* @param {Management.UpdateBrandingPhoneProviderRequestContent} request
|
|
@@ -14,7 +14,7 @@ export declare class ClientGrantsClient {
|
|
|
14
14
|
constructor(options: ClientGrantsClient.Options);
|
|
15
15
|
get organizations(): OrganizationsClient;
|
|
16
16
|
/**
|
|
17
|
-
* Retrieve a list of
|
|
17
|
+
* Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
|
|
18
18
|
*
|
|
19
19
|
* @param {Management.ListClientGrantsRequestParameters} request
|
|
20
20
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -36,7 +36,7 @@ export declare class ClientGrantsClient {
|
|
|
36
36
|
*/
|
|
37
37
|
list(request?: Management.ListClientGrantsRequestParameters, requestOptions?: ClientGrantsClient.RequestOptions): Promise<core.Page<Management.ClientGrantResponseContent, Management.ListClientGrantPaginatedResponseContent>>;
|
|
38
38
|
/**
|
|
39
|
-
* Create a client grant for a machine-to-machine login flow. To learn more, read
|
|
39
|
+
* Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
|
|
40
40
|
*
|
|
41
41
|
* @param {Management.CreateClientGrantRequestContent} request
|
|
42
42
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ export declare class ClientGrantsClient {
|
|
|
56
56
|
create(request: Management.CreateClientGrantRequestContent, requestOptions?: ClientGrantsClient.RequestOptions): core.HttpResponsePromise<Management.CreateClientGrantResponseContent>;
|
|
57
57
|
private __create;
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve a single
|
|
59
|
+
* Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
|
|
60
60
|
* scopes associated with the application/API pair.
|
|
61
61
|
*
|
|
62
62
|
* @param {string} id - The ID of the client grant to retrieve.
|
|
@@ -73,7 +73,7 @@ export declare class ClientGrantsClient {
|
|
|
73
73
|
get(id: string, requestOptions?: ClientGrantsClient.RequestOptions): core.HttpResponsePromise<Management.GetClientGrantResponseContent>;
|
|
74
74
|
private __get;
|
|
75
75
|
/**
|
|
76
|
-
* Delete the
|
|
76
|
+
* Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
|
|
77
77
|
*
|
|
78
78
|
* @param {string} id - ID of the client grant to delete.
|
|
79
79
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -61,7 +61,7 @@ class ClientGrantsClient {
|
|
|
61
61
|
return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_js_1.OrganizationsClient(this._options)));
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* Retrieve a list of
|
|
64
|
+
* Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
|
|
65
65
|
*
|
|
66
66
|
* @param {Management.ListClientGrantsRequestParameters} request
|
|
67
67
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -149,7 +149,7 @@ class ClientGrantsClient {
|
|
|
149
149
|
});
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* Create a client grant for a machine-to-machine login flow. To learn more, read
|
|
152
|
+
* Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
|
|
153
153
|
*
|
|
154
154
|
* @param {Management.CreateClientGrantRequestContent} request
|
|
155
155
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -220,7 +220,7 @@ class ClientGrantsClient {
|
|
|
220
220
|
});
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* Retrieve a single
|
|
223
|
+
* Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
|
|
224
224
|
* scopes associated with the application/API pair.
|
|
225
225
|
*
|
|
226
226
|
* @param {string} id - The ID of the client grant to retrieve.
|
|
@@ -281,7 +281,7 @@ class ClientGrantsClient {
|
|
|
281
281
|
});
|
|
282
282
|
}
|
|
283
283
|
/**
|
|
284
|
-
* Delete the
|
|
284
|
+
* Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
|
|
285
285
|
*
|
|
286
286
|
* @param {string} id - ID of the client grant to delete.
|
|
287
287
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ export declare class OrganizationsClient {
|
|
|
18
18
|
* @throws {@link Management.BadRequestError}
|
|
19
19
|
* @throws {@link Management.UnauthorizedError}
|
|
20
20
|
* @throws {@link Management.ForbiddenError}
|
|
21
|
+
* @throws {@link Management.NotFoundError}
|
|
21
22
|
* @throws {@link Management.TooManyRequestsError}
|
|
22
23
|
*
|
|
23
24
|
* @example
|
package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js
CHANGED
|
@@ -63,6 +63,7 @@ class OrganizationsClient {
|
|
|
63
63
|
* @throws {@link Management.BadRequestError}
|
|
64
64
|
* @throws {@link Management.UnauthorizedError}
|
|
65
65
|
* @throws {@link Management.ForbiddenError}
|
|
66
|
+
* @throws {@link Management.NotFoundError}
|
|
66
67
|
* @throws {@link Management.TooManyRequestsError}
|
|
67
68
|
*
|
|
68
69
|
* @example
|
|
@@ -111,6 +112,8 @@ class OrganizationsClient {
|
|
|
111
112
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
112
113
|
case 403:
|
|
113
114
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
115
|
+
case 404:
|
|
116
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
114
117
|
case 429:
|
|
115
118
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
116
119
|
default:
|
|
@@ -18,38 +18,30 @@ export declare class ClientsClient {
|
|
|
18
18
|
get connections(): ConnectionsClient;
|
|
19
19
|
/**
|
|
20
20
|
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.
|
|
21
|
-
* For more information, read
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* The following properties can only be retrieved with the
|
|
48
|
-
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
|
|
49
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
50
|
-
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
|
|
51
|
-
* </li>
|
|
52
|
-
* </ul>
|
|
21
|
+
* For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
|
|
22
|
+
*
|
|
23
|
+
* - The following can be retrieved with any scope:
|
|
24
|
+
* `client_id`, `app_type`, `name`, and `description`.
|
|
25
|
+
* - The following properties can only be retrieved with the `read:clients` or
|
|
26
|
+
* `read:client_keys` scope:
|
|
27
|
+
* `callbacks`, `oidc_logout`, `allowed_origins`,
|
|
28
|
+
* `web_origins`, `tenant`, `global`, `config_route`,
|
|
29
|
+
* `callback_url_template`, `jwt_configuration`,
|
|
30
|
+
* `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
31
|
+
* `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
32
|
+
* `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
33
|
+
* `custom_login_page_off`, `sso`, `addons`, `form_template`,
|
|
34
|
+
* `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
35
|
+
* `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
36
|
+
* `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
37
|
+
* `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
|
|
38
|
+
* `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
|
|
39
|
+
* `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
|
|
40
|
+
* `organization_require_behavior`.
|
|
41
|
+
* - The following properties can only be retrieved with the
|
|
42
|
+
* `read:client_keys` or `read:client_credentials` scope:
|
|
43
|
+
* `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
|
|
44
|
+
* `client_secret`, `client_authentication_methods` and `signing_key`.
|
|
53
45
|
*
|
|
54
46
|
* @param {Management.ListClientsRequestParameters} request
|
|
55
47
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -75,20 +67,20 @@ export declare class ClientsClient {
|
|
|
75
67
|
*/
|
|
76
68
|
list(request?: Management.ListClientsRequestParameters, requestOptions?: ClientsClient.RequestOptions): Promise<core.Page<Management.Client, Management.ListClientsOffsetPaginatedResponseContent>>;
|
|
77
69
|
/**
|
|
78
|
-
* Create a new client (application or SSO integration). For more information, read
|
|
79
|
-
*
|
|
70
|
+
* Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications)
|
|
71
|
+
* [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
|
|
80
72
|
*
|
|
81
73
|
* Notes:
|
|
82
74
|
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
83
|
-
* - The
|
|
84
|
-
*
|
|
75
|
+
* - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
|
|
76
|
+
* `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method`
|
|
85
77
|
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
86
|
-
* - When using
|
|
78
|
+
* - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
87
79
|
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
88
|
-
* - To configure
|
|
89
|
-
* - To configure
|
|
80
|
+
* - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
|
|
81
|
+
* - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
|
|
90
82
|
*
|
|
91
|
-
*
|
|
83
|
+
* SSO Integrations created via this endpoint will accept login requests and share user profile information.
|
|
92
84
|
*
|
|
93
85
|
* @param {Management.CreateClientRequestContent} request
|
|
94
86
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -96,6 +88,7 @@ export declare class ClientsClient {
|
|
|
96
88
|
* @throws {@link Management.BadRequestError}
|
|
97
89
|
* @throws {@link Management.UnauthorizedError}
|
|
98
90
|
* @throws {@link Management.ForbiddenError}
|
|
91
|
+
* @throws {@link Management.NotFoundError}
|
|
99
92
|
* @throws {@link Management.ConflictError}
|
|
100
93
|
* @throws {@link Management.TooManyRequestsError}
|
|
101
94
|
*
|
|
@@ -133,16 +126,14 @@ export declare class ClientsClient {
|
|
|
133
126
|
* Idempotent registration for Client ID Metadata Document (CIMD) clients.
|
|
134
127
|
* Uses external_client_id as the unique identifier for upsert operations.
|
|
135
128
|
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
129
|
+
* **Create:** Returns 201 when a new client is created (requires `create:clients` scope).
|
|
130
|
+
* **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
|
|
138
131
|
*
|
|
139
132
|
* This endpoint automatically:
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
|
|
145
|
-
* </ul>
|
|
133
|
+
* - Fetches and validates the metadata document
|
|
134
|
+
* - Maps CIMD fields to Auth0 client configuration
|
|
135
|
+
* - Creates/rotates credentials from the JWKS
|
|
136
|
+
* - Enforces CIMD security policies (HTTPS-only, no shared secrets)
|
|
146
137
|
*
|
|
147
138
|
* @param {Management.RegisterCimdClientRequestContent} request
|
|
148
139
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -162,36 +153,29 @@ export declare class ClientsClient {
|
|
|
162
153
|
private __registerCimdClient;
|
|
163
154
|
/**
|
|
164
155
|
* Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.
|
|
165
|
-
* For more information, read
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
* </li>
|
|
189
|
-
* <li>
|
|
190
|
-
* The following properties can only be retrieved with the <code>read:client_keys</code> or <code>read:client_credentials</code> scopes:
|
|
191
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
192
|
-
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
|
|
193
|
-
* </li>
|
|
194
|
-
* </ul>
|
|
156
|
+
* For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
|
|
157
|
+
*
|
|
158
|
+
* - The following properties can be retrieved with any of the scopes:
|
|
159
|
+
* `client_id`, `app_type`, `name`, and `description`.
|
|
160
|
+
* - The following properties can only be retrieved with the `read:clients` or
|
|
161
|
+
* `read:client_keys` scopes:
|
|
162
|
+
* `callbacks`, `oidc_logout`, `allowed_origins`,
|
|
163
|
+
* `web_origins`, `tenant`, `global`, `config_route`,
|
|
164
|
+
* `callback_url_template`, `jwt_configuration`,
|
|
165
|
+
* `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
166
|
+
* `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
167
|
+
* `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
168
|
+
* `custom_login_page_off`, `sso`, `addons`, `form_template`,
|
|
169
|
+
* `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
170
|
+
* `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
171
|
+
* `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
172
|
+
* `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
|
|
173
|
+
* `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
|
|
174
|
+
* `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
|
|
175
|
+
* `organization_require_behavior`.
|
|
176
|
+
* - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes:
|
|
177
|
+
* `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
|
|
178
|
+
* `client_secret`, `client_authentication_methods` and `signing_key`.
|
|
195
179
|
*
|
|
196
180
|
* @param {string} id - ID of the client to retrieve.
|
|
197
181
|
* @param {Management.GetClientRequestParameters} request
|
|
@@ -228,15 +212,15 @@ export declare class ClientsClient {
|
|
|
228
212
|
delete(id: string, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
229
213
|
private __delete;
|
|
230
214
|
/**
|
|
231
|
-
* Updates a client's settings. For more information, read
|
|
215
|
+
* Updates a client's settings. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
|
|
232
216
|
*
|
|
233
217
|
* Notes:
|
|
234
218
|
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
235
|
-
* - The
|
|
236
|
-
* - When using
|
|
237
|
-
* - To configure
|
|
238
|
-
* - To configure
|
|
239
|
-
* - To change a client's
|
|
219
|
+
* - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
220
|
+
* - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
|
|
221
|
+
* - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
|
|
222
|
+
* - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
|
|
223
|
+
* - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
|
|
240
224
|
*
|
|
241
225
|
* @param {string} id - ID of the client to update.
|
|
242
226
|
* @param {Management.UpdateClientRequestContent} request
|
|
@@ -258,7 +242,7 @@ export declare class ClientsClient {
|
|
|
258
242
|
*
|
|
259
243
|
* This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
|
|
260
244
|
*
|
|
261
|
-
* For more information, read
|
|
245
|
+
* For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
|
|
262
246
|
*
|
|
263
247
|
* @param {string} id - ID of the client that will rotate secrets.
|
|
264
248
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|