auth0 4.0.0-beta.5 → 4.0.0-beta.7
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/README.md +11 -8
- package/dist/{types → cjs}/auth/base-auth-api.d.ts +9 -2
- package/dist/cjs/auth/base-auth-api.js +47 -6
- package/dist/cjs/auth/base-auth-api.js.map +1 -1
- package/dist/{types → cjs}/auth/client-authentication.d.ts +1 -1
- package/dist/cjs/auth/client-authentication.js +2 -3
- package/dist/cjs/auth/client-authentication.js.map +1 -1
- package/dist/{types → cjs}/auth/database.d.ts +4 -0
- package/dist/cjs/auth/database.js.map +1 -1
- package/dist/cjs/auth/id-token-validator.js +14 -4
- package/dist/cjs/auth/id-token-validator.js.map +1 -1
- package/dist/{types → cjs}/auth/oauth.d.ts +10 -8
- package/dist/cjs/auth/oauth.js +8 -35
- package/dist/cjs/auth/oauth.js.map +1 -1
- package/dist/{types → cjs}/auth/passwordless.d.ts +1 -1
- package/dist/cjs/auth/passwordless.js +16 -8
- package/dist/cjs/auth/passwordless.js.map +1 -1
- package/dist/{types → cjs}/index.d.ts +2 -0
- package/dist/cjs/index.js +2 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/{types → cjs}/lib/retry.d.ts +1 -1
- package/dist/cjs/lib/retry.js +2 -4
- package/dist/cjs/lib/retry.js.map +1 -1
- package/dist/{types → cjs}/lib/runtime.d.ts +1 -10
- package/dist/cjs/lib/runtime.js +3 -23
- package/dist/cjs/lib/runtime.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/managers/attack-protection-manager.d.ts +0 -8
- package/dist/cjs/management/__generated/managers/attack-protection-manager.js +0 -12
- package/dist/cjs/management/__generated/managers/attack-protection-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/managers/clients-manager.d.ts +66 -11
- package/dist/cjs/management/__generated/managers/clients-manager.js +114 -10
- package/dist/cjs/management/__generated/managers/clients-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/managers/connections-manager.d.ts +16 -0
- package/dist/cjs/management/__generated/managers/connections-manager.js +8 -0
- package/dist/cjs/management/__generated/managers/connections-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/managers/hooks-manager.d.ts +2 -6
- package/dist/cjs/management/__generated/managers/hooks-manager.js +2 -2
- package/dist/cjs/management/__generated/managers/hooks-manager.js.map +1 -1
- package/dist/cjs/management/__generated/managers/jobs-manager.js +1 -1
- package/dist/cjs/management/__generated/managers/jobs-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/managers/roles-manager.d.ts +3 -3
- package/dist/cjs/management/__generated/managers/roles-manager.js +3 -3
- package/dist/cjs/management/__generated/managers/roles-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/managers/users-manager.d.ts +4 -8
- package/dist/cjs/management/__generated/managers/users-manager.js +1 -1
- package/dist/cjs/management/__generated/managers/users-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/models/index.d.ts +456 -37
- package/dist/cjs/management/__generated/models/index.js +73 -11
- package/dist/cjs/management/__generated/models/index.js.map +1 -1
- package/dist/cjs/userinfo/index.d.ts +55 -0
- package/dist/cjs/userinfo/index.js +72 -0
- package/dist/cjs/userinfo/index.js.map +1 -0
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +1 -1
- package/dist/esm/auth/base-auth-api.d.ts +39 -0
- package/dist/esm/auth/base-auth-api.js +46 -6
- package/dist/esm/auth/base-auth-api.js.map +1 -1
- package/dist/esm/auth/client-authentication.d.ts +26 -0
- package/dist/esm/auth/client-authentication.js +2 -3
- package/dist/esm/auth/client-authentication.js.map +1 -1
- package/dist/esm/auth/database.d.ts +157 -0
- package/dist/esm/auth/database.js.map +1 -1
- package/dist/esm/auth/id-token-validator.d.ts +18 -0
- package/dist/esm/auth/id-token-validator.js +14 -4
- package/dist/esm/auth/id-token-validator.js.map +1 -1
- package/dist/esm/auth/index.d.ts +15 -0
- package/dist/esm/auth/oauth.d.ts +297 -0
- package/dist/esm/auth/oauth.js +10 -37
- package/dist/esm/auth/oauth.js.map +1 -1
- package/dist/esm/auth/passwordless.d.ts +165 -0
- package/dist/esm/auth/passwordless.js +17 -9
- package/dist/esm/auth/passwordless.js.map +1 -1
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/lib/errors.d.ts +33 -0
- package/dist/esm/lib/index.d.ts +3 -0
- package/dist/esm/lib/middleware/telemetry-middleware.d.ts +12 -0
- package/dist/esm/lib/models.d.ts +123 -0
- package/dist/esm/lib/retry.d.ts +26 -0
- package/dist/esm/lib/retry.js +2 -4
- package/dist/esm/lib/retry.js.map +1 -1
- package/dist/esm/lib/runtime.d.ts +61 -0
- package/dist/esm/lib/runtime.js +2 -21
- package/dist/esm/lib/runtime.js.map +1 -1
- package/dist/esm/management/__generated/index.d.ts +39 -0
- package/dist/esm/management/__generated/managers/actions-manager.d.ts +136 -0
- package/dist/esm/management/__generated/managers/anomaly-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.d.ts +58 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.js +0 -12
- package/dist/esm/management/__generated/managers/attack-protection-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/blacklists-manager.d.ts +28 -0
- package/dist/esm/management/__generated/managers/branding-manager.d.ts +103 -0
- package/dist/esm/management/__generated/managers/client-grants-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/clients-manager.d.ts +168 -0
- package/dist/esm/management/__generated/managers/clients-manager.js +114 -10
- package/dist/esm/management/__generated/managers/clients-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/connections-manager.d.ts +87 -0
- package/dist/esm/management/__generated/managers/connections-manager.js +8 -0
- package/dist/esm/management/__generated/managers/connections-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/custom-domains-manager.d.ts +106 -0
- package/dist/esm/management/__generated/managers/device-credentials-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/email-templates-manager.d.ts +38 -0
- package/dist/esm/management/__generated/managers/emails-manager.d.ts +40 -0
- package/dist/esm/management/__generated/managers/grants-manager.d.ts +34 -0
- package/dist/esm/management/__generated/managers/guardian-manager.d.ts +240 -0
- package/dist/esm/management/__generated/managers/hooks-manager.d.ts +90 -0
- package/dist/esm/management/__generated/managers/hooks-manager.js +2 -2
- package/dist/esm/management/__generated/managers/hooks-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/index.d.ts +31 -0
- package/dist/esm/management/__generated/managers/jobs-manager.d.ts +47 -0
- package/dist/esm/management/__generated/managers/jobs-manager.js +1 -1
- package/dist/esm/management/__generated/managers/jobs-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/keys-manager.d.ts +34 -0
- package/dist/esm/management/__generated/managers/log-streams-manager.d.ts +326 -0
- package/dist/esm/management/__generated/managers/logs-manager.d.ts +56 -0
- package/dist/esm/management/__generated/managers/organizations-manager.d.ts +191 -0
- package/dist/esm/management/__generated/managers/prompts-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/resource-servers-manager.d.ts +48 -0
- package/dist/esm/management/__generated/managers/roles-manager.d.ts +110 -0
- package/dist/esm/management/__generated/managers/roles-manager.js +3 -3
- package/dist/esm/management/__generated/managers/roles-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/rules-configs-manager.d.ts +33 -0
- package/dist/esm/management/__generated/managers/rules-manager.d.ts +55 -0
- package/dist/esm/management/__generated/managers/stats-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/tenants-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/tickets-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/user-blocks-manager.d.ts +45 -0
- package/dist/esm/management/__generated/managers/users-by-email-manager.d.ts +22 -0
- package/dist/esm/management/__generated/managers/users-manager.d.ts +329 -0
- package/dist/esm/management/__generated/managers/users-manager.js +1 -1
- package/dist/esm/management/__generated/managers/users-manager.js.map +1 -1
- package/dist/esm/management/__generated/models/index.d.ts +13201 -0
- package/dist/esm/management/__generated/models/index.js +69 -7
- package/dist/esm/management/__generated/models/index.js.map +1 -1
- package/dist/esm/management/index.d.ts +3 -0
- package/dist/esm/management/management-client-options.d.ts +17 -0
- package/dist/esm/management/management-client.d.ts +16 -0
- package/dist/esm/management/token-provider-middleware.d.ts +7 -0
- package/dist/esm/management/token-provider.d.ts +21 -0
- package/dist/esm/userinfo/index.d.ts +55 -0
- package/dist/esm/userinfo/index.js +66 -0
- package/dist/esm/userinfo/index.js.map +1 -0
- package/dist/esm/utils.d.ts +10 -0
- package/dist/esm/version.d.ts +1 -0
- package/dist/esm/version.js +1 -1
- package/package.json +16 -20
- package/dist/types/version.d.ts +0 -1
- /package/dist/{types → cjs}/auth/id-token-validator.d.ts +0 -0
- /package/dist/{types → cjs}/auth/index.d.ts +0 -0
- /package/dist/{types → cjs}/lib/errors.d.ts +0 -0
- /package/dist/{types → cjs}/lib/index.d.ts +0 -0
- /package/dist/{types → cjs}/lib/middleware/telemetry-middleware.d.ts +0 -0
- /package/dist/{types → cjs}/lib/models.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/index.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/actions-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/anomaly-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/blacklists-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/branding-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/client-grants-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/custom-domains-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/device-credentials-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/email-templates-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/emails-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/grants-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/guardian-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/index.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/jobs-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/keys-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/log-streams-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/logs-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/organizations-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/prompts-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/resource-servers-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/rules-configs-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/rules-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/stats-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/tenants-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/tickets-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/user-blocks-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/users-by-email-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/index.d.ts +0 -0
- /package/dist/{types → cjs}/management/management-client-options.d.ts +0 -0
- /package/dist/{types → cjs}/management/management-client.d.ts +0 -0
- /package/dist/{types → cjs}/management/token-provider-middleware.d.ts +0 -0
- /package/dist/{types → cjs}/management/token-provider.d.ts +0 -0
- /package/dist/{types → cjs}/utils.d.ts +0 -0
|
@@ -28,18 +28,6 @@ export class AttackProtectionManager extends BaseAPI {
|
|
|
28
28
|
}, initOverrides);
|
|
29
29
|
return runtime.JSONApiResponse.fromResponse(response);
|
|
30
30
|
}
|
|
31
|
-
/**
|
|
32
|
-
* Get the brute force configuration defaults
|
|
33
|
-
*
|
|
34
|
-
* @throws {RequiredError}
|
|
35
|
-
*/
|
|
36
|
-
async getBruteForceDefaults(initOverrides) {
|
|
37
|
-
const response = await this.request({
|
|
38
|
-
path: `/attack-protection/brute-force-protection/defaults`,
|
|
39
|
-
method: 'GET',
|
|
40
|
-
}, initOverrides);
|
|
41
|
-
return runtime.JSONApiResponse.fromResponse(response);
|
|
42
|
-
}
|
|
43
31
|
/**
|
|
44
32
|
* Get the suspicious IP throttling configuration
|
|
45
33
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attack-protection-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/attack-protection-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAQnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,OAAO;IAClD;;;;OAIG;IACH,KAAK,CAAC,kCAAkC,CACtC,aAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,aAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC
|
|
1
|
+
{"version":3,"file":"attack-protection-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/attack-protection-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAQnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,OAAO;IAClD;;;;OAIG;IACH,KAAK,CAAC,kCAAkC,CACtC,aAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,aAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,+BAA+B,CACnC,aAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qCAAqC,CACzC,cAAqD,EACrD,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB,CAC1B,cAAgD,EAChD,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kCAAkC,CACtC,cAAkD,EAClD,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAM,QAAQ,CAAC,CAAC;IAC7D,CAAC;CACF"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Token, GetTokensRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class BlacklistsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve the `jti` and `aud` of all tokens that are blacklisted.
|
|
11
|
+
*
|
|
12
|
+
* Note: The <a href="https://auth0.com/docs/jwt">JWT specification</a> states that the `jti` field can be used to prevent replay attacks. Though Auth0 tokens do not include a `jti`, you can nevertheless blacklist a `jti` to prevent a token being used more than a predetermined number of times. This behavior is similar to implementing a nonce (where the token's signature can be thought of as the nonce). If a token gets stolen, it (or the tokens issued after it) should be blacklisted and let expire.
|
|
13
|
+
*
|
|
14
|
+
* Get blacklisted tokens
|
|
15
|
+
*
|
|
16
|
+
* @throws {RequiredError}
|
|
17
|
+
*/
|
|
18
|
+
getAll(requestParameters?: GetTokensRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Token>>>;
|
|
19
|
+
/**
|
|
20
|
+
* Add the token identified by the `jti` to a blacklist for the tenant.
|
|
21
|
+
*
|
|
22
|
+
* Blacklist a token
|
|
23
|
+
*
|
|
24
|
+
* @throws {RequiredError}
|
|
25
|
+
*/
|
|
26
|
+
add(bodyParameters: Token, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
27
|
+
}
|
|
28
|
+
export {};
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { GetBranding200Response, GetUniversalLogin200Response, PatchBrandingRequest, PostBrandingTheme200Response, PostBrandingThemeRequest, PutUniversalLoginRequest, DeleteBrandingThemeRequest, GetBrandingThemeRequest, PatchBrandingThemeRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class BrandingManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete branding theme.
|
|
11
|
+
* Delete branding theme
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
deleteTheme(requestParameters: DeleteBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Delete template for New Universal Login Experience
|
|
18
|
+
*
|
|
19
|
+
* @throws {RequiredError}
|
|
20
|
+
*/
|
|
21
|
+
deleteUniversalLoginTemplate(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve branding settings.
|
|
24
|
+
* Get branding settings
|
|
25
|
+
*
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
getSettings(initOverrides?: InitOverride): Promise<ApiResponse<GetBranding200Response>>;
|
|
29
|
+
/**
|
|
30
|
+
* Retrieve branding theme.
|
|
31
|
+
* Get branding theme
|
|
32
|
+
*
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
getTheme(requestParameters: GetBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
36
|
+
/**
|
|
37
|
+
* Retrieve default branding theme.
|
|
38
|
+
* Get default branding theme
|
|
39
|
+
*
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
getDefaultTheme(initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
43
|
+
/**
|
|
44
|
+
* Get template for New Universal Login Experience
|
|
45
|
+
*
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getUniversalLoginTemplate(initOverrides?: InitOverride): Promise<ApiResponse<GetUniversalLogin200Response>>;
|
|
49
|
+
/**
|
|
50
|
+
* Update branding settings.
|
|
51
|
+
* Update branding settings
|
|
52
|
+
*
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
updateSettings(bodyParameters: PatchBrandingRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetBranding200Response>>;
|
|
56
|
+
/**
|
|
57
|
+
* Update branding theme.
|
|
58
|
+
* Update branding theme
|
|
59
|
+
*
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
updateTheme(requestParameters: PatchBrandingThemeRequest, bodyParameters: PostBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
63
|
+
/**
|
|
64
|
+
* Create branding theme.
|
|
65
|
+
* Create branding theme
|
|
66
|
+
*
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
createTheme(bodyParameters: PostBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
70
|
+
/**
|
|
71
|
+
* Update the Universal Login branding template.
|
|
72
|
+
*
|
|
73
|
+
* <p>When <code>content-type</code> header is set to <code>application/json</code>, the expected body must be JSON:</p>
|
|
74
|
+
* <pre>
|
|
75
|
+
* {
|
|
76
|
+
* "template": "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>"
|
|
77
|
+
* }
|
|
78
|
+
* </pre>
|
|
79
|
+
*
|
|
80
|
+
* <p>
|
|
81
|
+
* When <code>content-type</code> header is set to <code>text/html</code>, the expected body must be the HTML template:
|
|
82
|
+
* </p>
|
|
83
|
+
* <pre>
|
|
84
|
+
* <!DOCTYPE html>
|
|
85
|
+
* <code>
|
|
86
|
+
* <html>
|
|
87
|
+
* <head>
|
|
88
|
+
* {%- auth0:head -%}
|
|
89
|
+
* </head>
|
|
90
|
+
* <body>
|
|
91
|
+
* {%- auth0:widget -%}
|
|
92
|
+
* </body>
|
|
93
|
+
* </html>
|
|
94
|
+
* </code>
|
|
95
|
+
* </pre>
|
|
96
|
+
*
|
|
97
|
+
* Set template for New Universal Login Experience
|
|
98
|
+
*
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
setUniversalLoginTemplate(bodyParameters: PutUniversalLoginRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
102
|
+
}
|
|
103
|
+
export {};
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { ClientGrant, ClientGrantCreate, PatchClientGrantsByIdRequest, GetClientGrants200ResponseOneOf, DeleteClientGrantsByIdRequest, GetClientGrantsRequest, PatchClientGrantsByIdOperationRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ClientGrantsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a client grant.
|
|
11
|
+
* Delete client grant
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteClientGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve <a href="https://auth0.com/docs/api-auth/grant/client-credentials">client grants</a>.
|
|
18
|
+
*
|
|
19
|
+
* Get client grants
|
|
20
|
+
*
|
|
21
|
+
* @throws {RequiredError}
|
|
22
|
+
*/
|
|
23
|
+
getAll(requestParameters: GetClientGrantsRequest & {
|
|
24
|
+
include_totals: true;
|
|
25
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetClientGrants200ResponseOneOf>>;
|
|
26
|
+
getAll(requestParameters?: GetClientGrantsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<ClientGrant>>>;
|
|
27
|
+
/**
|
|
28
|
+
* Update a client grant.
|
|
29
|
+
* Update client grant
|
|
30
|
+
*
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
update(requestParameters: PatchClientGrantsByIdOperationRequest, bodyParameters: PatchClientGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<ClientGrant>>;
|
|
34
|
+
/**
|
|
35
|
+
* Create a client grant.
|
|
36
|
+
* Create client grant
|
|
37
|
+
*
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
create(bodyParameters: ClientGrantCreate, initOverrides?: InitOverride): Promise<ApiResponse<ClientGrant>>;
|
|
41
|
+
}
|
|
42
|
+
export {};
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Client, ClientCreate, ClientUpdate, GetCredentials200ResponseInner, PatchCredentialsByCredentialIdRequest, PostCredentialsRequest, DeleteClientsByIdRequest, DeleteCredentialsByCredentialIdRequest, GetClientsRequest, GetClientsByIdRequest, GetCredentialsRequest, GetCredentialsByCredentialIdRequest, PatchClientsByIdRequest, PatchCredentialsByCredentialIdOperationRequest, PostCredentialsOperationRequest, PostRotateSecretRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ClientsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a client and related configuration (rules, connections, etc).
|
|
11
|
+
* Delete a client
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Delete a client credential
|
|
18
|
+
*
|
|
19
|
+
* @throws {RequiredError}
|
|
20
|
+
*/
|
|
21
|
+
deleteCredential(requestParameters: DeleteCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude
|
|
24
|
+
* may also be specified. Note:
|
|
25
|
+
* <ul>
|
|
26
|
+
* <li><code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
27
|
+
* any scope.
|
|
28
|
+
* </li>
|
|
29
|
+
* <li><code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
30
|
+
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
31
|
+
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
32
|
+
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
33
|
+
* <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
|
|
34
|
+
* <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
|
|
35
|
+
* <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
|
|
36
|
+
* <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
|
|
37
|
+
* <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
|
|
38
|
+
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
39
|
+
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
40
|
+
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
41
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
42
|
+
* <code>organization_require_behavior</code>
|
|
43
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
44
|
+
* <code>read:client_keys</code> scope.
|
|
45
|
+
* </li>
|
|
46
|
+
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
47
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
48
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
49
|
+
* </li>
|
|
50
|
+
* </ul>
|
|
51
|
+
*
|
|
52
|
+
* Get clients
|
|
53
|
+
*
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
getAll(requestParameters?: GetClientsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Client>>>;
|
|
57
|
+
/**
|
|
58
|
+
* Retrieve client details. A list of fields to include or exclude may also be specified. Note:
|
|
59
|
+
* <ul>
|
|
60
|
+
* <li><code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
61
|
+
* the any of the scopes.
|
|
62
|
+
* </li>
|
|
63
|
+
* <li><code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
64
|
+
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
65
|
+
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
66
|
+
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
67
|
+
* <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
|
|
68
|
+
* <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
|
|
69
|
+
* <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
|
|
70
|
+
* <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
|
|
71
|
+
* <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
|
|
72
|
+
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
73
|
+
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
74
|
+
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
75
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
76
|
+
* <code>organization_require_behavior</code>
|
|
77
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
78
|
+
* <code>read:client_keys</code> scope.
|
|
79
|
+
* </li>
|
|
80
|
+
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
81
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
82
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
83
|
+
* </li>
|
|
84
|
+
* </ul>
|
|
85
|
+
*
|
|
86
|
+
* Get a client
|
|
87
|
+
*
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
get(requestParameters: GetClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
91
|
+
/**
|
|
92
|
+
* Get the list of client credentials that are associated to the client.
|
|
93
|
+
*
|
|
94
|
+
* Important: To enable credentials to be used for Private Key JWT authentication method, set the <code>client_authentication_methods</code> property on the client.
|
|
95
|
+
* Get client credentials
|
|
96
|
+
*
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
getCredentials(requestParameters: GetCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetCredentials200ResponseInner>>>;
|
|
100
|
+
/**
|
|
101
|
+
* Get the details of a client credential.
|
|
102
|
+
* Get client credential
|
|
103
|
+
*
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
getCredential(requestParameters: GetCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
|
|
107
|
+
/**
|
|
108
|
+
* Notes:
|
|
109
|
+
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
110
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
111
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
112
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
113
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, only specify the credential IDs
|
|
114
|
+
* that were generated when creating the credentials on the client.
|
|
115
|
+
* - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
|
|
116
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
117
|
+
* Update a client
|
|
118
|
+
*
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
update(requestParameters: PatchClientsByIdRequest, bodyParameters: ClientUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
122
|
+
/**
|
|
123
|
+
* Update a client credential
|
|
124
|
+
*
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
updateCredential(requestParameters: PatchCredentialsByCredentialIdOperationRequest, bodyParameters: PatchCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
|
|
128
|
+
/**
|
|
129
|
+
* Create a new client (application or SSO integration).
|
|
130
|
+
*
|
|
131
|
+
* Notes:
|
|
132
|
+
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
133
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
134
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
135
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
136
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
137
|
+
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
138
|
+
* - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
|
|
139
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
140
|
+
*
|
|
141
|
+
* <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
|
|
142
|
+
*
|
|
143
|
+
* Create a client
|
|
144
|
+
*
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
create(bodyParameters: ClientCreate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
148
|
+
/**
|
|
149
|
+
* Create a client credential associated to the client. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the <code>client_authentication_methods</code> property on the client.
|
|
150
|
+
* Create a client credential
|
|
151
|
+
*
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
*/
|
|
154
|
+
createCredential(requestParameters: PostCredentialsOperationRequest, bodyParameters: PostCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
|
|
155
|
+
/**
|
|
156
|
+
* Rotate a client secret.
|
|
157
|
+
*
|
|
158
|
+
* This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt).
|
|
159
|
+
*
|
|
160
|
+
* Note: The generated secret is NOT base64 encoded.
|
|
161
|
+
*
|
|
162
|
+
* Rotate a client secret
|
|
163
|
+
*
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
rotateClientSecret(requestParameters: PostRotateSecretRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
167
|
+
}
|
|
168
|
+
export {};
|
|
@@ -18,6 +18,21 @@ export class ClientsManager extends BaseAPI {
|
|
|
18
18
|
}, initOverrides);
|
|
19
19
|
return runtime.VoidApiResponse.fromResponse(response);
|
|
20
20
|
}
|
|
21
|
+
/**
|
|
22
|
+
* Delete a client credential
|
|
23
|
+
*
|
|
24
|
+
* @throws {RequiredError}
|
|
25
|
+
*/
|
|
26
|
+
async deleteCredential(requestParameters, initOverrides) {
|
|
27
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id', 'credential_id']);
|
|
28
|
+
const response = await this.request({
|
|
29
|
+
path: `/clients/{client_id}/credentials/{credential_id}`
|
|
30
|
+
.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id)))
|
|
31
|
+
.replace('{credential_id}', encodeURIComponent(String(requestParameters.credential_id))),
|
|
32
|
+
method: 'DELETE',
|
|
33
|
+
}, initOverrides);
|
|
34
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
35
|
+
}
|
|
21
36
|
/**
|
|
22
37
|
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude
|
|
23
38
|
* may also be specified. Note:
|
|
@@ -37,13 +52,14 @@ export class ClientsManager extends BaseAPI {
|
|
|
37
52
|
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
38
53
|
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
39
54
|
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
40
|
-
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
41
|
-
* <code>organization_require_behavior</code>
|
|
55
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
56
|
+
* <code>organization_require_behavior</code>
|
|
57
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
42
58
|
* <code>read:client_keys</code> scope.
|
|
43
59
|
* </li>
|
|
44
60
|
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
45
|
-
* <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
|
|
46
|
-
* <code>read:client_keys</code> scope.
|
|
61
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
62
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
47
63
|
* </li>
|
|
48
64
|
* </ul>
|
|
49
65
|
*
|
|
@@ -111,13 +127,14 @@ export class ClientsManager extends BaseAPI {
|
|
|
111
127
|
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
112
128
|
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
113
129
|
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
114
|
-
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
115
|
-
* <code>organization_require_behavior</code>
|
|
130
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
131
|
+
* <code>organization_require_behavior</code>
|
|
132
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
116
133
|
* <code>read:client_keys</code> scope.
|
|
117
134
|
* </li>
|
|
118
135
|
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
119
|
-
* <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
|
|
120
|
-
* <code>read:client_keys</code> scope.
|
|
136
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
137
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
121
138
|
* </li>
|
|
122
139
|
* </ul>
|
|
123
140
|
*
|
|
@@ -145,7 +162,47 @@ export class ClientsManager extends BaseAPI {
|
|
|
145
162
|
return runtime.JSONApiResponse.fromResponse(response);
|
|
146
163
|
}
|
|
147
164
|
/**
|
|
148
|
-
*
|
|
165
|
+
* Get the list of client credentials that are associated to the client.
|
|
166
|
+
*
|
|
167
|
+
* Important: To enable credentials to be used for Private Key JWT authentication method, set the <code>client_authentication_methods</code> property on the client.
|
|
168
|
+
* Get client credentials
|
|
169
|
+
*
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
async getCredentials(requestParameters, initOverrides) {
|
|
173
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
174
|
+
const response = await this.request({
|
|
175
|
+
path: `/clients/{client_id}/credentials`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
176
|
+
method: 'GET',
|
|
177
|
+
}, initOverrides);
|
|
178
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Get the details of a client credential.
|
|
182
|
+
* Get client credential
|
|
183
|
+
*
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
async getCredential(requestParameters, initOverrides) {
|
|
187
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id', 'credential_id']);
|
|
188
|
+
const response = await this.request({
|
|
189
|
+
path: `/clients/{client_id}/credentials/{credential_id}`
|
|
190
|
+
.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id)))
|
|
191
|
+
.replace('{credential_id}', encodeURIComponent(String(requestParameters.credential_id))),
|
|
192
|
+
method: 'GET',
|
|
193
|
+
}, initOverrides);
|
|
194
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Notes:
|
|
198
|
+
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
199
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
200
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
201
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
202
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, only specify the credential IDs
|
|
203
|
+
* that were generated when creating the credentials on the client.
|
|
204
|
+
* - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
|
|
205
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
149
206
|
* Update a client
|
|
150
207
|
*
|
|
151
208
|
* @throws {RequiredError}
|
|
@@ -162,10 +219,37 @@ export class ClientsManager extends BaseAPI {
|
|
|
162
219
|
}, initOverrides);
|
|
163
220
|
return runtime.JSONApiResponse.fromResponse(response);
|
|
164
221
|
}
|
|
222
|
+
/**
|
|
223
|
+
* Update a client credential
|
|
224
|
+
*
|
|
225
|
+
* @throws {RequiredError}
|
|
226
|
+
*/
|
|
227
|
+
async updateCredential(requestParameters, bodyParameters, initOverrides) {
|
|
228
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id', 'credential_id']);
|
|
229
|
+
const headerParameters = {};
|
|
230
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
231
|
+
const response = await this.request({
|
|
232
|
+
path: `/clients/{client_id}/credentials/{credential_id}`
|
|
233
|
+
.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id)))
|
|
234
|
+
.replace('{credential_id}', encodeURIComponent(String(requestParameters.credential_id))),
|
|
235
|
+
method: 'PATCH',
|
|
236
|
+
headers: headerParameters,
|
|
237
|
+
body: bodyParameters,
|
|
238
|
+
}, initOverrides);
|
|
239
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
240
|
+
}
|
|
165
241
|
/**
|
|
166
242
|
* Create a new client (application or SSO integration).
|
|
167
243
|
*
|
|
168
|
-
*
|
|
244
|
+
* Notes:
|
|
245
|
+
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
246
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
247
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
248
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
249
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
250
|
+
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
251
|
+
* - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
|
|
252
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
169
253
|
*
|
|
170
254
|
* <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
|
|
171
255
|
*
|
|
@@ -184,9 +268,29 @@ export class ClientsManager extends BaseAPI {
|
|
|
184
268
|
}, initOverrides);
|
|
185
269
|
return runtime.JSONApiResponse.fromResponse(response);
|
|
186
270
|
}
|
|
271
|
+
/**
|
|
272
|
+
* Create a client credential associated to the client. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the <code>client_authentication_methods</code> property on the client.
|
|
273
|
+
* Create a client credential
|
|
274
|
+
*
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
async createCredential(requestParameters, bodyParameters, initOverrides) {
|
|
278
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
279
|
+
const headerParameters = {};
|
|
280
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
281
|
+
const response = await this.request({
|
|
282
|
+
path: `/clients/{client_id}/credentials`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
283
|
+
method: 'POST',
|
|
284
|
+
headers: headerParameters,
|
|
285
|
+
body: bodyParameters,
|
|
286
|
+
}, initOverrides);
|
|
287
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
288
|
+
}
|
|
187
289
|
/**
|
|
188
290
|
* Rotate a client secret.
|
|
189
291
|
*
|
|
292
|
+
* This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt).
|
|
293
|
+
*
|
|
190
294
|
* Note: The generated secret is NOT base64 encoded.
|
|
191
295
|
*
|
|
192
296
|
* Rotate a client secret
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clients-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/clients-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"clients-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/clients-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAqBnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,OAAO;IACzC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,iBAA2C,EAC3C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACvF,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAyD,EACzD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kDAAkD;iBACrD,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC/E,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,MAAM,CACV,oBAAuC,EAAE,EACzC,aAA4B;QAE5B,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,GAAG,CACP,iBAAwC,EACxC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACvF,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAClB,iBAAwC,EACxC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kCAAkC,CAAC,OAAO,CAC9C,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,iBAAsD,EACtD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kDAAkD;iBACrD,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC/E,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACV,iBAA0C,EAC1C,cAA4B,EAC5B,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACvF,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAiE,EACjE,cAAqD,EACrD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAEzF,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kDAAkD;iBACrD,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC/E,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,cAA4B,EAC5B,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAkD,EAClD,cAAsC,EACtC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kCAAkC,CAAC,OAAO,CAC9C,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,kBAAkB,CACtB,iBAA0C,EAC1C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,6BAA6B,CAAC,OAAO,CACzC,MAAM,EACN,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CACjD;YACD,MAAM,EAAE,MAAM;SACf,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}
|