@pulumi/keycloak 6.0.0 → 6.1.0-alpha.1737129047
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/authentication/execution.d.ts +1 -33
- package/authentication/execution.js +1 -33
- package/authentication/execution.js.map +1 -1
- package/authentication/subflow.d.ts +0 -23
- package/authentication/subflow.js +0 -23
- package/authentication/subflow.js.map +1 -1
- package/customUserFederation.d.ts +3 -3
- package/getClientDescriptionConverter.d.ts +2 -2
- package/getClientDescriptionConverter.js +2 -2
- package/group.d.ts +3 -3
- package/groupMemberships.d.ts +1 -1
- package/groupMemberships.js +1 -1
- package/ldap/groupMapper.d.ts +3 -3
- package/ldap/roleMapper.d.ts +3 -3
- package/oidc/googleIdentityProvider.d.ts +3 -3
- package/oidc/identityProvider.d.ts +9 -9
- package/openid/audienceProtocolMapper.d.ts +1 -1
- package/openid/audienceProtocolMapper.js +1 -1
- package/openid/client.d.ts +3 -3
- package/openid/userPropertyProtocolMapper.d.ts +3 -3
- package/openid/userSessionNoteProtocolMapper.d.ts +3 -3
- package/package.json +2 -2
- package/realm.d.ts +2 -2
- package/realm.js +2 -2
- package/realmUserProfile.d.ts +1 -90
- package/realmUserProfile.js +1 -90
- package/realmUserProfile.js.map +1 -1
- package/role.d.ts +1 -1
- package/role.js +1 -1
- package/saml/identityProvider.d.ts +6 -6
- package/types/input.d.ts +3 -3
- package/types/output.d.ts +3 -3
|
@@ -5,39 +5,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
5
5
|
* An authentication execution is an action that the user or service may or may not take when authenticating through an authentication
|
|
6
6
|
* flow.
|
|
7
7
|
*
|
|
8
|
-
* > Due to limitations in the Keycloak API, the ordering of authentication executions within a flow must be specified using `dependsOn`. Authentication executions that are created first will appear first within the flow.
|
|
9
|
-
*
|
|
10
|
-
* ## Example Usage
|
|
11
|
-
*
|
|
12
|
-
* ```typescript
|
|
13
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
14
|
-
* import * as keycloak from "@pulumi/keycloak";
|
|
15
|
-
*
|
|
16
|
-
* const realm = new keycloak.Realm("realm", {
|
|
17
|
-
* realm: "my-realm",
|
|
18
|
-
* enabled: true,
|
|
19
|
-
* });
|
|
20
|
-
* const flow = new keycloak.authentication.Flow("flow", {
|
|
21
|
-
* realmId: realm.id,
|
|
22
|
-
* alias: "my-flow-alias",
|
|
23
|
-
* });
|
|
24
|
-
* // first execution
|
|
25
|
-
* const executionOne = new keycloak.authentication.Execution("execution_one", {
|
|
26
|
-
* realmId: realm.id,
|
|
27
|
-
* parentFlowAlias: flow.alias,
|
|
28
|
-
* authenticator: "auth-cookie",
|
|
29
|
-
* requirement: "ALTERNATIVE",
|
|
30
|
-
* });
|
|
31
|
-
* // second execution
|
|
32
|
-
* const executionTwo = new keycloak.authentication.Execution("execution_two", {
|
|
33
|
-
* realmId: realm.id,
|
|
34
|
-
* parentFlowAlias: flow.alias,
|
|
35
|
-
* authenticator: "identity-provider-redirector",
|
|
36
|
-
* requirement: "ALTERNATIVE",
|
|
37
|
-
* }, {
|
|
38
|
-
* dependsOn: [executionOne],
|
|
39
|
-
* });
|
|
40
|
-
* ```
|
|
8
|
+
* > Following limitation affects Keycloak < 25: Due to limitations in the Keycloak API, the ordering of authentication executions within a flow must be specified using `dependsOn`. Authentication executions that are created first will appear first within the flow.
|
|
41
9
|
*
|
|
42
10
|
* ## Import
|
|
43
11
|
*
|
|
@@ -11,39 +11,7 @@ const utilities = require("../utilities");
|
|
|
11
11
|
* An authentication execution is an action that the user or service may or may not take when authenticating through an authentication
|
|
12
12
|
* flow.
|
|
13
13
|
*
|
|
14
|
-
* > Due to limitations in the Keycloak API, the ordering of authentication executions within a flow must be specified using `dependsOn`. Authentication executions that are created first will appear first within the flow.
|
|
15
|
-
*
|
|
16
|
-
* ## Example Usage
|
|
17
|
-
*
|
|
18
|
-
* ```typescript
|
|
19
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
20
|
-
* import * as keycloak from "@pulumi/keycloak";
|
|
21
|
-
*
|
|
22
|
-
* const realm = new keycloak.Realm("realm", {
|
|
23
|
-
* realm: "my-realm",
|
|
24
|
-
* enabled: true,
|
|
25
|
-
* });
|
|
26
|
-
* const flow = new keycloak.authentication.Flow("flow", {
|
|
27
|
-
* realmId: realm.id,
|
|
28
|
-
* alias: "my-flow-alias",
|
|
29
|
-
* });
|
|
30
|
-
* // first execution
|
|
31
|
-
* const executionOne = new keycloak.authentication.Execution("execution_one", {
|
|
32
|
-
* realmId: realm.id,
|
|
33
|
-
* parentFlowAlias: flow.alias,
|
|
34
|
-
* authenticator: "auth-cookie",
|
|
35
|
-
* requirement: "ALTERNATIVE",
|
|
36
|
-
* });
|
|
37
|
-
* // second execution
|
|
38
|
-
* const executionTwo = new keycloak.authentication.Execution("execution_two", {
|
|
39
|
-
* realmId: realm.id,
|
|
40
|
-
* parentFlowAlias: flow.alias,
|
|
41
|
-
* authenticator: "identity-provider-redirector",
|
|
42
|
-
* requirement: "ALTERNATIVE",
|
|
43
|
-
* }, {
|
|
44
|
-
* dependsOn: [executionOne],
|
|
45
|
-
* });
|
|
46
|
-
* ```
|
|
14
|
+
* > Following limitation affects Keycloak < 25: Due to limitations in the Keycloak API, the ordering of authentication executions within a flow must be specified using `dependsOn`. Authentication executions that are created first will appear first within the flow.
|
|
47
15
|
*
|
|
48
16
|
* ## Import
|
|
49
17
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"execution.js","sourceRoot":"","sources":["../../authentication/execution.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"execution.js","sourceRoot":"","sources":["../../authentication/execution.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IAChD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAsB,EAAE,IAAmC;QACpH,OAAO,IAAI,SAAS,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAChE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC,YAAY,CAAC;IAC1D,CAAC;IA2BD,YAAY,IAAY,EAAE,WAA4C,EAAE,IAAmC;QACvG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAyC,CAAC;YACxD,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SACzE;aAAM;YACH,MAAM,IAAI,GAAG,WAAwC,CAAC;YACtD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;aAChE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC5D,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;aAClE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aAC1D;YACD,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;;AAhFL,8BAiFC;AAnEG,gBAAgB;AACO,sBAAY,GAAG,6CAA6C,CAAC"}
|
|
@@ -5,29 +5,6 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
5
5
|
* Like authentication flows, authentication subflows are containers for authentication executions.
|
|
6
6
|
* As its name implies, an authentication subflow is contained in an authentication flow.
|
|
7
7
|
*
|
|
8
|
-
* ## Example Usage
|
|
9
|
-
*
|
|
10
|
-
* ```typescript
|
|
11
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
12
|
-
* import * as keycloak from "@pulumi/keycloak";
|
|
13
|
-
*
|
|
14
|
-
* const realm = new keycloak.Realm("realm", {
|
|
15
|
-
* realm: "my-realm",
|
|
16
|
-
* enabled: true,
|
|
17
|
-
* });
|
|
18
|
-
* const flow = new keycloak.authentication.Flow("flow", {
|
|
19
|
-
* realmId: realm.id,
|
|
20
|
-
* alias: "my-flow-alias",
|
|
21
|
-
* });
|
|
22
|
-
* const subflow = new keycloak.authentication.Subflow("subflow", {
|
|
23
|
-
* realmId: realm.id,
|
|
24
|
-
* alias: "my-subflow-alias",
|
|
25
|
-
* parentFlowAlias: flow.alias,
|
|
26
|
-
* providerId: "basic-flow",
|
|
27
|
-
* requirement: "ALTERNATIVE",
|
|
28
|
-
* });
|
|
29
|
-
* ```
|
|
30
|
-
*
|
|
31
8
|
* ## Import
|
|
32
9
|
*
|
|
33
10
|
* Authentication flows can be imported using the format `{{realmId}}/{{parentFlowAlias}}/{{authenticationSubflowId}}`.
|
|
@@ -11,29 +11,6 @@ const utilities = require("../utilities");
|
|
|
11
11
|
* Like authentication flows, authentication subflows are containers for authentication executions.
|
|
12
12
|
* As its name implies, an authentication subflow is contained in an authentication flow.
|
|
13
13
|
*
|
|
14
|
-
* ## Example Usage
|
|
15
|
-
*
|
|
16
|
-
* ```typescript
|
|
17
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
18
|
-
* import * as keycloak from "@pulumi/keycloak";
|
|
19
|
-
*
|
|
20
|
-
* const realm = new keycloak.Realm("realm", {
|
|
21
|
-
* realm: "my-realm",
|
|
22
|
-
* enabled: true,
|
|
23
|
-
* });
|
|
24
|
-
* const flow = new keycloak.authentication.Flow("flow", {
|
|
25
|
-
* realmId: realm.id,
|
|
26
|
-
* alias: "my-flow-alias",
|
|
27
|
-
* });
|
|
28
|
-
* const subflow = new keycloak.authentication.Subflow("subflow", {
|
|
29
|
-
* realmId: realm.id,
|
|
30
|
-
* alias: "my-subflow-alias",
|
|
31
|
-
* parentFlowAlias: flow.alias,
|
|
32
|
-
* providerId: "basic-flow",
|
|
33
|
-
* requirement: "ALTERNATIVE",
|
|
34
|
-
* });
|
|
35
|
-
* ```
|
|
36
|
-
*
|
|
37
14
|
* ## Import
|
|
38
15
|
*
|
|
39
16
|
* Authentication flows can be imported using the format `{{realmId}}/{{parentFlowAlias}}/{{authenticationSubflowId}}`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subflow.js","sourceRoot":"","sources":["../../authentication/subflow.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"subflow.js","sourceRoot":"","sources":["../../authentication/subflow.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,OAAQ,SAAQ,MAAM,CAAC,cAAc;IAC9C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoB,EAAE,IAAmC;QAClH,OAAO,IAAI,OAAO,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;IACxD,CAAC;IA0CD,YAAY,IAAY,EAAE,WAAwC,EAAE,IAAmC;QACnG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuC,CAAC;YACtD,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SACzE;aAAM;YACH,MAAM,IAAI,GAAG,WAAsC,CAAC;YACpD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC5D,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;aAClE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aAC1D;YACD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;;AArGL,0BAsGC;AAxFG,gBAAgB;AACO,oBAAY,GAAG,yCAAyC,CAAC"}
|
|
@@ -65,7 +65,7 @@ export declare class CustomUserFederation extends pulumi.CustomResource {
|
|
|
65
65
|
*/
|
|
66
66
|
readonly changedSyncPeriod: pulumi.Output<number | undefined>;
|
|
67
67
|
/**
|
|
68
|
-
* The provider configuration handed over to your custom user federation provider. In order to add
|
|
68
|
+
* The provider configuration handed over to your custom user federation provider. In order to add multivalued settings, use `##` to separate the values.
|
|
69
69
|
*/
|
|
70
70
|
readonly config: pulumi.Output<{
|
|
71
71
|
[key: string]: string;
|
|
@@ -120,7 +120,7 @@ export interface CustomUserFederationState {
|
|
|
120
120
|
*/
|
|
121
121
|
changedSyncPeriod?: pulumi.Input<number>;
|
|
122
122
|
/**
|
|
123
|
-
* The provider configuration handed over to your custom user federation provider. In order to add
|
|
123
|
+
* The provider configuration handed over to your custom user federation provider. In order to add multivalued settings, use `##` to separate the values.
|
|
124
124
|
*/
|
|
125
125
|
config?: pulumi.Input<{
|
|
126
126
|
[key: string]: pulumi.Input<string>;
|
|
@@ -167,7 +167,7 @@ export interface CustomUserFederationArgs {
|
|
|
167
167
|
*/
|
|
168
168
|
changedSyncPeriod?: pulumi.Input<number>;
|
|
169
169
|
/**
|
|
170
|
-
* The provider configuration handed over to your custom user federation provider. In order to add
|
|
170
|
+
* The provider configuration handed over to your custom user federation provider. In order to add multivalued settings, use `##` to separate the values.
|
|
171
171
|
*/
|
|
172
172
|
config?: pulumi.Input<{
|
|
173
173
|
[key: string]: pulumi.Input<string>;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as pulumi from "@pulumi/pulumi";
|
|
2
2
|
import * as outputs from "./types/output";
|
|
3
3
|
/**
|
|
4
|
-
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/
|
|
4
|
+
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/exportimport/ClientDescriptionConverter.html) API to convert a generic client description into a Keycloak
|
|
5
5
|
* client. This data can then be used to manage the client within Keycloak.
|
|
6
6
|
*
|
|
7
7
|
* ## Example Usage
|
|
@@ -122,7 +122,7 @@ export interface GetClientDescriptionConverterResult {
|
|
|
122
122
|
readonly webOrigins: string[];
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
|
-
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/
|
|
125
|
+
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/exportimport/ClientDescriptionConverter.html) API to convert a generic client description into a Keycloak
|
|
126
126
|
* client. This data can then be used to manage the client within Keycloak.
|
|
127
127
|
*
|
|
128
128
|
* ## Example Usage
|
|
@@ -6,7 +6,7 @@ exports.getClientDescriptionConverterOutput = exports.getClientDescriptionConver
|
|
|
6
6
|
const pulumi = require("@pulumi/pulumi");
|
|
7
7
|
const utilities = require("./utilities");
|
|
8
8
|
/**
|
|
9
|
-
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/
|
|
9
|
+
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/exportimport/ClientDescriptionConverter.html) API to convert a generic client description into a Keycloak
|
|
10
10
|
* client. This data can then be used to manage the client within Keycloak.
|
|
11
11
|
*
|
|
12
12
|
* ## Example Usage
|
|
@@ -65,7 +65,7 @@ function getClientDescriptionConverter(args, opts) {
|
|
|
65
65
|
}
|
|
66
66
|
exports.getClientDescriptionConverter = getClientDescriptionConverter;
|
|
67
67
|
/**
|
|
68
|
-
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/
|
|
68
|
+
* This data source uses the [ClientDescriptionConverter](https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/exportimport/ClientDescriptionConverter.html) API to convert a generic client description into a Keycloak
|
|
69
69
|
* client. This data can then be used to manage the client within Keycloak.
|
|
70
70
|
*
|
|
71
71
|
* ## Example Usage
|
package/group.d.ts
CHANGED
|
@@ -71,7 +71,7 @@ export declare class Group extends pulumi.CustomResource {
|
|
|
71
71
|
*/
|
|
72
72
|
static isInstance(obj: any): obj is Group;
|
|
73
73
|
/**
|
|
74
|
-
* A map representing attributes for the group. In order to add
|
|
74
|
+
* A map representing attributes for the group. In order to add multivalued attributes, use `##` to separate the values. Max length for each value is 255 chars
|
|
75
75
|
*/
|
|
76
76
|
readonly attributes: pulumi.Output<{
|
|
77
77
|
[key: string]: string;
|
|
@@ -106,7 +106,7 @@ export declare class Group extends pulumi.CustomResource {
|
|
|
106
106
|
*/
|
|
107
107
|
export interface GroupState {
|
|
108
108
|
/**
|
|
109
|
-
* A map representing attributes for the group. In order to add
|
|
109
|
+
* A map representing attributes for the group. In order to add multivalued attributes, use `##` to separate the values. Max length for each value is 255 chars
|
|
110
110
|
*/
|
|
111
111
|
attributes?: pulumi.Input<{
|
|
112
112
|
[key: string]: pulumi.Input<string>;
|
|
@@ -133,7 +133,7 @@ export interface GroupState {
|
|
|
133
133
|
*/
|
|
134
134
|
export interface GroupArgs {
|
|
135
135
|
/**
|
|
136
|
-
* A map representing attributes for the group. In order to add
|
|
136
|
+
* A map representing attributes for the group. In order to add multivalued attributes, use `##` to separate the values. Max length for each value is 255 chars
|
|
137
137
|
*/
|
|
138
138
|
attributes?: pulumi.Input<{
|
|
139
139
|
[key: string]: pulumi.Input<string>;
|
package/groupMemberships.d.ts
CHANGED
|
@@ -47,7 +47,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
47
47
|
*
|
|
48
48
|
* as if it did not already exist on the server.
|
|
49
49
|
*
|
|
50
|
-
* [1]: providers/keycloak/keycloak/latest/docs/resources/group_memberships
|
|
50
|
+
* [1]: https://registry.terraform.io/providers/keycloak/keycloak/latest/docs/resources/group_memberships
|
|
51
51
|
*/
|
|
52
52
|
export declare class GroupMemberships extends pulumi.CustomResource {
|
|
53
53
|
/**
|
package/groupMemberships.js
CHANGED
|
@@ -53,7 +53,7 @@ const utilities = require("./utilities");
|
|
|
53
53
|
*
|
|
54
54
|
* as if it did not already exist on the server.
|
|
55
55
|
*
|
|
56
|
-
* [1]: providers/keycloak/keycloak/latest/docs/resources/group_memberships
|
|
56
|
+
* [1]: https://registry.terraform.io/providers/keycloak/keycloak/latest/docs/resources/group_memberships
|
|
57
57
|
*/
|
|
58
58
|
class GroupMemberships extends pulumi.CustomResource {
|
|
59
59
|
/**
|
package/ldap/groupMapper.d.ts
CHANGED
|
@@ -87,7 +87,7 @@ export declare class GroupMapper extends pulumi.CustomResource {
|
|
|
87
87
|
*/
|
|
88
88
|
readonly groupObjectClasses: pulumi.Output<string[]>;
|
|
89
89
|
/**
|
|
90
|
-
* When specified, adds
|
|
90
|
+
* When specified, adds a custom filter to be used when querying for groups. Must start with `(` and end with `)`.
|
|
91
91
|
*/
|
|
92
92
|
readonly groupsLdapFilter: pulumi.Output<string | undefined>;
|
|
93
93
|
/**
|
|
@@ -172,7 +172,7 @@ export interface GroupMapperState {
|
|
|
172
172
|
*/
|
|
173
173
|
groupObjectClasses?: pulumi.Input<pulumi.Input<string>[]>;
|
|
174
174
|
/**
|
|
175
|
-
* When specified, adds
|
|
175
|
+
* When specified, adds a custom filter to be used when querying for groups. Must start with `(` and end with `)`.
|
|
176
176
|
*/
|
|
177
177
|
groupsLdapFilter?: pulumi.Input<string>;
|
|
178
178
|
/**
|
|
@@ -249,7 +249,7 @@ export interface GroupMapperArgs {
|
|
|
249
249
|
*/
|
|
250
250
|
groupObjectClasses: pulumi.Input<pulumi.Input<string>[]>;
|
|
251
251
|
/**
|
|
252
|
-
* When specified, adds
|
|
252
|
+
* When specified, adds a custom filter to be used when querying for groups. Must start with `(` and end with `)`.
|
|
253
253
|
*/
|
|
254
254
|
groupsLdapFilter?: pulumi.Input<string>;
|
|
255
255
|
/**
|
package/ldap/roleMapper.d.ts
CHANGED
|
@@ -123,7 +123,7 @@ export declare class RoleMapper extends pulumi.CustomResource {
|
|
|
123
123
|
*/
|
|
124
124
|
readonly roleObjectClasses: pulumi.Output<string[]>;
|
|
125
125
|
/**
|
|
126
|
-
* When specified, adds
|
|
126
|
+
* When specified, adds a custom filter to be used when querying for roles. Must start with `(` and end with `)`.
|
|
127
127
|
*/
|
|
128
128
|
readonly rolesLdapFilter: pulumi.Output<string | undefined>;
|
|
129
129
|
/**
|
|
@@ -196,7 +196,7 @@ export interface RoleMapperState {
|
|
|
196
196
|
*/
|
|
197
197
|
roleObjectClasses?: pulumi.Input<pulumi.Input<string>[]>;
|
|
198
198
|
/**
|
|
199
|
-
* When specified, adds
|
|
199
|
+
* When specified, adds a custom filter to be used when querying for roles. Must start with `(` and end with `)`.
|
|
200
200
|
*/
|
|
201
201
|
rolesLdapFilter?: pulumi.Input<string>;
|
|
202
202
|
/**
|
|
@@ -261,7 +261,7 @@ export interface RoleMapperArgs {
|
|
|
261
261
|
*/
|
|
262
262
|
roleObjectClasses: pulumi.Input<pulumi.Input<string>[]>;
|
|
263
263
|
/**
|
|
264
|
-
* When specified, adds
|
|
264
|
+
* When specified, adds a custom filter to be used when querying for roles. Must start with `(` and end with `)`.
|
|
265
265
|
*/
|
|
266
266
|
rolesLdapFilter?: pulumi.Input<string>;
|
|
267
267
|
/**
|
|
@@ -119,7 +119,7 @@ export declare class GoogleIdentityProvider extends pulumi.CustomResource {
|
|
|
119
119
|
*/
|
|
120
120
|
readonly internalId: pulumi.Output<string>;
|
|
121
121
|
/**
|
|
122
|
-
* When `true`, users cannot
|
|
122
|
+
* When `true`, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
123
123
|
*/
|
|
124
124
|
readonly linkOnly: pulumi.Output<boolean | undefined>;
|
|
125
125
|
/**
|
|
@@ -231,7 +231,7 @@ export interface GoogleIdentityProviderState {
|
|
|
231
231
|
*/
|
|
232
232
|
internalId?: pulumi.Input<string>;
|
|
233
233
|
/**
|
|
234
|
-
* When `true`, users cannot
|
|
234
|
+
* When `true`, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
235
235
|
*/
|
|
236
236
|
linkOnly?: pulumi.Input<boolean>;
|
|
237
237
|
/**
|
|
@@ -323,7 +323,7 @@ export interface GoogleIdentityProviderArgs {
|
|
|
323
323
|
*/
|
|
324
324
|
hostedDomain?: pulumi.Input<string>;
|
|
325
325
|
/**
|
|
326
|
-
* When `true`, users cannot
|
|
326
|
+
* When `true`, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
327
327
|
*/
|
|
328
328
|
linkOnly?: pulumi.Input<boolean>;
|
|
329
329
|
/**
|
|
@@ -64,7 +64,7 @@ export declare class IdentityProvider extends pulumi.CustomResource {
|
|
|
64
64
|
*/
|
|
65
65
|
readonly addReadTokenRoleOnCreate: pulumi.Output<boolean | undefined>;
|
|
66
66
|
/**
|
|
67
|
-
* The alias uniquely identifies an identity provider and it is also used to build the redirect uri.
|
|
67
|
+
* The alias uniquely identifies an identity provider, and it is also used to build the redirect uri.
|
|
68
68
|
*/
|
|
69
69
|
readonly alias: pulumi.Output<string>;
|
|
70
70
|
/**
|
|
@@ -131,7 +131,7 @@ export declare class IdentityProvider extends pulumi.CustomResource {
|
|
|
131
131
|
*/
|
|
132
132
|
readonly jwksUrl: pulumi.Output<string | undefined>;
|
|
133
133
|
/**
|
|
134
|
-
* When `true`, users cannot
|
|
134
|
+
* When `true`, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
135
135
|
*/
|
|
136
136
|
readonly linkOnly: pulumi.Output<boolean | undefined>;
|
|
137
137
|
/**
|
|
@@ -139,7 +139,7 @@ export declare class IdentityProvider extends pulumi.CustomResource {
|
|
|
139
139
|
*/
|
|
140
140
|
readonly loginHint: pulumi.Output<string | undefined>;
|
|
141
141
|
/**
|
|
142
|
-
* The Logout URL is the end session endpoint to use to
|
|
142
|
+
* The Logout URL is the end session endpoint to use to sign-out the user from external identity provider.
|
|
143
143
|
*/
|
|
144
144
|
readonly logoutUrl: pulumi.Output<string | undefined>;
|
|
145
145
|
/**
|
|
@@ -204,7 +204,7 @@ export interface IdentityProviderState {
|
|
|
204
204
|
*/
|
|
205
205
|
addReadTokenRoleOnCreate?: pulumi.Input<boolean>;
|
|
206
206
|
/**
|
|
207
|
-
* The alias uniquely identifies an identity provider and it is also used to build the redirect uri.
|
|
207
|
+
* The alias uniquely identifies an identity provider, and it is also used to build the redirect uri.
|
|
208
208
|
*/
|
|
209
209
|
alias?: pulumi.Input<string>;
|
|
210
210
|
/**
|
|
@@ -271,7 +271,7 @@ export interface IdentityProviderState {
|
|
|
271
271
|
*/
|
|
272
272
|
jwksUrl?: pulumi.Input<string>;
|
|
273
273
|
/**
|
|
274
|
-
* When `true`, users cannot
|
|
274
|
+
* When `true`, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
275
275
|
*/
|
|
276
276
|
linkOnly?: pulumi.Input<boolean>;
|
|
277
277
|
/**
|
|
@@ -279,7 +279,7 @@ export interface IdentityProviderState {
|
|
|
279
279
|
*/
|
|
280
280
|
loginHint?: pulumi.Input<string>;
|
|
281
281
|
/**
|
|
282
|
-
* The Logout URL is the end session endpoint to use to
|
|
282
|
+
* The Logout URL is the end session endpoint to use to sign-out the user from external identity provider.
|
|
283
283
|
*/
|
|
284
284
|
logoutUrl?: pulumi.Input<string>;
|
|
285
285
|
/**
|
|
@@ -336,7 +336,7 @@ export interface IdentityProviderArgs {
|
|
|
336
336
|
*/
|
|
337
337
|
addReadTokenRoleOnCreate?: pulumi.Input<boolean>;
|
|
338
338
|
/**
|
|
339
|
-
* The alias uniquely identifies an identity provider and it is also used to build the redirect uri.
|
|
339
|
+
* The alias uniquely identifies an identity provider, and it is also used to build the redirect uri.
|
|
340
340
|
*/
|
|
341
341
|
alias: pulumi.Input<string>;
|
|
342
342
|
/**
|
|
@@ -399,7 +399,7 @@ export interface IdentityProviderArgs {
|
|
|
399
399
|
*/
|
|
400
400
|
jwksUrl?: pulumi.Input<string>;
|
|
401
401
|
/**
|
|
402
|
-
* When `true`, users cannot
|
|
402
|
+
* When `true`, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
403
403
|
*/
|
|
404
404
|
linkOnly?: pulumi.Input<boolean>;
|
|
405
405
|
/**
|
|
@@ -407,7 +407,7 @@ export interface IdentityProviderArgs {
|
|
|
407
407
|
*/
|
|
408
408
|
loginHint?: pulumi.Input<string>;
|
|
409
409
|
/**
|
|
410
|
-
* The Logout URL is the end session endpoint to use to
|
|
410
|
+
* The Logout URL is the end session endpoint to use to sign-out the user from external identity provider.
|
|
411
411
|
*/
|
|
412
412
|
logoutUrl?: pulumi.Input<string>;
|
|
413
413
|
/**
|
|
@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
2
2
|
/**
|
|
3
3
|
* Allows for creating and managing audience protocol mappers within Keycloak.
|
|
4
4
|
*
|
|
5
|
-
* Audience protocol mappers allow you add audiences to the `aud` claim within issued tokens. The audience can be a custom
|
|
5
|
+
* Audience protocol mappers allow you to add audiences to the `aud` claim within issued tokens. The audience can be a custom
|
|
6
6
|
* string, or it can be mapped to the ID of a pre-existing client.
|
|
7
7
|
*
|
|
8
8
|
* ## Example Usage
|
|
@@ -8,7 +8,7 @@ const utilities = require("../utilities");
|
|
|
8
8
|
/**
|
|
9
9
|
* Allows for creating and managing audience protocol mappers within Keycloak.
|
|
10
10
|
*
|
|
11
|
-
* Audience protocol mappers allow you add audiences to the `aud` claim within issued tokens. The audience can be a custom
|
|
11
|
+
* Audience protocol mappers allow you to add audiences to the `aud` claim within issued tokens. The audience can be a custom
|
|
12
12
|
* string, or it can be mapped to the ID of a pre-existing client.
|
|
13
13
|
*
|
|
14
14
|
* ## Example Usage
|
package/openid/client.d.ts
CHANGED
|
@@ -254,7 +254,7 @@ export declare class Client extends pulumi.CustomResource {
|
|
|
254
254
|
*/
|
|
255
255
|
readonly validRedirectUris: pulumi.Output<string[]>;
|
|
256
256
|
/**
|
|
257
|
-
* A list of allowed CORS origins. To permit all valid redirect URIs, add `+`. Note that this will not include the `*` wildcard. To permit all origins, explicitly add `*`.
|
|
257
|
+
* A list of allowed CORS origins. To permit all valid redirect URIs, add `+`. Note that this will not include the `*` wildcard. To permit all origins, explicitly add `*`.
|
|
258
258
|
*/
|
|
259
259
|
readonly webOrigins: pulumi.Output<string[]>;
|
|
260
260
|
/**
|
|
@@ -461,7 +461,7 @@ export interface ClientState {
|
|
|
461
461
|
*/
|
|
462
462
|
validRedirectUris?: pulumi.Input<pulumi.Input<string>[]>;
|
|
463
463
|
/**
|
|
464
|
-
* A list of allowed CORS origins. To permit all valid redirect URIs, add `+`. Note that this will not include the `*` wildcard. To permit all origins, explicitly add `*`.
|
|
464
|
+
* A list of allowed CORS origins. To permit all valid redirect URIs, add `+`. Note that this will not include the `*` wildcard. To permit all origins, explicitly add `*`.
|
|
465
465
|
*/
|
|
466
466
|
webOrigins?: pulumi.Input<pulumi.Input<string>[]>;
|
|
467
467
|
}
|
|
@@ -652,7 +652,7 @@ export interface ClientArgs {
|
|
|
652
652
|
*/
|
|
653
653
|
validRedirectUris?: pulumi.Input<pulumi.Input<string>[]>;
|
|
654
654
|
/**
|
|
655
|
-
* A list of allowed CORS origins. To permit all valid redirect URIs, add `+`. Note that this will not include the `*` wildcard. To permit all origins, explicitly add `*`.
|
|
655
|
+
* A list of allowed CORS origins. To permit all valid redirect URIs, add `+`. Note that this will not include the `*` wildcard. To permit all origins, explicitly add `*`.
|
|
656
656
|
*/
|
|
657
657
|
webOrigins?: pulumi.Input<pulumi.Input<string>[]>;
|
|
658
658
|
}
|
|
@@ -133,7 +133,7 @@ export declare class UserPropertyProtocolMapper extends pulumi.CustomResource {
|
|
|
133
133
|
*/
|
|
134
134
|
readonly realmId: pulumi.Output<string>;
|
|
135
135
|
/**
|
|
136
|
-
* The built
|
|
136
|
+
* The built-in user property (such as email) to map a claim for.
|
|
137
137
|
*/
|
|
138
138
|
readonly userProperty: pulumi.Output<string>;
|
|
139
139
|
/**
|
|
@@ -186,7 +186,7 @@ export interface UserPropertyProtocolMapperState {
|
|
|
186
186
|
*/
|
|
187
187
|
realmId?: pulumi.Input<string>;
|
|
188
188
|
/**
|
|
189
|
-
* The built
|
|
189
|
+
* The built-in user property (such as email) to map a claim for.
|
|
190
190
|
*/
|
|
191
191
|
userProperty?: pulumi.Input<string>;
|
|
192
192
|
}
|
|
@@ -231,7 +231,7 @@ export interface UserPropertyProtocolMapperArgs {
|
|
|
231
231
|
*/
|
|
232
232
|
realmId: pulumi.Input<string>;
|
|
233
233
|
/**
|
|
234
|
-
* The built
|
|
234
|
+
* The built-in user property (such as email) to map a claim for.
|
|
235
235
|
*/
|
|
236
236
|
userProperty: pulumi.Input<string>;
|
|
237
237
|
}
|
|
@@ -130,7 +130,7 @@ export declare class UserSessionNoteProtocolMapper extends pulumi.CustomResource
|
|
|
130
130
|
*/
|
|
131
131
|
readonly realmId: pulumi.Output<string>;
|
|
132
132
|
/**
|
|
133
|
-
* String value being the name of stored user session note within the UserSessionModel.note map.
|
|
133
|
+
* String value being the name of stored user session note within the `UserSessionModel.note` map.
|
|
134
134
|
*/
|
|
135
135
|
readonly sessionNote: pulumi.Output<string | undefined>;
|
|
136
136
|
/**
|
|
@@ -179,7 +179,7 @@ export interface UserSessionNoteProtocolMapperState {
|
|
|
179
179
|
*/
|
|
180
180
|
realmId?: pulumi.Input<string>;
|
|
181
181
|
/**
|
|
182
|
-
* String value being the name of stored user session note within the UserSessionModel.note map.
|
|
182
|
+
* String value being the name of stored user session note within the `UserSessionModel.note` map.
|
|
183
183
|
*/
|
|
184
184
|
sessionNote?: pulumi.Input<string>;
|
|
185
185
|
}
|
|
@@ -220,7 +220,7 @@ export interface UserSessionNoteProtocolMapperArgs {
|
|
|
220
220
|
*/
|
|
221
221
|
realmId: pulumi.Input<string>;
|
|
222
222
|
/**
|
|
223
|
-
* String value being the name of stored user session note within the UserSessionModel.note map.
|
|
223
|
+
* String value being the name of stored user session note within the `UserSessionModel.note` map.
|
|
224
224
|
*/
|
|
225
225
|
sessionNote?: pulumi.Input<string>;
|
|
226
226
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pulumi/keycloak",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.1.0-alpha.1737129047",
|
|
4
4
|
"description": "A Pulumi package for creating and managing keycloak cloud resources.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"pulumi",
|
|
@@ -23,6 +23,6 @@
|
|
|
23
23
|
"pulumi": {
|
|
24
24
|
"resource": true,
|
|
25
25
|
"name": "keycloak",
|
|
26
|
-
"version": "6.0.
|
|
26
|
+
"version": "6.1.0-alpha.1737129047"
|
|
27
27
|
}
|
|
28
28
|
}
|
package/realm.d.ts
CHANGED
|
@@ -74,8 +74,8 @@ import * as outputs from "./types/output";
|
|
|
74
74
|
*
|
|
75
75
|
* ## Default Client Scopes
|
|
76
76
|
*
|
|
77
|
-
* - `defaultDefaultClientScopes` - (Optional) A list of default default client scopes to be used for client definitions. Defaults to `[]` or keycloak's built-in default default client-scopes
|
|
78
|
-
* - `defaultOptionalClientScopes` - (Optional) A list of default optional client scopes to be used for client definitions. Defaults to `[]` or keycloak's built-in default optional client-scopes
|
|
77
|
+
* - `defaultDefaultClientScopes` - (Optional) A list of default `default client scopes` to be used for client definitions. Defaults to `[]` or keycloak's built-in default `default client-scopes`.
|
|
78
|
+
* - `defaultOptionalClientScopes` - (Optional) A list of default `optional client scopes` to be used for client definitions. Defaults to `[]` or keycloak's built-in default `optional client-scopes`.
|
|
79
79
|
*
|
|
80
80
|
* ## Import
|
|
81
81
|
*
|
package/realm.js
CHANGED
|
@@ -78,8 +78,8 @@ const utilities = require("./utilities");
|
|
|
78
78
|
*
|
|
79
79
|
* ## Default Client Scopes
|
|
80
80
|
*
|
|
81
|
-
* - `defaultDefaultClientScopes` - (Optional) A list of default default client scopes to be used for client definitions. Defaults to `[]` or keycloak's built-in default default client-scopes
|
|
82
|
-
* - `defaultOptionalClientScopes` - (Optional) A list of default optional client scopes to be used for client definitions. Defaults to `[]` or keycloak's built-in default optional client-scopes
|
|
81
|
+
* - `defaultDefaultClientScopes` - (Optional) A list of default `default client scopes` to be used for client definitions. Defaults to `[]` or keycloak's built-in default `default client-scopes`.
|
|
82
|
+
* - `defaultOptionalClientScopes` - (Optional) A list of default `optional client scopes` to be used for client definitions. Defaults to `[]` or keycloak's built-in default `optional client-scopes`.
|
|
83
83
|
*
|
|
84
84
|
* ## Import
|
|
85
85
|
*
|
package/realmUserProfile.d.ts
CHANGED
|
@@ -5,99 +5,10 @@ import * as outputs from "./types/output";
|
|
|
5
5
|
* Allows for managing Realm User Profiles within Keycloak.
|
|
6
6
|
*
|
|
7
7
|
* A user profile defines a schema for representing user attributes and how they are managed within a realm.
|
|
8
|
-
* This is a preview feature, hence not fully supported and disabled by default.
|
|
9
|
-
* To enable it, start the server with one of the following flags:
|
|
10
|
-
* - WildFly distribution: `-Dkeycloak.profile.feature.declarative_user_profile=enabled`
|
|
11
|
-
* - Quarkus distribution: `--features=preview` or `--features=declarative-user-profile`
|
|
12
8
|
*
|
|
9
|
+
* Information for Keycloak versions < 24:
|
|
13
10
|
* The realm linked to the `keycloak.RealmUserProfile` resource must have the user profile feature enabled.
|
|
14
11
|
* It can be done via the administration UI, or by setting the `userProfileEnabled` realm attribute to `true`.
|
|
15
|
-
*
|
|
16
|
-
* ## Example Usage
|
|
17
|
-
*
|
|
18
|
-
* ```typescript
|
|
19
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
20
|
-
* import * as keycloak from "@pulumi/keycloak";
|
|
21
|
-
*
|
|
22
|
-
* const realm = new keycloak.Realm("realm", {
|
|
23
|
-
* realm: "my-realm",
|
|
24
|
-
* attributes: {
|
|
25
|
-
* userProfileEnabled: "true",
|
|
26
|
-
* },
|
|
27
|
-
* });
|
|
28
|
-
* const userprofile = new keycloak.RealmUserProfile("userprofile", {
|
|
29
|
-
* realmId: myRealm.id,
|
|
30
|
-
* attributes: [
|
|
31
|
-
* {
|
|
32
|
-
* name: "field1",
|
|
33
|
-
* displayName: "Field 1",
|
|
34
|
-
* group: "group1",
|
|
35
|
-
* enabledWhenScopes: ["offline_access"],
|
|
36
|
-
* requiredForRoles: ["user"],
|
|
37
|
-
* requiredForScopes: ["offline_access"],
|
|
38
|
-
* permissions: {
|
|
39
|
-
* views: [
|
|
40
|
-
* "admin",
|
|
41
|
-
* "user",
|
|
42
|
-
* ],
|
|
43
|
-
* edits: [
|
|
44
|
-
* "admin",
|
|
45
|
-
* "user",
|
|
46
|
-
* ],
|
|
47
|
-
* },
|
|
48
|
-
* validators: [
|
|
49
|
-
* {
|
|
50
|
-
* name: "person-name-prohibited-characters",
|
|
51
|
-
* },
|
|
52
|
-
* {
|
|
53
|
-
* name: "pattern",
|
|
54
|
-
* config: {
|
|
55
|
-
* pattern: "^[a-z]+$",
|
|
56
|
-
* "error-message": "Nope",
|
|
57
|
-
* },
|
|
58
|
-
* },
|
|
59
|
-
* ],
|
|
60
|
-
* annotations: {
|
|
61
|
-
* foo: "bar",
|
|
62
|
-
* },
|
|
63
|
-
* },
|
|
64
|
-
* {
|
|
65
|
-
* name: "field2",
|
|
66
|
-
* validators: [{
|
|
67
|
-
* name: "options",
|
|
68
|
-
* config: {
|
|
69
|
-
* options: JSON.stringify(["opt1"]),
|
|
70
|
-
* },
|
|
71
|
-
* }],
|
|
72
|
-
* annotations: {
|
|
73
|
-
* foo: JSON.stringify({
|
|
74
|
-
* key: "val",
|
|
75
|
-
* }),
|
|
76
|
-
* },
|
|
77
|
-
* },
|
|
78
|
-
* ],
|
|
79
|
-
* groups: [
|
|
80
|
-
* {
|
|
81
|
-
* name: "group1",
|
|
82
|
-
* displayHeader: "Group 1",
|
|
83
|
-
* displayDescription: "A first group",
|
|
84
|
-
* annotations: {
|
|
85
|
-
* foo: "bar",
|
|
86
|
-
* foo2: JSON.stringify({
|
|
87
|
-
* key: "val",
|
|
88
|
-
* }),
|
|
89
|
-
* },
|
|
90
|
-
* },
|
|
91
|
-
* {
|
|
92
|
-
* name: "group2",
|
|
93
|
-
* },
|
|
94
|
-
* ],
|
|
95
|
-
* });
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* ## Import
|
|
99
|
-
*
|
|
100
|
-
* This resource currently does not support importing.
|
|
101
12
|
*/
|
|
102
13
|
export declare class RealmUserProfile extends pulumi.CustomResource {
|
|
103
14
|
/**
|
package/realmUserProfile.js
CHANGED
|
@@ -9,99 +9,10 @@ const utilities = require("./utilities");
|
|
|
9
9
|
* Allows for managing Realm User Profiles within Keycloak.
|
|
10
10
|
*
|
|
11
11
|
* A user profile defines a schema for representing user attributes and how they are managed within a realm.
|
|
12
|
-
* This is a preview feature, hence not fully supported and disabled by default.
|
|
13
|
-
* To enable it, start the server with one of the following flags:
|
|
14
|
-
* - WildFly distribution: `-Dkeycloak.profile.feature.declarative_user_profile=enabled`
|
|
15
|
-
* - Quarkus distribution: `--features=preview` or `--features=declarative-user-profile`
|
|
16
12
|
*
|
|
13
|
+
* Information for Keycloak versions < 24:
|
|
17
14
|
* The realm linked to the `keycloak.RealmUserProfile` resource must have the user profile feature enabled.
|
|
18
15
|
* It can be done via the administration UI, or by setting the `userProfileEnabled` realm attribute to `true`.
|
|
19
|
-
*
|
|
20
|
-
* ## Example Usage
|
|
21
|
-
*
|
|
22
|
-
* ```typescript
|
|
23
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
24
|
-
* import * as keycloak from "@pulumi/keycloak";
|
|
25
|
-
*
|
|
26
|
-
* const realm = new keycloak.Realm("realm", {
|
|
27
|
-
* realm: "my-realm",
|
|
28
|
-
* attributes: {
|
|
29
|
-
* userProfileEnabled: "true",
|
|
30
|
-
* },
|
|
31
|
-
* });
|
|
32
|
-
* const userprofile = new keycloak.RealmUserProfile("userprofile", {
|
|
33
|
-
* realmId: myRealm.id,
|
|
34
|
-
* attributes: [
|
|
35
|
-
* {
|
|
36
|
-
* name: "field1",
|
|
37
|
-
* displayName: "Field 1",
|
|
38
|
-
* group: "group1",
|
|
39
|
-
* enabledWhenScopes: ["offline_access"],
|
|
40
|
-
* requiredForRoles: ["user"],
|
|
41
|
-
* requiredForScopes: ["offline_access"],
|
|
42
|
-
* permissions: {
|
|
43
|
-
* views: [
|
|
44
|
-
* "admin",
|
|
45
|
-
* "user",
|
|
46
|
-
* ],
|
|
47
|
-
* edits: [
|
|
48
|
-
* "admin",
|
|
49
|
-
* "user",
|
|
50
|
-
* ],
|
|
51
|
-
* },
|
|
52
|
-
* validators: [
|
|
53
|
-
* {
|
|
54
|
-
* name: "person-name-prohibited-characters",
|
|
55
|
-
* },
|
|
56
|
-
* {
|
|
57
|
-
* name: "pattern",
|
|
58
|
-
* config: {
|
|
59
|
-
* pattern: "^[a-z]+$",
|
|
60
|
-
* "error-message": "Nope",
|
|
61
|
-
* },
|
|
62
|
-
* },
|
|
63
|
-
* ],
|
|
64
|
-
* annotations: {
|
|
65
|
-
* foo: "bar",
|
|
66
|
-
* },
|
|
67
|
-
* },
|
|
68
|
-
* {
|
|
69
|
-
* name: "field2",
|
|
70
|
-
* validators: [{
|
|
71
|
-
* name: "options",
|
|
72
|
-
* config: {
|
|
73
|
-
* options: JSON.stringify(["opt1"]),
|
|
74
|
-
* },
|
|
75
|
-
* }],
|
|
76
|
-
* annotations: {
|
|
77
|
-
* foo: JSON.stringify({
|
|
78
|
-
* key: "val",
|
|
79
|
-
* }),
|
|
80
|
-
* },
|
|
81
|
-
* },
|
|
82
|
-
* ],
|
|
83
|
-
* groups: [
|
|
84
|
-
* {
|
|
85
|
-
* name: "group1",
|
|
86
|
-
* displayHeader: "Group 1",
|
|
87
|
-
* displayDescription: "A first group",
|
|
88
|
-
* annotations: {
|
|
89
|
-
* foo: "bar",
|
|
90
|
-
* foo2: JSON.stringify({
|
|
91
|
-
* key: "val",
|
|
92
|
-
* }),
|
|
93
|
-
* },
|
|
94
|
-
* },
|
|
95
|
-
* {
|
|
96
|
-
* name: "group2",
|
|
97
|
-
* },
|
|
98
|
-
* ],
|
|
99
|
-
* });
|
|
100
|
-
* ```
|
|
101
|
-
*
|
|
102
|
-
* ## Import
|
|
103
|
-
*
|
|
104
|
-
* This resource currently does not support importing.
|
|
105
16
|
*/
|
|
106
17
|
class RealmUserProfile extends pulumi.CustomResource {
|
|
107
18
|
/**
|
package/realmUserProfile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"realmUserProfile.js","sourceRoot":"","sources":["../realmUserProfile.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC
|
|
1
|
+
{"version":3,"file":"realmUserProfile.js","sourceRoot":"","sources":["../realmUserProfile.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;GAQG;AACH,MAAa,gBAAiB,SAAQ,MAAM,CAAC,cAAc;IACvD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA6B,EAAE,IAAmC;QAC3H,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACvE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,gBAAgB,CAAC,YAAY,CAAC;IACjE,CAAC;IAuBD,YAAY,IAAY,EAAE,WAA0D,EAAE,IAAmC;QACrH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAgD,CAAC;YAC/D,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACH,MAAM,IAAI,GAAG,WAA+C,CAAC;YAC7D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aAC1D;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;;AApEL,4CAqEC;AAvDG,gBAAgB;AACO,6BAAY,GAAG,kDAAkD,CAAC"}
|
package/role.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
2
2
|
/**
|
|
3
3
|
* Allows for creating and managing roles within Keycloak.
|
|
4
4
|
*
|
|
5
|
-
* Roles allow you define privileges within Keycloak and map them to users and groups.
|
|
5
|
+
* Roles allow you to define privileges within Keycloak and map them to users and groups.
|
|
6
6
|
*
|
|
7
7
|
* ## Example Usage
|
|
8
8
|
*
|
package/role.js
CHANGED
|
@@ -8,7 +8,7 @@ const utilities = require("./utilities");
|
|
|
8
8
|
/**
|
|
9
9
|
* Allows for creating and managing roles within Keycloak.
|
|
10
10
|
*
|
|
11
|
-
* Roles allow you define privileges within Keycloak and map them to users and groups.
|
|
11
|
+
* Roles allow you to define privileges within Keycloak and map them to users and groups.
|
|
12
12
|
*
|
|
13
13
|
* ## Example Usage
|
|
14
14
|
*
|
|
@@ -122,7 +122,7 @@ export declare class IdentityProvider extends pulumi.CustomResource {
|
|
|
122
122
|
*/
|
|
123
123
|
readonly internalId: pulumi.Output<string>;
|
|
124
124
|
/**
|
|
125
|
-
* When `true`, users cannot
|
|
125
|
+
* When `true`, users cannot log in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
126
126
|
*/
|
|
127
127
|
readonly linkOnly: pulumi.Output<boolean | undefined>;
|
|
128
128
|
/**
|
|
@@ -142,7 +142,7 @@ export declare class IdentityProvider extends pulumi.CustomResource {
|
|
|
142
142
|
*/
|
|
143
143
|
readonly postBindingLogout: pulumi.Output<boolean | undefined>;
|
|
144
144
|
/**
|
|
145
|
-
* Indicates whether to respond to requests using HTTP-POST binding. If false, HTTP-REDIRECT binding will be used
|
|
145
|
+
* Indicates whether to respond to requests using HTTP-POST binding. If false, HTTP-REDIRECT binding will be used.
|
|
146
146
|
*/
|
|
147
147
|
readonly postBindingResponse: pulumi.Output<boolean | undefined>;
|
|
148
148
|
/**
|
|
@@ -286,7 +286,7 @@ export interface IdentityProviderState {
|
|
|
286
286
|
*/
|
|
287
287
|
internalId?: pulumi.Input<string>;
|
|
288
288
|
/**
|
|
289
|
-
* When `true`, users cannot
|
|
289
|
+
* When `true`, users cannot log in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
290
290
|
*/
|
|
291
291
|
linkOnly?: pulumi.Input<boolean>;
|
|
292
292
|
/**
|
|
@@ -306,7 +306,7 @@ export interface IdentityProviderState {
|
|
|
306
306
|
*/
|
|
307
307
|
postBindingLogout?: pulumi.Input<boolean>;
|
|
308
308
|
/**
|
|
309
|
-
* Indicates whether to respond to requests using HTTP-POST binding. If false, HTTP-REDIRECT binding will be used
|
|
309
|
+
* Indicates whether to respond to requests using HTTP-POST binding. If false, HTTP-REDIRECT binding will be used.
|
|
310
310
|
*/
|
|
311
311
|
postBindingResponse?: pulumi.Input<boolean>;
|
|
312
312
|
/**
|
|
@@ -438,7 +438,7 @@ export interface IdentityProviderArgs {
|
|
|
438
438
|
*/
|
|
439
439
|
hideOnLoginPage?: pulumi.Input<boolean>;
|
|
440
440
|
/**
|
|
441
|
-
* When `true`, users cannot
|
|
441
|
+
* When `true`, users cannot log in using this provider, but their existing accounts will be linked when possible. Defaults to `false`.
|
|
442
442
|
*/
|
|
443
443
|
linkOnly?: pulumi.Input<boolean>;
|
|
444
444
|
/**
|
|
@@ -458,7 +458,7 @@ export interface IdentityProviderArgs {
|
|
|
458
458
|
*/
|
|
459
459
|
postBindingLogout?: pulumi.Input<boolean>;
|
|
460
460
|
/**
|
|
461
|
-
* Indicates whether to respond to requests using HTTP-POST binding. If false, HTTP-REDIRECT binding will be used
|
|
461
|
+
* Indicates whether to respond to requests using HTTP-POST binding. If false, HTTP-REDIRECT binding will be used.
|
|
462
462
|
*/
|
|
463
463
|
postBindingResponse?: pulumi.Input<boolean>;
|
|
464
464
|
/**
|
package/types/input.d.ts
CHANGED
|
@@ -478,7 +478,7 @@ export interface RealmWebAuthnPasswordlessPolicy {
|
|
|
478
478
|
*/
|
|
479
479
|
createTimeout?: pulumi.Input<number>;
|
|
480
480
|
/**
|
|
481
|
-
* A human
|
|
481
|
+
* A human-readable server name for the WebAuthn Relying Party. Defaults to `keycloak`.
|
|
482
482
|
*/
|
|
483
483
|
relyingPartyEntityName?: pulumi.Input<string>;
|
|
484
484
|
/**
|
|
@@ -520,7 +520,7 @@ export interface RealmWebAuthnPolicy {
|
|
|
520
520
|
*/
|
|
521
521
|
createTimeout?: pulumi.Input<number>;
|
|
522
522
|
/**
|
|
523
|
-
* A human
|
|
523
|
+
* A human-readable server name for the WebAuthn Relying Party. Defaults to `keycloak`.
|
|
524
524
|
*/
|
|
525
525
|
relyingPartyEntityName?: pulumi.Input<string>;
|
|
526
526
|
/**
|
|
@@ -550,7 +550,7 @@ export interface UserFederatedIdentity {
|
|
|
550
550
|
*/
|
|
551
551
|
userId: pulumi.Input<string>;
|
|
552
552
|
/**
|
|
553
|
-
* The
|
|
553
|
+
* The username of the user defined in the identity provider
|
|
554
554
|
*/
|
|
555
555
|
userName: pulumi.Input<string>;
|
|
556
556
|
}
|
package/types/output.d.ts
CHANGED
|
@@ -415,7 +415,7 @@ export interface RealmWebAuthnPasswordlessPolicy {
|
|
|
415
415
|
*/
|
|
416
416
|
createTimeout?: number;
|
|
417
417
|
/**
|
|
418
|
-
* A human
|
|
418
|
+
* A human-readable server name for the WebAuthn Relying Party. Defaults to `keycloak`.
|
|
419
419
|
*/
|
|
420
420
|
relyingPartyEntityName?: string;
|
|
421
421
|
/**
|
|
@@ -457,7 +457,7 @@ export interface RealmWebAuthnPolicy {
|
|
|
457
457
|
*/
|
|
458
458
|
createTimeout?: number;
|
|
459
459
|
/**
|
|
460
|
-
* A human
|
|
460
|
+
* A human-readable server name for the WebAuthn Relying Party. Defaults to `keycloak`.
|
|
461
461
|
*/
|
|
462
462
|
relyingPartyEntityName?: string;
|
|
463
463
|
/**
|
|
@@ -487,7 +487,7 @@ export interface UserFederatedIdentity {
|
|
|
487
487
|
*/
|
|
488
488
|
userId: string;
|
|
489
489
|
/**
|
|
490
|
-
* The
|
|
490
|
+
* The username of the user defined in the identity provider
|
|
491
491
|
*/
|
|
492
492
|
userName: string;
|
|
493
493
|
}
|