@pulumi/keycloak 5.3.0 → 5.3.1
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/attributeImporterIdentityProviderMapper.d.ts +46 -63
- package/attributeImporterIdentityProviderMapper.js +25 -33
- package/attributeImporterIdentityProviderMapper.js.map +1 -1
- package/attributeToRoleIdentityMapper.d.ts +10 -2
- package/attributeToRoleIdentityMapper.js +10 -2
- package/attributeToRoleIdentityMapper.js.map +1 -1
- package/authentication/bindings.d.ts +2 -0
- package/authentication/bindings.js +2 -0
- package/authentication/bindings.js.map +1 -1
- package/authentication/execution.d.ts +8 -2
- package/authentication/execution.js +8 -2
- package/authentication/execution.js.map +1 -1
- package/authentication/executionConfig.d.ts +12 -2
- package/authentication/executionConfig.js +12 -2
- package/authentication/executionConfig.js.map +1 -1
- package/authentication/flow.d.ts +16 -2
- package/authentication/flow.js +16 -2
- package/authentication/flow.js.map +1 -1
- package/authentication/subflow.d.ts +18 -2
- package/authentication/subflow.js +18 -2
- package/authentication/subflow.js.map +1 -1
- package/customIdentityProviderMapping.d.ts +13 -5
- package/customIdentityProviderMapping.js +10 -2
- package/customIdentityProviderMapping.js.map +1 -1
- package/customUserFederation.d.ts +51 -50
- package/customUserFederation.js +27 -14
- package/customUserFederation.js.map +1 -1
- package/defaultGroups.d.ts +19 -27
- package/defaultGroups.js +19 -9
- package/defaultGroups.js.map +1 -1
- package/defaultRoles.d.ts +13 -2
- package/defaultRoles.js +13 -2
- package/defaultRoles.js.map +1 -1
- package/genericClientProtocolMapper.d.ts +40 -37
- package/genericClientProtocolMapper.js +25 -13
- package/genericClientProtocolMapper.js.map +1 -1
- package/genericClientRoleMapper.d.ts +22 -2
- package/genericClientRoleMapper.js +22 -2
- package/genericClientRoleMapper.js.map +1 -1
- package/genericProtocolMapper.d.ts +8 -2
- package/genericProtocolMapper.js +8 -2
- package/genericProtocolMapper.js.map +1 -1
- package/genericRoleMapper.d.ts +22 -2
- package/genericRoleMapper.js +22 -2
- package/genericRoleMapper.js.map +1 -1
- package/getAuthenticationExecution.d.ts +4 -0
- package/getAuthenticationExecution.js +4 -0
- package/getAuthenticationExecution.js.map +1 -1
- package/getAuthenticationFlow.d.ts +4 -0
- package/getAuthenticationFlow.js +4 -0
- package/getAuthenticationFlow.js.map +1 -1
- package/getClientDescriptionConverter.d.ts +4 -0
- package/getClientDescriptionConverter.js +4 -0
- package/getClientDescriptionConverter.js.map +1 -1
- package/getGroup.d.ts +4 -62
- package/getGroup.js +4 -50
- package/getGroup.js.map +1 -1
- package/getRealm.d.ts +32 -10
- package/getRealm.js +32 -4
- package/getRealm.js.map +1 -1
- package/getRealmKeys.d.ts +8 -28
- package/getRealmKeys.js +8 -4
- package/getRealmKeys.js.map +1 -1
- package/getRole.d.ts +4 -65
- package/getRole.js +4 -44
- package/getRole.js.map +1 -1
- package/getUser.d.ts +4 -0
- package/getUser.js +4 -0
- package/getUser.js.map +1 -1
- package/getUserRealmRoles.d.ts +4 -0
- package/getUserRealmRoles.js +4 -0
- package/getUserRealmRoles.js.map +1 -1
- package/group.d.ts +35 -58
- package/group.js +35 -16
- package/group.js.map +1 -1
- package/groupMemberships.d.ts +27 -43
- package/groupMemberships.js +27 -16
- package/groupMemberships.js.map +1 -1
- package/groupPermissions.d.ts +13 -0
- package/groupPermissions.js +13 -0
- package/groupPermissions.js.map +1 -1
- package/groupRoles.d.ts +32 -91
- package/groupRoles.js +32 -55
- package/groupRoles.js.map +1 -1
- package/hardcodedAttributeIdentityProviderMapper.d.ts +2 -0
- package/hardcodedAttributeIdentityProviderMapper.js +2 -0
- package/hardcodedAttributeIdentityProviderMapper.js.map +1 -1
- package/hardcodedRoleIdentityMapper.d.ts +2 -0
- package/hardcodedRoleIdentityMapper.js +2 -0
- package/hardcodedRoleIdentityMapper.js.map +1 -1
- package/identityProviderTokenExchangeScopePermission.d.ts +10 -2
- package/identityProviderTokenExchangeScopePermission.js +10 -2
- package/identityProviderTokenExchangeScopePermission.js.map +1 -1
- package/ldap/customMapper.d.ts +10 -2
- package/ldap/customMapper.js +10 -2
- package/ldap/customMapper.js.map +1 -1
- package/ldap/fullNameMapper.d.ts +41 -54
- package/ldap/fullNameMapper.js +32 -18
- package/ldap/fullNameMapper.js.map +1 -1
- package/ldap/groupMapper.d.ts +55 -164
- package/ldap/groupMapper.js +46 -20
- package/ldap/groupMapper.js.map +1 -1
- package/ldap/hardcodedAttributeMapper.d.ts +10 -2
- package/ldap/hardcodedAttributeMapper.js +10 -2
- package/ldap/hardcodedAttributeMapper.js.map +1 -1
- package/ldap/hardcodedGroupMapper.d.ts +10 -2
- package/ldap/hardcodedGroupMapper.js +10 -2
- package/ldap/hardcodedGroupMapper.js.map +1 -1
- package/ldap/hardcodedRoleMapper.d.ts +29 -64
- package/ldap/hardcodedRoleMapper.js +17 -52
- package/ldap/hardcodedRoleMapper.js.map +1 -1
- package/ldap/msadLdsUserAccountControlMapper.d.ts +10 -2
- package/ldap/msadLdsUserAccountControlMapper.js +10 -2
- package/ldap/msadLdsUserAccountControlMapper.js.map +1 -1
- package/ldap/msadUserAccountControlMapper.d.ts +34 -32
- package/ldap/msadUserAccountControlMapper.js +25 -14
- package/ldap/msadUserAccountControlMapper.js.map +1 -1
- package/ldap/roleMapper.d.ts +10 -2
- package/ldap/roleMapper.js +10 -2
- package/ldap/roleMapper.js.map +1 -1
- package/ldap/userAttributeMapper.d.ts +60 -45
- package/ldap/userAttributeMapper.js +30 -15
- package/ldap/userAttributeMapper.js.map +1 -1
- package/ldap/userFederation.d.ts +125 -95
- package/ldap/userFederation.js +53 -20
- package/ldap/userFederation.js.map +1 -1
- package/oidc/googleIdentityProvider.d.ts +8 -2
- package/oidc/googleIdentityProvider.js +8 -2
- package/oidc/googleIdentityProvider.js.map +1 -1
- package/oidc/identityProvider.d.ts +8 -2
- package/oidc/identityProvider.js +8 -2
- package/oidc/identityProvider.js.map +1 -1
- package/openid/audienceProtocolMapper.d.ts +62 -45
- package/openid/audienceProtocolMapper.js +38 -21
- package/openid/audienceProtocolMapper.js.map +1 -1
- package/openid/audienceResolveProtocolMapper.d.ts +17 -3
- package/openid/audienceResolveProtocolMapper.js +17 -3
- package/openid/audienceResolveProtocolMapper.js.map +1 -1
- package/openid/audienceResolveProtocolMappter.d.ts +17 -3
- package/openid/audienceResolveProtocolMappter.js +17 -3
- package/openid/audienceResolveProtocolMappter.js.map +1 -1
- package/openid/client.d.ts +48 -431
- package/openid/client.js +48 -14
- package/openid/client.js.map +1 -1
- package/openid/clientAuthorizationPermission.d.ts +6 -2
- package/openid/clientAuthorizationPermission.js +6 -2
- package/openid/clientAuthorizationPermission.js.map +1 -1
- package/openid/clientDefaultScopes.d.ts +17 -33
- package/openid/clientDefaultScopes.js +17 -6
- package/openid/clientDefaultScopes.js.map +1 -1
- package/openid/clientOptionalScopes.d.ts +17 -34
- package/openid/clientOptionalScopes.js +17 -7
- package/openid/clientOptionalScopes.js.map +1 -1
- package/openid/clientPolicy.d.ts +2 -0
- package/openid/clientPolicy.js +2 -0
- package/openid/clientPolicy.js.map +1 -1
- package/openid/clientScope.d.ts +27 -67
- package/openid/clientScope.js +27 -13
- package/openid/clientScope.js.map +1 -1
- package/openid/clientServiceAccountRealmRole.d.ts +8 -2
- package/openid/clientServiceAccountRealmRole.js +8 -2
- package/openid/clientServiceAccountRealmRole.js.map +1 -1
- package/openid/clientServiceAccountRole.d.ts +8 -2
- package/openid/clientServiceAccountRole.js +8 -2
- package/openid/clientServiceAccountRole.js.map +1 -1
- package/openid/fullNameProtocolMapper.d.ts +49 -61
- package/openid/fullNameProtocolMapper.js +37 -22
- package/openid/fullNameProtocolMapper.js.map +1 -1
- package/openid/getClient.d.ts +32 -14
- package/openid/getClient.js +32 -2
- package/openid/getClient.js.map +1 -1
- package/openid/getClientAuthorizationPolicy.d.ts +4 -0
- package/openid/getClientAuthorizationPolicy.js +4 -0
- package/openid/getClientAuthorizationPolicy.js.map +1 -1
- package/openid/getClientScope.d.ts +4 -0
- package/openid/getClientScope.js +4 -0
- package/openid/getClientScope.js.map +1 -1
- package/openid/getClientServiceAccountUser.d.ts +4 -0
- package/openid/getClientServiceAccountUser.js +4 -0
- package/openid/getClientServiceAccountUser.js.map +1 -1
- package/openid/groupMembershipProtocolMapper.d.ts +53 -81
- package/openid/groupMembershipProtocolMapper.js +41 -24
- package/openid/groupMembershipProtocolMapper.js.map +1 -1
- package/openid/hardcodedClaimProtocolMapper.d.ts +66 -66
- package/openid/hardcodedClaimProtocolMapper.js +42 -24
- package/openid/hardcodedClaimProtocolMapper.js.map +1 -1
- package/openid/hardcodedRoleProtocolMapper.d.ts +48 -43
- package/openid/hardcodedRoleProtocolMapper.js +36 -22
- package/openid/hardcodedRoleProtocolMapper.js.map +1 -1
- package/openid/scriptProtocolMapper.d.ts +17 -3
- package/openid/scriptProtocolMapper.js +17 -3
- package/openid/scriptProtocolMapper.js.map +1 -1
- package/openid/userAttributeProtocolMapper.d.ts +73 -72
- package/openid/userAttributeProtocolMapper.js +43 -24
- package/openid/userAttributeProtocolMapper.js.map +1 -1
- package/openid/userClientRoleProtocolMapper.d.ts +17 -3
- package/openid/userClientRoleProtocolMapper.js +17 -3
- package/openid/userClientRoleProtocolMapper.js.map +1 -1
- package/openid/userPropertyProtocolMapper.d.ts +66 -67
- package/openid/userPropertyProtocolMapper.js +42 -25
- package/openid/userPropertyProtocolMapper.js.map +1 -1
- package/openid/userRealmRoleProtocolMapper.d.ts +73 -63
- package/openid/userRealmRoleProtocolMapper.js +43 -24
- package/openid/userRealmRoleProtocolMapper.js.map +1 -1
- package/openid/userSessionNoteProtocolMapper.d.ts +17 -3
- package/openid/userSessionNoteProtocolMapper.js +17 -3
- package/openid/userSessionNoteProtocolMapper.js.map +1 -1
- package/package.json +1 -1
- package/realm.d.ts +30 -509
- package/realm.js +0 -83
- package/realm.js.map +1 -1
- package/realmEvents.d.ts +20 -74
- package/realmEvents.js +20 -11
- package/realmEvents.js.map +1 -1
- package/realmKeystoreAesGenerated.d.ts +8 -2
- package/realmKeystoreAesGenerated.js +8 -2
- package/realmKeystoreAesGenerated.js.map +1 -1
- package/realmKeystoreEcdsaGenerated.d.ts +8 -2
- package/realmKeystoreEcdsaGenerated.js +8 -2
- package/realmKeystoreEcdsaGenerated.js.map +1 -1
- package/realmKeystoreHmacGenerated.d.ts +8 -2
- package/realmKeystoreHmacGenerated.js +8 -2
- package/realmKeystoreHmacGenerated.js.map +1 -1
- package/realmKeystoreJavaGenerated.d.ts +8 -2
- package/realmKeystoreJavaGenerated.js +8 -2
- package/realmKeystoreJavaGenerated.js.map +1 -1
- package/realmKeystoreRsa.d.ts +6 -2
- package/realmKeystoreRsa.js +6 -2
- package/realmKeystoreRsa.js.map +1 -1
- package/realmKeystoreRsaGenerated.d.ts +8 -2
- package/realmKeystoreRsaGenerated.js +8 -2
- package/realmKeystoreRsaGenerated.js.map +1 -1
- package/realmUserProfile.d.ts +2 -0
- package/realmUserProfile.js +2 -0
- package/realmUserProfile.js.map +1 -1
- package/requiredAction.d.ts +8 -2
- package/requiredAction.js +8 -2
- package/requiredAction.js.map +1 -1
- package/role.d.ts +58 -125
- package/role.js +58 -71
- package/role.js.map +1 -1
- package/saml/client.d.ts +46 -327
- package/saml/client.js +46 -12
- package/saml/client.js.map +1 -1
- package/saml/clientDefaultScope.d.ts +5 -1
- package/saml/clientDefaultScope.js +5 -1
- package/saml/clientDefaultScope.js.map +1 -1
- package/saml/clientScope.d.ts +10 -2
- package/saml/clientScope.js +10 -2
- package/saml/clientScope.js.map +1 -1
- package/saml/getClient.d.ts +4 -0
- package/saml/getClient.js +4 -0
- package/saml/getClient.js.map +1 -1
- package/saml/getClientInstallationProvider.d.ts +4 -0
- package/saml/getClientInstallationProvider.js +4 -0
- package/saml/getClientInstallationProvider.js.map +1 -1
- package/saml/identityProvider.d.ts +163 -117
- package/saml/identityProvider.js +52 -21
- package/saml/identityProvider.js.map +1 -1
- package/saml/scriptProtocolMapper.d.ts +13 -3
- package/saml/scriptProtocolMapper.js +13 -3
- package/saml/scriptProtocolMapper.js.map +1 -1
- package/saml/userAttributeProtocolMapper.d.ts +32 -91
- package/saml/userAttributeProtocolMapper.js +32 -19
- package/saml/userAttributeProtocolMapper.js.map +1 -1
- package/saml/userPropertyProtocolMapper.d.ts +32 -91
- package/saml/userPropertyProtocolMapper.js +32 -19
- package/saml/userPropertyProtocolMapper.js.map +1 -1
- package/types/input.d.ts +74 -183
- package/types/output.d.ts +44 -207
- package/user.d.ts +36 -112
- package/user.js +36 -22
- package/user.js.map +1 -1
- package/userGroups.d.ts +9 -1
- package/userGroups.js +9 -1
- package/userGroups.js.map +1 -1
- package/userRoles.d.ts +11 -2
- package/userRoles.js +11 -2
- package/userRoles.js.map +1 -1
- package/userTemplateImporterIdentityProviderMapper.d.ts +10 -2
- package/userTemplateImporterIdentityProviderMapper.js +10 -2
- package/userTemplateImporterIdentityProviderMapper.js.map +1 -1
- package/usersPermissions.d.ts +10 -25
- package/usersPermissions.js +10 -25
- package/usersPermissions.js.map +1 -1
|
@@ -1,67 +1,86 @@
|
|
|
1
1
|
import * as pulumi from "@pulumi/pulumi";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* ## # keycloak.openid.UserAttributeProtocolMapper
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Allows for creating and managing user attribute protocol mappers within
|
|
6
|
+
* Keycloak.
|
|
6
7
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
8
|
+
* User attribute protocol mappers allow you to map custom attributes defined
|
|
9
|
+
* for a user within Keycloak to a claim in a token. Protocol mappers can be
|
|
10
|
+
* defined for a single client, or they can be defined for a client scope which
|
|
11
|
+
* can be shared between multiple different clients.
|
|
9
12
|
*
|
|
10
|
-
*
|
|
11
|
-
* ### Client)
|
|
13
|
+
* ### Example Usage (Client)
|
|
12
14
|
*
|
|
15
|
+
* <!--Start PulumiCodeChooser -->
|
|
13
16
|
* ```typescript
|
|
14
17
|
* import * as pulumi from "@pulumi/pulumi";
|
|
15
18
|
* import * as keycloak from "@pulumi/keycloak";
|
|
16
19
|
*
|
|
17
20
|
* const realm = new keycloak.Realm("realm", {
|
|
18
|
-
* realm: "my-realm",
|
|
19
21
|
* enabled: true,
|
|
22
|
+
* realm: "my-realm",
|
|
20
23
|
* });
|
|
21
24
|
* const openidClient = new keycloak.openid.Client("openidClient", {
|
|
22
|
-
* realmId: realm.id,
|
|
23
|
-
* clientId: "client",
|
|
24
|
-
* enabled: true,
|
|
25
25
|
* accessType: "CONFIDENTIAL",
|
|
26
|
+
* clientId: "test-client",
|
|
27
|
+
* enabled: true,
|
|
28
|
+
* realmId: realm.id,
|
|
26
29
|
* validRedirectUris: ["http://localhost:8080/openid-callback"],
|
|
27
30
|
* });
|
|
28
31
|
* const userAttributeMapper = new keycloak.openid.UserAttributeProtocolMapper("userAttributeMapper", {
|
|
29
|
-
*
|
|
32
|
+
* claimName: "bar",
|
|
30
33
|
* clientId: openidClient.id,
|
|
34
|
+
* realmId: realm.id,
|
|
31
35
|
* userAttribute: "foo",
|
|
32
|
-
* claimName: "bar",
|
|
33
36
|
* });
|
|
34
37
|
* ```
|
|
35
|
-
*
|
|
38
|
+
* <!--End PulumiCodeChooser -->
|
|
39
|
+
*
|
|
40
|
+
* ### Example Usage (Client Scope)
|
|
36
41
|
*
|
|
42
|
+
* <!--Start PulumiCodeChooser -->
|
|
37
43
|
* ```typescript
|
|
38
44
|
* import * as pulumi from "@pulumi/pulumi";
|
|
39
45
|
* import * as keycloak from "@pulumi/keycloak";
|
|
40
46
|
*
|
|
41
47
|
* const realm = new keycloak.Realm("realm", {
|
|
42
|
-
* realm: "my-realm",
|
|
43
48
|
* enabled: true,
|
|
49
|
+
* realm: "my-realm",
|
|
44
50
|
* });
|
|
45
51
|
* const clientScope = new keycloak.openid.ClientScope("clientScope", {realmId: realm.id});
|
|
46
52
|
* const userAttributeMapper = new keycloak.openid.UserAttributeProtocolMapper("userAttributeMapper", {
|
|
47
|
-
*
|
|
53
|
+
* claimName: "bar",
|
|
48
54
|
* clientScopeId: clientScope.id,
|
|
55
|
+
* realmId: realm.id,
|
|
49
56
|
* userAttribute: "foo",
|
|
50
|
-
* claimName: "bar",
|
|
51
57
|
* });
|
|
52
58
|
* ```
|
|
59
|
+
* <!--End PulumiCodeChooser -->
|
|
53
60
|
*
|
|
54
|
-
*
|
|
61
|
+
* ### Argument Reference
|
|
55
62
|
*
|
|
56
|
-
*
|
|
63
|
+
* The following arguments are supported:
|
|
57
64
|
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
65
|
+
* - `realmId` - (Required) The realm this protocol mapper exists within.
|
|
66
|
+
* - `clientId` - (Required if `clientScopeId` is not specified) The client this protocol mapper is attached to.
|
|
67
|
+
* - `clientScopeId` - (Required if `clientId` is not specified) The client scope this protocol mapper is attached to.
|
|
68
|
+
* - `name` - (Required) The display name of this protocol mapper in the GUI.
|
|
69
|
+
* - `userAttribute` - (Required) The custom user attribute to map a claim for.
|
|
70
|
+
* - `claimName` - (Required) The name of the claim to insert into a token.
|
|
71
|
+
* - `claimValueType` - (Optional) The claim type used when serializing JSON tokens. Can be one of `String`, `long`, `int`, or `boolean`. Defaults to `String`.
|
|
72
|
+
* - `multivalued` - (Optional) Indicates whether this attribute is a single value or an array of values. Defaults to `false`.
|
|
73
|
+
* - `addToIdToken` - (Optional) Indicates if the attribute should be added as a claim to the id token. Defaults to `true`.
|
|
74
|
+
* - `addToAccessToken` - (Optional) Indicates if the attribute should be added as a claim to the access token. Defaults to `true`.
|
|
75
|
+
* - `addToUserinfo` - (Optional) Indicates if the attribute should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
61
76
|
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
77
|
+
* ### Import
|
|
78
|
+
*
|
|
79
|
+
* Protocol mappers can be imported using one of the following formats:
|
|
80
|
+
* - Client: `{{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}`
|
|
81
|
+
* - Client Scope: `{{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}`
|
|
82
|
+
*
|
|
83
|
+
* Example:
|
|
65
84
|
*/
|
|
66
85
|
export declare class UserAttributeProtocolMapper extends pulumi.CustomResource {
|
|
67
86
|
/**
|
|
@@ -80,52 +99,46 @@ export declare class UserAttributeProtocolMapper extends pulumi.CustomResource {
|
|
|
80
99
|
*/
|
|
81
100
|
static isInstance(obj: any): obj is UserAttributeProtocolMapper;
|
|
82
101
|
/**
|
|
83
|
-
* Indicates if the attribute should be
|
|
102
|
+
* Indicates if the attribute should be a claim in the access token.
|
|
84
103
|
*/
|
|
85
104
|
readonly addToAccessToken: pulumi.Output<boolean | undefined>;
|
|
86
105
|
/**
|
|
87
|
-
* Indicates if the attribute should be
|
|
106
|
+
* Indicates if the attribute should be a claim in the id token.
|
|
88
107
|
*/
|
|
89
108
|
readonly addToIdToken: pulumi.Output<boolean | undefined>;
|
|
90
109
|
/**
|
|
91
|
-
* Indicates if the attribute should
|
|
110
|
+
* Indicates if the attribute should appear in the userinfo response body.
|
|
92
111
|
*/
|
|
93
112
|
readonly addToUserinfo: pulumi.Output<boolean | undefined>;
|
|
94
113
|
/**
|
|
95
|
-
* Indicates
|
|
114
|
+
* Indicates if attribute values should be aggregated within the group attributes
|
|
96
115
|
*/
|
|
97
116
|
readonly aggregateAttributes: pulumi.Output<boolean | undefined>;
|
|
98
|
-
/**
|
|
99
|
-
* The name of the claim to insert into a token.
|
|
100
|
-
*/
|
|
101
117
|
readonly claimName: pulumi.Output<string>;
|
|
102
118
|
/**
|
|
103
|
-
*
|
|
119
|
+
* Claim type used when serializing tokens.
|
|
104
120
|
*/
|
|
105
121
|
readonly claimValueType: pulumi.Output<string | undefined>;
|
|
106
122
|
/**
|
|
107
|
-
* The
|
|
123
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
108
124
|
*/
|
|
109
125
|
readonly clientId: pulumi.Output<string | undefined>;
|
|
110
126
|
/**
|
|
111
|
-
* The
|
|
127
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
112
128
|
*/
|
|
113
129
|
readonly clientScopeId: pulumi.Output<string | undefined>;
|
|
114
130
|
/**
|
|
115
|
-
* Indicates whether this attribute is a single value or an array of values.
|
|
131
|
+
* Indicates whether this attribute is a single value or an array of values.
|
|
116
132
|
*/
|
|
117
133
|
readonly multivalued: pulumi.Output<boolean | undefined>;
|
|
118
134
|
/**
|
|
119
|
-
*
|
|
135
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
120
136
|
*/
|
|
121
137
|
readonly name: pulumi.Output<string>;
|
|
122
138
|
/**
|
|
123
|
-
* The realm
|
|
139
|
+
* The realm id where the associated client or client scope exists.
|
|
124
140
|
*/
|
|
125
141
|
readonly realmId: pulumi.Output<string>;
|
|
126
|
-
/**
|
|
127
|
-
* The custom user attribute to map a claim for.
|
|
128
|
-
*/
|
|
129
142
|
readonly userAttribute: pulumi.Output<string>;
|
|
130
143
|
/**
|
|
131
144
|
* Create a UserAttributeProtocolMapper resource with the given unique name, arguments, and options.
|
|
@@ -141,52 +154,46 @@ export declare class UserAttributeProtocolMapper extends pulumi.CustomResource {
|
|
|
141
154
|
*/
|
|
142
155
|
export interface UserAttributeProtocolMapperState {
|
|
143
156
|
/**
|
|
144
|
-
* Indicates if the attribute should be
|
|
157
|
+
* Indicates if the attribute should be a claim in the access token.
|
|
145
158
|
*/
|
|
146
159
|
addToAccessToken?: pulumi.Input<boolean>;
|
|
147
160
|
/**
|
|
148
|
-
* Indicates if the attribute should be
|
|
161
|
+
* Indicates if the attribute should be a claim in the id token.
|
|
149
162
|
*/
|
|
150
163
|
addToIdToken?: pulumi.Input<boolean>;
|
|
151
164
|
/**
|
|
152
|
-
* Indicates if the attribute should
|
|
165
|
+
* Indicates if the attribute should appear in the userinfo response body.
|
|
153
166
|
*/
|
|
154
167
|
addToUserinfo?: pulumi.Input<boolean>;
|
|
155
168
|
/**
|
|
156
|
-
* Indicates
|
|
169
|
+
* Indicates if attribute values should be aggregated within the group attributes
|
|
157
170
|
*/
|
|
158
171
|
aggregateAttributes?: pulumi.Input<boolean>;
|
|
159
|
-
/**
|
|
160
|
-
* The name of the claim to insert into a token.
|
|
161
|
-
*/
|
|
162
172
|
claimName?: pulumi.Input<string>;
|
|
163
173
|
/**
|
|
164
|
-
*
|
|
174
|
+
* Claim type used when serializing tokens.
|
|
165
175
|
*/
|
|
166
176
|
claimValueType?: pulumi.Input<string>;
|
|
167
177
|
/**
|
|
168
|
-
* The
|
|
178
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
169
179
|
*/
|
|
170
180
|
clientId?: pulumi.Input<string>;
|
|
171
181
|
/**
|
|
172
|
-
* The
|
|
182
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
173
183
|
*/
|
|
174
184
|
clientScopeId?: pulumi.Input<string>;
|
|
175
185
|
/**
|
|
176
|
-
* Indicates whether this attribute is a single value or an array of values.
|
|
186
|
+
* Indicates whether this attribute is a single value or an array of values.
|
|
177
187
|
*/
|
|
178
188
|
multivalued?: pulumi.Input<boolean>;
|
|
179
189
|
/**
|
|
180
|
-
*
|
|
190
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
181
191
|
*/
|
|
182
192
|
name?: pulumi.Input<string>;
|
|
183
193
|
/**
|
|
184
|
-
* The realm
|
|
194
|
+
* The realm id where the associated client or client scope exists.
|
|
185
195
|
*/
|
|
186
196
|
realmId?: pulumi.Input<string>;
|
|
187
|
-
/**
|
|
188
|
-
* The custom user attribute to map a claim for.
|
|
189
|
-
*/
|
|
190
197
|
userAttribute?: pulumi.Input<string>;
|
|
191
198
|
}
|
|
192
199
|
/**
|
|
@@ -194,51 +201,45 @@ export interface UserAttributeProtocolMapperState {
|
|
|
194
201
|
*/
|
|
195
202
|
export interface UserAttributeProtocolMapperArgs {
|
|
196
203
|
/**
|
|
197
|
-
* Indicates if the attribute should be
|
|
204
|
+
* Indicates if the attribute should be a claim in the access token.
|
|
198
205
|
*/
|
|
199
206
|
addToAccessToken?: pulumi.Input<boolean>;
|
|
200
207
|
/**
|
|
201
|
-
* Indicates if the attribute should be
|
|
208
|
+
* Indicates if the attribute should be a claim in the id token.
|
|
202
209
|
*/
|
|
203
210
|
addToIdToken?: pulumi.Input<boolean>;
|
|
204
211
|
/**
|
|
205
|
-
* Indicates if the attribute should
|
|
212
|
+
* Indicates if the attribute should appear in the userinfo response body.
|
|
206
213
|
*/
|
|
207
214
|
addToUserinfo?: pulumi.Input<boolean>;
|
|
208
215
|
/**
|
|
209
|
-
* Indicates
|
|
216
|
+
* Indicates if attribute values should be aggregated within the group attributes
|
|
210
217
|
*/
|
|
211
218
|
aggregateAttributes?: pulumi.Input<boolean>;
|
|
212
|
-
/**
|
|
213
|
-
* The name of the claim to insert into a token.
|
|
214
|
-
*/
|
|
215
219
|
claimName: pulumi.Input<string>;
|
|
216
220
|
/**
|
|
217
|
-
*
|
|
221
|
+
* Claim type used when serializing tokens.
|
|
218
222
|
*/
|
|
219
223
|
claimValueType?: pulumi.Input<string>;
|
|
220
224
|
/**
|
|
221
|
-
* The
|
|
225
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
222
226
|
*/
|
|
223
227
|
clientId?: pulumi.Input<string>;
|
|
224
228
|
/**
|
|
225
|
-
* The
|
|
229
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
226
230
|
*/
|
|
227
231
|
clientScopeId?: pulumi.Input<string>;
|
|
228
232
|
/**
|
|
229
|
-
* Indicates whether this attribute is a single value or an array of values.
|
|
233
|
+
* Indicates whether this attribute is a single value or an array of values.
|
|
230
234
|
*/
|
|
231
235
|
multivalued?: pulumi.Input<boolean>;
|
|
232
236
|
/**
|
|
233
|
-
*
|
|
237
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
234
238
|
*/
|
|
235
239
|
name?: pulumi.Input<string>;
|
|
236
240
|
/**
|
|
237
|
-
* The realm
|
|
241
|
+
* The realm id where the associated client or client scope exists.
|
|
238
242
|
*/
|
|
239
243
|
realmId: pulumi.Input<string>;
|
|
240
|
-
/**
|
|
241
|
-
* The custom user attribute to map a claim for.
|
|
242
|
-
*/
|
|
243
244
|
userAttribute: pulumi.Input<string>;
|
|
244
245
|
}
|
|
@@ -6,68 +6,87 @@ exports.UserAttributeProtocolMapper = void 0;
|
|
|
6
6
|
const pulumi = require("@pulumi/pulumi");
|
|
7
7
|
const utilities = require("../utilities");
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* ## # keycloak.openid.UserAttributeProtocolMapper
|
|
10
10
|
*
|
|
11
|
-
*
|
|
11
|
+
* Allows for creating and managing user attribute protocol mappers within
|
|
12
|
+
* Keycloak.
|
|
12
13
|
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
14
|
+
* User attribute protocol mappers allow you to map custom attributes defined
|
|
15
|
+
* for a user within Keycloak to a claim in a token. Protocol mappers can be
|
|
16
|
+
* defined for a single client, or they can be defined for a client scope which
|
|
17
|
+
* can be shared between multiple different clients.
|
|
15
18
|
*
|
|
16
|
-
*
|
|
17
|
-
* ### Client)
|
|
19
|
+
* ### Example Usage (Client)
|
|
18
20
|
*
|
|
21
|
+
* <!--Start PulumiCodeChooser -->
|
|
19
22
|
* ```typescript
|
|
20
23
|
* import * as pulumi from "@pulumi/pulumi";
|
|
21
24
|
* import * as keycloak from "@pulumi/keycloak";
|
|
22
25
|
*
|
|
23
26
|
* const realm = new keycloak.Realm("realm", {
|
|
24
|
-
* realm: "my-realm",
|
|
25
27
|
* enabled: true,
|
|
28
|
+
* realm: "my-realm",
|
|
26
29
|
* });
|
|
27
30
|
* const openidClient = new keycloak.openid.Client("openidClient", {
|
|
28
|
-
* realmId: realm.id,
|
|
29
|
-
* clientId: "client",
|
|
30
|
-
* enabled: true,
|
|
31
31
|
* accessType: "CONFIDENTIAL",
|
|
32
|
+
* clientId: "test-client",
|
|
33
|
+
* enabled: true,
|
|
34
|
+
* realmId: realm.id,
|
|
32
35
|
* validRedirectUris: ["http://localhost:8080/openid-callback"],
|
|
33
36
|
* });
|
|
34
37
|
* const userAttributeMapper = new keycloak.openid.UserAttributeProtocolMapper("userAttributeMapper", {
|
|
35
|
-
*
|
|
38
|
+
* claimName: "bar",
|
|
36
39
|
* clientId: openidClient.id,
|
|
40
|
+
* realmId: realm.id,
|
|
37
41
|
* userAttribute: "foo",
|
|
38
|
-
* claimName: "bar",
|
|
39
42
|
* });
|
|
40
43
|
* ```
|
|
41
|
-
*
|
|
44
|
+
* <!--End PulumiCodeChooser -->
|
|
45
|
+
*
|
|
46
|
+
* ### Example Usage (Client Scope)
|
|
42
47
|
*
|
|
48
|
+
* <!--Start PulumiCodeChooser -->
|
|
43
49
|
* ```typescript
|
|
44
50
|
* import * as pulumi from "@pulumi/pulumi";
|
|
45
51
|
* import * as keycloak from "@pulumi/keycloak";
|
|
46
52
|
*
|
|
47
53
|
* const realm = new keycloak.Realm("realm", {
|
|
48
|
-
* realm: "my-realm",
|
|
49
54
|
* enabled: true,
|
|
55
|
+
* realm: "my-realm",
|
|
50
56
|
* });
|
|
51
57
|
* const clientScope = new keycloak.openid.ClientScope("clientScope", {realmId: realm.id});
|
|
52
58
|
* const userAttributeMapper = new keycloak.openid.UserAttributeProtocolMapper("userAttributeMapper", {
|
|
53
|
-
*
|
|
59
|
+
* claimName: "bar",
|
|
54
60
|
* clientScopeId: clientScope.id,
|
|
61
|
+
* realmId: realm.id,
|
|
55
62
|
* userAttribute: "foo",
|
|
56
|
-
* claimName: "bar",
|
|
57
63
|
* });
|
|
58
64
|
* ```
|
|
65
|
+
* <!--End PulumiCodeChooser -->
|
|
59
66
|
*
|
|
60
|
-
*
|
|
67
|
+
* ### Argument Reference
|
|
61
68
|
*
|
|
62
|
-
*
|
|
69
|
+
* The following arguments are supported:
|
|
63
70
|
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
71
|
+
* - `realmId` - (Required) The realm this protocol mapper exists within.
|
|
72
|
+
* - `clientId` - (Required if `clientScopeId` is not specified) The client this protocol mapper is attached to.
|
|
73
|
+
* - `clientScopeId` - (Required if `clientId` is not specified) The client scope this protocol mapper is attached to.
|
|
74
|
+
* - `name` - (Required) The display name of this protocol mapper in the GUI.
|
|
75
|
+
* - `userAttribute` - (Required) The custom user attribute to map a claim for.
|
|
76
|
+
* - `claimName` - (Required) The name of the claim to insert into a token.
|
|
77
|
+
* - `claimValueType` - (Optional) The claim type used when serializing JSON tokens. Can be one of `String`, `long`, `int`, or `boolean`. Defaults to `String`.
|
|
78
|
+
* - `multivalued` - (Optional) Indicates whether this attribute is a single value or an array of values. Defaults to `false`.
|
|
79
|
+
* - `addToIdToken` - (Optional) Indicates if the attribute should be added as a claim to the id token. Defaults to `true`.
|
|
80
|
+
* - `addToAccessToken` - (Optional) Indicates if the attribute should be added as a claim to the access token. Defaults to `true`.
|
|
81
|
+
* - `addToUserinfo` - (Optional) Indicates if the attribute should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
67
82
|
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
83
|
+
* ### Import
|
|
84
|
+
*
|
|
85
|
+
* Protocol mappers can be imported using one of the following formats:
|
|
86
|
+
* - Client: `{{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}`
|
|
87
|
+
* - Client Scope: `{{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}`
|
|
88
|
+
*
|
|
89
|
+
* Example:
|
|
71
90
|
*/
|
|
72
91
|
class UserAttributeProtocolMapper extends pulumi.CustomResource {
|
|
73
92
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userAttributeProtocolMapper.js","sourceRoot":"","sources":["../../openid/userAttributeProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"userAttributeProtocolMapper.js","sourceRoot":"","sources":["../../openid/userAttributeProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkFG;AACH,MAAa,2BAA4B,SAAQ,MAAM,CAAC,cAAc;IAClE;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAwC,EAAE,IAAmC;QACtI,OAAO,IAAI,2BAA2B,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClF,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,2BAA2B,CAAC,YAAY,CAAC;IAC5E,CAAC;IAqDD,YAAY,IAAY,EAAE,WAAgF,EAAE,IAAmC;QAC3I,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA2D,CAAC;YAC1E,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,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,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7E;aAAM;YACH,MAAM,IAAI,GAAG,WAA0D,CAAC;YACxE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;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,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,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,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,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3E;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,2BAA2B,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAChF,CAAC;;AA1HL,kEA2HC;AA7GG,gBAAgB;AACO,wCAAY,GAAG,yEAAyE,CAAC"}
|
|
@@ -8,8 +8,10 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
8
8
|
* multiple different clients.
|
|
9
9
|
*
|
|
10
10
|
* ## Example Usage
|
|
11
|
+
*
|
|
11
12
|
* ### Client)
|
|
12
13
|
*
|
|
14
|
+
* <!--Start PulumiCodeChooser -->
|
|
13
15
|
* ```typescript
|
|
14
16
|
* import * as pulumi from "@pulumi/pulumi";
|
|
15
17
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -31,8 +33,11 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
31
33
|
* claimName: "foo",
|
|
32
34
|
* });
|
|
33
35
|
* ```
|
|
36
|
+
* <!--End PulumiCodeChooser -->
|
|
37
|
+
*
|
|
34
38
|
* ### Client Scope)
|
|
35
39
|
*
|
|
40
|
+
* <!--Start PulumiCodeChooser -->
|
|
36
41
|
* ```typescript
|
|
37
42
|
* import * as pulumi from "@pulumi/pulumi";
|
|
38
43
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -48,17 +53,26 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
48
53
|
* claimName: "foo",
|
|
49
54
|
* });
|
|
50
55
|
* ```
|
|
56
|
+
* <!--End PulumiCodeChooser -->
|
|
51
57
|
*
|
|
52
58
|
* ## Import
|
|
53
59
|
*
|
|
54
|
-
* Protocol mappers can be imported using one of the following formats
|
|
60
|
+
* Protocol mappers can be imported using one of the following formats:
|
|
61
|
+
*
|
|
62
|
+
* - Client: `{{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}`
|
|
63
|
+
*
|
|
64
|
+
* - Client Scope: `{{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}`
|
|
65
|
+
*
|
|
66
|
+
* Example:
|
|
67
|
+
*
|
|
68
|
+
* bash
|
|
55
69
|
*
|
|
56
70
|
* ```sh
|
|
57
|
-
*
|
|
71
|
+
* $ pulumi import keycloak:openid/userClientRoleProtocolMapper:UserClientRoleProtocolMapper user_client_role_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
58
72
|
* ```
|
|
59
73
|
*
|
|
60
74
|
* ```sh
|
|
61
|
-
*
|
|
75
|
+
* $ pulumi import keycloak:openid/userClientRoleProtocolMapper:UserClientRoleProtocolMapper user_client_role_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
62
76
|
* ```
|
|
63
77
|
*/
|
|
64
78
|
export declare class UserClientRoleProtocolMapper extends pulumi.CustomResource {
|
|
@@ -14,8 +14,10 @@ const utilities = require("../utilities");
|
|
|
14
14
|
* multiple different clients.
|
|
15
15
|
*
|
|
16
16
|
* ## Example Usage
|
|
17
|
+
*
|
|
17
18
|
* ### Client)
|
|
18
19
|
*
|
|
20
|
+
* <!--Start PulumiCodeChooser -->
|
|
19
21
|
* ```typescript
|
|
20
22
|
* import * as pulumi from "@pulumi/pulumi";
|
|
21
23
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -37,8 +39,11 @@ const utilities = require("../utilities");
|
|
|
37
39
|
* claimName: "foo",
|
|
38
40
|
* });
|
|
39
41
|
* ```
|
|
42
|
+
* <!--End PulumiCodeChooser -->
|
|
43
|
+
*
|
|
40
44
|
* ### Client Scope)
|
|
41
45
|
*
|
|
46
|
+
* <!--Start PulumiCodeChooser -->
|
|
42
47
|
* ```typescript
|
|
43
48
|
* import * as pulumi from "@pulumi/pulumi";
|
|
44
49
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -54,17 +59,26 @@ const utilities = require("../utilities");
|
|
|
54
59
|
* claimName: "foo",
|
|
55
60
|
* });
|
|
56
61
|
* ```
|
|
62
|
+
* <!--End PulumiCodeChooser -->
|
|
57
63
|
*
|
|
58
64
|
* ## Import
|
|
59
65
|
*
|
|
60
|
-
* Protocol mappers can be imported using one of the following formats
|
|
66
|
+
* Protocol mappers can be imported using one of the following formats:
|
|
67
|
+
*
|
|
68
|
+
* - Client: `{{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}`
|
|
69
|
+
*
|
|
70
|
+
* - Client Scope: `{{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}`
|
|
71
|
+
*
|
|
72
|
+
* Example:
|
|
73
|
+
*
|
|
74
|
+
* bash
|
|
61
75
|
*
|
|
62
76
|
* ```sh
|
|
63
|
-
*
|
|
77
|
+
* $ pulumi import keycloak:openid/userClientRoleProtocolMapper:UserClientRoleProtocolMapper user_client_role_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
64
78
|
* ```
|
|
65
79
|
*
|
|
66
80
|
* ```sh
|
|
67
|
-
*
|
|
81
|
+
* $ pulumi import keycloak:openid/userClientRoleProtocolMapper:UserClientRoleProtocolMapper user_client_role_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
68
82
|
* ```
|
|
69
83
|
*/
|
|
70
84
|
class UserClientRoleProtocolMapper extends pulumi.CustomResource {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userClientRoleProtocolMapper.js","sourceRoot":"","sources":["../../openid/userClientRoleProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"userClientRoleProtocolMapper.js","sourceRoot":"","sources":["../../openid/userClientRoleProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAa,4BAA6B,SAAQ,MAAM,CAAC,cAAc;IACnE;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAyC,EAAE,IAAmC;QACvI,OAAO,IAAI,4BAA4B,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACnF,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,4BAA4B,CAAC,YAAY,CAAC;IAC7E,CAAC;IA2DD,YAAY,IAAY,EAAE,WAAkF,EAAE,IAAmC;QAC7I,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA4D,CAAC;YAC3E,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9F,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,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,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACH,MAAM,IAAI,GAAG,WAA2D,CAAC;YACzE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;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,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5F,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,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,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,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,4BAA4B,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;;AA7HL,oEA8HC;AAhHG,gBAAgB;AACO,yCAAY,GAAG,2EAA2E,CAAC"}
|