@pulumi/keycloak 5.3.0 → 5.3.2
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 +45 -63
- package/attributeImporterIdentityProviderMapper.js +24 -33
- package/attributeImporterIdentityProviderMapper.js.map +1 -1
- package/attributeToRoleIdentityMapper.d.ts +14 -6
- package/attributeToRoleIdentityMapper.js +14 -6
- package/attributeToRoleIdentityMapper.js.map +1 -1
- package/authentication/bindings.d.ts +3 -3
- package/authentication/bindings.js +3 -3
- package/authentication/execution.d.ts +8 -4
- package/authentication/execution.js +8 -4
- package/authentication/execution.js.map +1 -1
- package/authentication/executionConfig.d.ts +10 -2
- package/authentication/executionConfig.js +10 -2
- package/authentication/executionConfig.js.map +1 -1
- package/authentication/flow.d.ts +14 -2
- package/authentication/flow.js +14 -2
- package/authentication/flow.js.map +1 -1
- package/authentication/subflow.d.ts +16 -2
- package/authentication/subflow.js +16 -2
- package/authentication/subflow.js.map +1 -1
- package/customIdentityProviderMapping.d.ts +12 -5
- package/customIdentityProviderMapping.js +12 -5
- package/customIdentityProviderMapping.js.map +1 -1
- package/customUserFederation.d.ts +48 -48
- package/customUserFederation.js +24 -12
- package/customUserFederation.js.map +1 -1
- package/defaultGroups.d.ts +19 -26
- package/defaultGroups.js +19 -8
- package/defaultGroups.js.map +1 -1
- package/defaultRoles.d.ts +12 -3
- package/defaultRoles.js +12 -3
- package/defaultRoles.js.map +1 -1
- package/genericClientProtocolMapper.d.ts +36 -34
- package/genericClientProtocolMapper.js +21 -10
- package/genericClientProtocolMapper.js.map +1 -1
- package/genericClientRoleMapper.d.ts +42 -15
- package/genericClientRoleMapper.js +42 -15
- package/genericClientRoleMapper.js.map +1 -1
- package/genericProtocolMapper.d.ts +9 -4
- package/genericProtocolMapper.js +9 -4
- package/genericProtocolMapper.js.map +1 -1
- package/genericRoleMapper.d.ts +42 -15
- package/genericRoleMapper.js +42 -15
- package/genericRoleMapper.js.map +1 -1
- package/getClientDescriptionConverter.d.ts +50 -50
- package/getClientDescriptionConverter.js +50 -50
- package/getGroup.d.ts +4 -62
- package/getGroup.js +4 -50
- package/getGroup.js.map +1 -1
- package/getRealm.d.ts +36 -10
- package/getRealm.js +36 -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 +2 -0
- package/getUser.js +2 -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 +37 -57
- package/group.js +37 -15
- package/group.js.map +1 -1
- package/groupMemberships.d.ts +28 -43
- package/groupMemberships.js +28 -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 +35 -90
- package/groupRoles.js +35 -54
- package/groupRoles.js.map +1 -1
- package/hardcodedAttributeIdentityProviderMapper.d.ts +4 -3
- package/hardcodedAttributeIdentityProviderMapper.js +4 -3
- package/hardcodedAttributeIdentityProviderMapper.js.map +1 -1
- package/hardcodedRoleIdentityMapper.d.ts +6 -4
- package/hardcodedRoleIdentityMapper.js +6 -4
- package/hardcodedRoleIdentityMapper.js.map +1 -1
- package/identityProviderTokenExchangeScopePermission.d.ts +13 -6
- package/identityProviderTokenExchangeScopePermission.js +13 -6
- package/identityProviderTokenExchangeScopePermission.js.map +1 -1
- package/ldap/customMapper.d.ts +14 -6
- package/ldap/customMapper.js +14 -6
- package/ldap/customMapper.js.map +1 -1
- package/ldap/fullNameMapper.d.ts +35 -48
- package/ldap/fullNameMapper.js +26 -12
- package/ldap/fullNameMapper.js.map +1 -1
- package/ldap/groupMapper.d.ts +47 -156
- package/ldap/groupMapper.js +38 -12
- package/ldap/groupMapper.js.map +1 -1
- package/ldap/hardcodedAttributeMapper.d.ts +12 -4
- package/ldap/hardcodedAttributeMapper.js +12 -4
- package/ldap/hardcodedAttributeMapper.js.map +1 -1
- package/ldap/hardcodedGroupMapper.d.ts +16 -5
- package/ldap/hardcodedGroupMapper.js +16 -5
- package/ldap/hardcodedGroupMapper.js.map +1 -1
- package/ldap/hardcodedRoleMapper.d.ts +31 -66
- package/ldap/hardcodedRoleMapper.js +19 -54
- package/ldap/hardcodedRoleMapper.js.map +1 -1
- package/ldap/msadLdsUserAccountControlMapper.d.ts +12 -4
- package/ldap/msadLdsUserAccountControlMapper.js +12 -4
- package/ldap/msadLdsUserAccountControlMapper.js.map +1 -1
- package/ldap/msadUserAccountControlMapper.d.ts +29 -27
- package/ldap/msadUserAccountControlMapper.js +20 -9
- package/ldap/msadUserAccountControlMapper.js.map +1 -1
- package/ldap/roleMapper.d.ts +12 -4
- package/ldap/roleMapper.js +12 -4
- package/ldap/roleMapper.js.map +1 -1
- package/ldap/userAttributeMapper.d.ts +54 -39
- package/ldap/userAttributeMapper.js +24 -9
- package/ldap/userAttributeMapper.js.map +1 -1
- package/ldap/userFederation.d.ts +117 -88
- package/ldap/userFederation.js +45 -13
- package/ldap/userFederation.js.map +1 -1
- package/oidc/googleIdentityProvider.d.ts +8 -4
- package/oidc/googleIdentityProvider.js +8 -4
- package/oidc/googleIdentityProvider.js.map +1 -1
- package/oidc/identityProvider.d.ts +7 -3
- package/oidc/identityProvider.js +7 -3
- package/oidc/identityProvider.js.map +1 -1
- package/openid/audienceProtocolMapper.d.ts +62 -43
- package/openid/audienceProtocolMapper.js +38 -19
- package/openid/audienceProtocolMapper.js.map +1 -1
- package/openid/audienceResolveProtocolMapper.d.ts +22 -7
- package/openid/audienceResolveProtocolMapper.js +22 -7
- package/openid/audienceResolveProtocolMapper.js.map +1 -1
- package/openid/audienceResolveProtocolMappter.d.ts +22 -7
- package/openid/audienceResolveProtocolMappter.js +22 -7
- package/openid/audienceResolveProtocolMappter.js.map +1 -1
- package/openid/client.d.ts +45 -429
- package/openid/client.js +45 -12
- 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 +16 -31
- package/openid/clientDefaultScopes.js +16 -4
- package/openid/clientDefaultScopes.js.map +1 -1
- package/openid/clientOptionalScopes.d.ts +16 -32
- package/openid/clientOptionalScopes.js +16 -5
- package/openid/clientOptionalScopes.js.map +1 -1
- package/openid/clientPolicy.d.ts +5 -3
- package/openid/clientPolicy.js +5 -3
- package/openid/clientPolicy.js.map +1 -1
- package/openid/clientScope.d.ts +25 -66
- package/openid/clientScope.js +25 -12
- package/openid/clientScope.js.map +1 -1
- package/openid/clientServiceAccountRealmRole.d.ts +12 -4
- package/openid/clientServiceAccountRealmRole.js +12 -4
- package/openid/clientServiceAccountRealmRole.js.map +1 -1
- package/openid/clientServiceAccountRole.d.ts +14 -5
- package/openid/clientServiceAccountRole.js +14 -5
- package/openid/clientServiceAccountRole.js.map +1 -1
- package/openid/fullNameProtocolMapper.d.ts +49 -59
- package/openid/fullNameProtocolMapper.js +37 -20
- package/openid/fullNameProtocolMapper.js.map +1 -1
- package/openid/getClient.d.ts +30 -14
- package/openid/getClient.js +30 -2
- package/openid/getClient.js.map +1 -1
- package/openid/getClientAuthorizationPolicy.d.ts +8 -2
- package/openid/getClientAuthorizationPolicy.js +8 -2
- package/openid/getClientAuthorizationPolicy.js.map +1 -1
- package/openid/getClientScope.d.ts +4 -2
- package/openid/getClientScope.js +4 -2
- package/openid/getClientScope.js.map +1 -1
- package/openid/getClientServiceAccountUser.d.ts +4 -2
- package/openid/getClientServiceAccountUser.js +4 -2
- package/openid/getClientServiceAccountUser.js.map +1 -1
- package/openid/groupMembershipProtocolMapper.d.ts +51 -77
- package/openid/groupMembershipProtocolMapper.js +39 -20
- package/openid/groupMembershipProtocolMapper.js.map +1 -1
- package/openid/hardcodedClaimProtocolMapper.d.ts +64 -62
- package/openid/hardcodedClaimProtocolMapper.js +40 -20
- package/openid/hardcodedClaimProtocolMapper.js.map +1 -1
- package/openid/hardcodedRoleProtocolMapper.d.ts +56 -43
- package/openid/hardcodedRoleProtocolMapper.js +44 -22
- package/openid/hardcodedRoleProtocolMapper.js.map +1 -1
- package/openid/scriptProtocolMapper.d.ts +23 -7
- package/openid/scriptProtocolMapper.js +23 -7
- package/openid/scriptProtocolMapper.js.map +1 -1
- package/openid/userAttributeProtocolMapper.d.ts +71 -68
- package/openid/userAttributeProtocolMapper.js +41 -20
- package/openid/userAttributeProtocolMapper.js.map +1 -1
- package/openid/userClientRoleProtocolMapper.d.ts +23 -7
- package/openid/userClientRoleProtocolMapper.js +23 -7
- package/openid/userClientRoleProtocolMapper.js.map +1 -1
- package/openid/userPropertyProtocolMapper.d.ts +64 -63
- package/openid/userPropertyProtocolMapper.js +40 -21
- package/openid/userPropertyProtocolMapper.js.map +1 -1
- package/openid/userRealmRoleProtocolMapper.d.ts +71 -59
- package/openid/userRealmRoleProtocolMapper.js +41 -20
- package/openid/userRealmRoleProtocolMapper.js.map +1 -1
- package/openid/userSessionNoteProtocolMapper.d.ts +23 -7
- package/openid/userSessionNoteProtocolMapper.js +23 -7
- 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 +15 -71
- package/realmEvents.js +15 -8
- package/realmEvents.js.map +1 -1
- package/realmKeystoreAesGenerated.d.ts +8 -3
- package/realmKeystoreAesGenerated.js +8 -3
- package/realmKeystoreAesGenerated.js.map +1 -1
- package/realmKeystoreEcdsaGenerated.d.ts +8 -3
- package/realmKeystoreEcdsaGenerated.js +8 -3
- package/realmKeystoreEcdsaGenerated.js.map +1 -1
- package/realmKeystoreHmacGenerated.d.ts +8 -3
- package/realmKeystoreHmacGenerated.js +8 -3
- package/realmKeystoreHmacGenerated.js.map +1 -1
- package/realmKeystoreJavaGenerated.d.ts +8 -3
- package/realmKeystoreJavaGenerated.js +8 -3
- 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 -3
- package/realmKeystoreRsaGenerated.js +8 -3
- package/realmKeystoreRsaGenerated.js.map +1 -1
- package/realmUserProfile.d.ts +1 -1
- package/realmUserProfile.js +1 -1
- package/requiredAction.d.ts +8 -3
- package/requiredAction.js +8 -3
- package/requiredAction.js.map +1 -1
- package/role.d.ts +57 -110
- package/role.js +57 -56
- package/role.js.map +1 -1
- package/saml/client.d.ts +9 -344
- package/saml/client.js +9 -29
- package/saml/client.js.map +1 -1
- package/saml/clientDefaultScope.d.ts +0 -33
- package/saml/clientDefaultScope.js +0 -33
- package/saml/clientDefaultScope.js.map +1 -1
- package/saml/clientScope.d.ts +10 -3
- package/saml/clientScope.js +10 -3
- package/saml/clientScope.js.map +1 -1
- package/saml/getClient.d.ts +2 -0
- package/saml/getClient.js +2 -0
- package/saml/getClient.js.map +1 -1
- package/saml/getClientInstallationProvider.d.ts +0 -62
- package/saml/getClientInstallationProvider.js +0 -62
- package/saml/getClientInstallationProvider.js.map +1 -1
- package/saml/identityProvider.d.ts +155 -111
- package/saml/identityProvider.js +44 -15
- package/saml/identityProvider.js.map +1 -1
- package/saml/scriptProtocolMapper.d.ts +15 -5
- package/saml/scriptProtocolMapper.js +15 -5
- 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 -231
- package/types/output.d.ts +44 -255
- package/user.d.ts +26 -104
- package/user.js +26 -14
- package/user.js.map +1 -1
- package/userGroups.d.ts +5 -33
- package/userGroups.js +5 -33
- package/userGroups.js.map +1 -1
- package/userRoles.d.ts +16 -6
- package/userRoles.js +16 -6
- package/userRoles.js.map +1 -1
- package/userTemplateImporterIdentityProviderMapper.d.ts +10 -3
- package/userTemplateImporterIdentityProviderMapper.js +10 -3
- package/userTemplateImporterIdentityProviderMapper.js.map +1 -1
- package/usersPermissions.d.ts +10 -25
- package/usersPermissions.js +10 -25
- package/usersPermissions.js.map +1 -1
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import * as pulumi from "@pulumi/pulumi";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* ## # keycloak.openid.UserRealmRoleProtocolMapper
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Allows for creating and managing user realm role protocol mappers within
|
|
6
|
+
* Keycloak.
|
|
6
7
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
8
|
+
* User realm role protocol mappers allow you to define a claim containing the list of the realm roles.
|
|
9
|
+
* Protocol mappers can be defined for a single client, or they can
|
|
10
|
+
* be defined for a client scope which can be shared between multiple different
|
|
11
|
+
* clients.
|
|
9
12
|
*
|
|
10
|
-
*
|
|
11
|
-
* ### Client)
|
|
13
|
+
* ### Example Usage (Client)
|
|
12
14
|
*
|
|
13
15
|
* ```typescript
|
|
14
16
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -18,20 +20,23 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
18
20
|
* realm: "my-realm",
|
|
19
21
|
* enabled: true,
|
|
20
22
|
* });
|
|
21
|
-
* const openidClient = new keycloak.openid.Client("
|
|
23
|
+
* const openidClient = new keycloak.openid.Client("openid_client", {
|
|
22
24
|
* realmId: realm.id,
|
|
23
|
-
* clientId: "client",
|
|
25
|
+
* clientId: "test-client",
|
|
26
|
+
* name: "test client",
|
|
24
27
|
* enabled: true,
|
|
25
28
|
* accessType: "CONFIDENTIAL",
|
|
26
29
|
* validRedirectUris: ["http://localhost:8080/openid-callback"],
|
|
27
30
|
* });
|
|
28
|
-
* const userRealmRoleMapper = new keycloak.openid.UserRealmRoleProtocolMapper("
|
|
31
|
+
* const userRealmRoleMapper = new keycloak.openid.UserRealmRoleProtocolMapper("user_realm_role_mapper", {
|
|
29
32
|
* realmId: realm.id,
|
|
30
33
|
* clientId: openidClient.id,
|
|
34
|
+
* name: "user-realm-role-mapper",
|
|
31
35
|
* claimName: "foo",
|
|
32
36
|
* });
|
|
33
37
|
* ```
|
|
34
|
-
*
|
|
38
|
+
*
|
|
39
|
+
* ### Example Usage (Client Scope)
|
|
35
40
|
*
|
|
36
41
|
* ```typescript
|
|
37
42
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -41,25 +46,41 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
41
46
|
* realm: "my-realm",
|
|
42
47
|
* enabled: true,
|
|
43
48
|
* });
|
|
44
|
-
* const clientScope = new keycloak.openid.ClientScope("
|
|
45
|
-
*
|
|
49
|
+
* const clientScope = new keycloak.openid.ClientScope("client_scope", {
|
|
50
|
+
* realmId: realm.id,
|
|
51
|
+
* name: "test-client-scope",
|
|
52
|
+
* });
|
|
53
|
+
* const userRealmRoleMapper = new keycloak.openid.UserRealmRoleProtocolMapper("user_realm_role_mapper", {
|
|
46
54
|
* realmId: realm.id,
|
|
47
55
|
* clientScopeId: clientScope.id,
|
|
56
|
+
* name: "user-realm-role-mapper",
|
|
48
57
|
* claimName: "foo",
|
|
49
58
|
* });
|
|
50
59
|
* ```
|
|
51
60
|
*
|
|
52
|
-
*
|
|
61
|
+
* ### Argument Reference
|
|
53
62
|
*
|
|
54
|
-
*
|
|
63
|
+
* The following arguments are supported:
|
|
55
64
|
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
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
|
+
* - `claimName` - (Required) The name of the claim to insert into a token.
|
|
70
|
+
* - `claimValueType` - (Optional) The claim type used when serializing JSON tokens. Can be one of `String`, `long`, `int`, or `boolean`. Defaults to `String`.
|
|
71
|
+
* - `multivalued` - (Optional) Indicates if attribute supports multiple values. If true, then the list of all values of this attribute will be set as claim. If false, then just first value will be set as claim. Defaults to `true`.
|
|
72
|
+
* - `realmRolePrefix` - (Optional) A prefix for each Realm Role.
|
|
73
|
+
* - `addToIdToken` - (Optional) Indicates if the property should be added as a claim to the id token. Defaults to `true`.
|
|
74
|
+
* - `addToAccessToken` - (Optional) Indicates if the property should be added as a claim to the access token. Defaults to `true`.
|
|
75
|
+
* - `addToUserinfo` - (Optional) Indicates if the property should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
59
76
|
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
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:
|
|
63
84
|
*/
|
|
64
85
|
export declare class UserRealmRoleProtocolMapper extends pulumi.CustomResource {
|
|
65
86
|
/**
|
|
@@ -78,47 +99,44 @@ export declare class UserRealmRoleProtocolMapper extends pulumi.CustomResource {
|
|
|
78
99
|
*/
|
|
79
100
|
static isInstance(obj: any): obj is UserRealmRoleProtocolMapper;
|
|
80
101
|
/**
|
|
81
|
-
* Indicates if the
|
|
102
|
+
* Indicates if the attribute should be a claim in the access token.
|
|
82
103
|
*/
|
|
83
104
|
readonly addToAccessToken: pulumi.Output<boolean | undefined>;
|
|
84
105
|
/**
|
|
85
|
-
* Indicates if the
|
|
106
|
+
* Indicates if the attribute should be a claim in the id token.
|
|
86
107
|
*/
|
|
87
108
|
readonly addToIdToken: pulumi.Output<boolean | undefined>;
|
|
88
109
|
/**
|
|
89
|
-
* Indicates if the
|
|
110
|
+
* Indicates if the attribute should appear in the userinfo response body.
|
|
90
111
|
*/
|
|
91
112
|
readonly addToUserinfo: pulumi.Output<boolean | undefined>;
|
|
92
|
-
/**
|
|
93
|
-
* The name of the claim to insert into a token.
|
|
94
|
-
*/
|
|
95
113
|
readonly claimName: pulumi.Output<string>;
|
|
96
114
|
/**
|
|
97
|
-
*
|
|
115
|
+
* Claim type used when serializing tokens.
|
|
98
116
|
*/
|
|
99
117
|
readonly claimValueType: pulumi.Output<string | undefined>;
|
|
100
118
|
/**
|
|
101
|
-
* The
|
|
119
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
102
120
|
*/
|
|
103
121
|
readonly clientId: pulumi.Output<string | undefined>;
|
|
104
122
|
/**
|
|
105
|
-
* The
|
|
123
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
106
124
|
*/
|
|
107
125
|
readonly clientScopeId: pulumi.Output<string | undefined>;
|
|
108
126
|
/**
|
|
109
|
-
* Indicates
|
|
127
|
+
* Indicates whether this attribute is a single value or an array of values.
|
|
110
128
|
*/
|
|
111
129
|
readonly multivalued: pulumi.Output<boolean | undefined>;
|
|
112
130
|
/**
|
|
113
|
-
*
|
|
131
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
114
132
|
*/
|
|
115
133
|
readonly name: pulumi.Output<string>;
|
|
116
134
|
/**
|
|
117
|
-
* The realm
|
|
135
|
+
* The realm id where the associated client or client scope exists.
|
|
118
136
|
*/
|
|
119
137
|
readonly realmId: pulumi.Output<string>;
|
|
120
138
|
/**
|
|
121
|
-
*
|
|
139
|
+
* Prefix that will be added to each realm role.
|
|
122
140
|
*/
|
|
123
141
|
readonly realmRolePrefix: pulumi.Output<string | undefined>;
|
|
124
142
|
/**
|
|
@@ -135,47 +153,44 @@ export declare class UserRealmRoleProtocolMapper extends pulumi.CustomResource {
|
|
|
135
153
|
*/
|
|
136
154
|
export interface UserRealmRoleProtocolMapperState {
|
|
137
155
|
/**
|
|
138
|
-
* Indicates if the
|
|
156
|
+
* Indicates if the attribute should be a claim in the access token.
|
|
139
157
|
*/
|
|
140
158
|
addToAccessToken?: pulumi.Input<boolean>;
|
|
141
159
|
/**
|
|
142
|
-
* Indicates if the
|
|
160
|
+
* Indicates if the attribute should be a claim in the id token.
|
|
143
161
|
*/
|
|
144
162
|
addToIdToken?: pulumi.Input<boolean>;
|
|
145
163
|
/**
|
|
146
|
-
* Indicates if the
|
|
164
|
+
* Indicates if the attribute should appear in the userinfo response body.
|
|
147
165
|
*/
|
|
148
166
|
addToUserinfo?: pulumi.Input<boolean>;
|
|
149
|
-
/**
|
|
150
|
-
* The name of the claim to insert into a token.
|
|
151
|
-
*/
|
|
152
167
|
claimName?: pulumi.Input<string>;
|
|
153
168
|
/**
|
|
154
|
-
*
|
|
169
|
+
* Claim type used when serializing tokens.
|
|
155
170
|
*/
|
|
156
171
|
claimValueType?: pulumi.Input<string>;
|
|
157
172
|
/**
|
|
158
|
-
* The
|
|
173
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
159
174
|
*/
|
|
160
175
|
clientId?: pulumi.Input<string>;
|
|
161
176
|
/**
|
|
162
|
-
* The
|
|
177
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
163
178
|
*/
|
|
164
179
|
clientScopeId?: pulumi.Input<string>;
|
|
165
180
|
/**
|
|
166
|
-
* Indicates
|
|
181
|
+
* Indicates whether this attribute is a single value or an array of values.
|
|
167
182
|
*/
|
|
168
183
|
multivalued?: pulumi.Input<boolean>;
|
|
169
184
|
/**
|
|
170
|
-
*
|
|
185
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
171
186
|
*/
|
|
172
187
|
name?: pulumi.Input<string>;
|
|
173
188
|
/**
|
|
174
|
-
* The realm
|
|
189
|
+
* The realm id where the associated client or client scope exists.
|
|
175
190
|
*/
|
|
176
191
|
realmId?: pulumi.Input<string>;
|
|
177
192
|
/**
|
|
178
|
-
*
|
|
193
|
+
* Prefix that will be added to each realm role.
|
|
179
194
|
*/
|
|
180
195
|
realmRolePrefix?: pulumi.Input<string>;
|
|
181
196
|
}
|
|
@@ -184,47 +199,44 @@ export interface UserRealmRoleProtocolMapperState {
|
|
|
184
199
|
*/
|
|
185
200
|
export interface UserRealmRoleProtocolMapperArgs {
|
|
186
201
|
/**
|
|
187
|
-
* Indicates if the
|
|
202
|
+
* Indicates if the attribute should be a claim in the access token.
|
|
188
203
|
*/
|
|
189
204
|
addToAccessToken?: pulumi.Input<boolean>;
|
|
190
205
|
/**
|
|
191
|
-
* Indicates if the
|
|
206
|
+
* Indicates if the attribute should be a claim in the id token.
|
|
192
207
|
*/
|
|
193
208
|
addToIdToken?: pulumi.Input<boolean>;
|
|
194
209
|
/**
|
|
195
|
-
* Indicates if the
|
|
210
|
+
* Indicates if the attribute should appear in the userinfo response body.
|
|
196
211
|
*/
|
|
197
212
|
addToUserinfo?: pulumi.Input<boolean>;
|
|
198
|
-
/**
|
|
199
|
-
* The name of the claim to insert into a token.
|
|
200
|
-
*/
|
|
201
213
|
claimName: pulumi.Input<string>;
|
|
202
214
|
/**
|
|
203
|
-
*
|
|
215
|
+
* Claim type used when serializing tokens.
|
|
204
216
|
*/
|
|
205
217
|
claimValueType?: pulumi.Input<string>;
|
|
206
218
|
/**
|
|
207
|
-
* The
|
|
219
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
208
220
|
*/
|
|
209
221
|
clientId?: pulumi.Input<string>;
|
|
210
222
|
/**
|
|
211
|
-
* The
|
|
223
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
212
224
|
*/
|
|
213
225
|
clientScopeId?: pulumi.Input<string>;
|
|
214
226
|
/**
|
|
215
|
-
* Indicates
|
|
227
|
+
* Indicates whether this attribute is a single value or an array of values.
|
|
216
228
|
*/
|
|
217
229
|
multivalued?: pulumi.Input<boolean>;
|
|
218
230
|
/**
|
|
219
|
-
*
|
|
231
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
220
232
|
*/
|
|
221
233
|
name?: pulumi.Input<string>;
|
|
222
234
|
/**
|
|
223
|
-
* The realm
|
|
235
|
+
* The realm id where the associated client or client scope exists.
|
|
224
236
|
*/
|
|
225
237
|
realmId: pulumi.Input<string>;
|
|
226
238
|
/**
|
|
227
|
-
*
|
|
239
|
+
* Prefix that will be added to each realm role.
|
|
228
240
|
*/
|
|
229
241
|
realmRolePrefix?: pulumi.Input<string>;
|
|
230
242
|
}
|
|
@@ -6,15 +6,17 @@ exports.UserRealmRoleProtocolMapper = void 0;
|
|
|
6
6
|
const pulumi = require("@pulumi/pulumi");
|
|
7
7
|
const utilities = require("../utilities");
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* ## # keycloak.openid.UserRealmRoleProtocolMapper
|
|
10
10
|
*
|
|
11
|
-
*
|
|
11
|
+
* Allows for creating and managing user realm role protocol mappers within
|
|
12
|
+
* Keycloak.
|
|
12
13
|
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
14
|
+
* User realm role protocol mappers allow you to define a claim containing the list of the realm roles.
|
|
15
|
+
* Protocol mappers can be defined for a single client, or they can
|
|
16
|
+
* be defined for a client scope which can be shared between multiple different
|
|
17
|
+
* clients.
|
|
15
18
|
*
|
|
16
|
-
*
|
|
17
|
-
* ### Client)
|
|
19
|
+
* ### Example Usage (Client)
|
|
18
20
|
*
|
|
19
21
|
* ```typescript
|
|
20
22
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -24,20 +26,23 @@ const utilities = require("../utilities");
|
|
|
24
26
|
* realm: "my-realm",
|
|
25
27
|
* enabled: true,
|
|
26
28
|
* });
|
|
27
|
-
* const openidClient = new keycloak.openid.Client("
|
|
29
|
+
* const openidClient = new keycloak.openid.Client("openid_client", {
|
|
28
30
|
* realmId: realm.id,
|
|
29
|
-
* clientId: "client",
|
|
31
|
+
* clientId: "test-client",
|
|
32
|
+
* name: "test client",
|
|
30
33
|
* enabled: true,
|
|
31
34
|
* accessType: "CONFIDENTIAL",
|
|
32
35
|
* validRedirectUris: ["http://localhost:8080/openid-callback"],
|
|
33
36
|
* });
|
|
34
|
-
* const userRealmRoleMapper = new keycloak.openid.UserRealmRoleProtocolMapper("
|
|
37
|
+
* const userRealmRoleMapper = new keycloak.openid.UserRealmRoleProtocolMapper("user_realm_role_mapper", {
|
|
35
38
|
* realmId: realm.id,
|
|
36
39
|
* clientId: openidClient.id,
|
|
40
|
+
* name: "user-realm-role-mapper",
|
|
37
41
|
* claimName: "foo",
|
|
38
42
|
* });
|
|
39
43
|
* ```
|
|
40
|
-
*
|
|
44
|
+
*
|
|
45
|
+
* ### Example Usage (Client Scope)
|
|
41
46
|
*
|
|
42
47
|
* ```typescript
|
|
43
48
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -47,25 +52,41 @@ const utilities = require("../utilities");
|
|
|
47
52
|
* realm: "my-realm",
|
|
48
53
|
* enabled: true,
|
|
49
54
|
* });
|
|
50
|
-
* const clientScope = new keycloak.openid.ClientScope("
|
|
51
|
-
*
|
|
55
|
+
* const clientScope = new keycloak.openid.ClientScope("client_scope", {
|
|
56
|
+
* realmId: realm.id,
|
|
57
|
+
* name: "test-client-scope",
|
|
58
|
+
* });
|
|
59
|
+
* const userRealmRoleMapper = new keycloak.openid.UserRealmRoleProtocolMapper("user_realm_role_mapper", {
|
|
52
60
|
* realmId: realm.id,
|
|
53
61
|
* clientScopeId: clientScope.id,
|
|
62
|
+
* name: "user-realm-role-mapper",
|
|
54
63
|
* claimName: "foo",
|
|
55
64
|
* });
|
|
56
65
|
* ```
|
|
57
66
|
*
|
|
58
|
-
*
|
|
67
|
+
* ### Argument Reference
|
|
59
68
|
*
|
|
60
|
-
*
|
|
69
|
+
* The following arguments are supported:
|
|
61
70
|
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
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
|
+
* - `claimName` - (Required) The name of the claim to insert into a token.
|
|
76
|
+
* - `claimValueType` - (Optional) The claim type used when serializing JSON tokens. Can be one of `String`, `long`, `int`, or `boolean`. Defaults to `String`.
|
|
77
|
+
* - `multivalued` - (Optional) Indicates if attribute supports multiple values. If true, then the list of all values of this attribute will be set as claim. If false, then just first value will be set as claim. Defaults to `true`.
|
|
78
|
+
* - `realmRolePrefix` - (Optional) A prefix for each Realm Role.
|
|
79
|
+
* - `addToIdToken` - (Optional) Indicates if the property should be added as a claim to the id token. Defaults to `true`.
|
|
80
|
+
* - `addToAccessToken` - (Optional) Indicates if the property should be added as a claim to the access token. Defaults to `true`.
|
|
81
|
+
* - `addToUserinfo` - (Optional) Indicates if the property should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
65
82
|
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
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:
|
|
69
90
|
*/
|
|
70
91
|
class UserRealmRoleProtocolMapper extends pulumi.CustomResource {
|
|
71
92
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userRealmRoleProtocolMapper.js","sourceRoot":"","sources":["../../openid/userRealmRoleProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"userRealmRoleProtocolMapper.js","sourceRoot":"","sources":["../../openid/userRealmRoleProtocolMapper.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;IAoDD,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,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,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;SACjF;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,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,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,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/E;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;;AApHL,kEAqHC;AAvGG,gBAAgB;AACO,wCAAY,GAAG,yEAAyE,CAAC"}
|
|
@@ -8,6 +8,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
8
8
|
* multiple different clients.
|
|
9
9
|
*
|
|
10
10
|
* ## Example Usage
|
|
11
|
+
*
|
|
11
12
|
* ### Client)
|
|
12
13
|
*
|
|
13
14
|
* ```typescript
|
|
@@ -18,21 +19,24 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
18
19
|
* realm: "my-realm",
|
|
19
20
|
* enabled: true,
|
|
20
21
|
* });
|
|
21
|
-
* const openidClient = new keycloak.openid.Client("
|
|
22
|
+
* const openidClient = new keycloak.openid.Client("openid_client", {
|
|
22
23
|
* realmId: realm.id,
|
|
23
24
|
* clientId: "client",
|
|
25
|
+
* name: "client",
|
|
24
26
|
* enabled: true,
|
|
25
27
|
* accessType: "CONFIDENTIAL",
|
|
26
28
|
* validRedirectUris: ["http://localhost:8080/openid-callback"],
|
|
27
29
|
* });
|
|
28
|
-
* const userSessionNoteMapper = new keycloak.openid.UserSessionNoteProtocolMapper("
|
|
30
|
+
* const userSessionNoteMapper = new keycloak.openid.UserSessionNoteProtocolMapper("user_session_note_mapper", {
|
|
29
31
|
* realmId: realm.id,
|
|
30
32
|
* clientId: openidClient.id,
|
|
33
|
+
* name: "user-session-note-mapper",
|
|
31
34
|
* claimName: "foo",
|
|
32
35
|
* claimValueType: "String",
|
|
33
36
|
* sessionNote: "bar",
|
|
34
37
|
* });
|
|
35
38
|
* ```
|
|
39
|
+
*
|
|
36
40
|
* ### Client Scope)
|
|
37
41
|
*
|
|
38
42
|
* ```typescript
|
|
@@ -43,10 +47,14 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
43
47
|
* realm: "my-realm",
|
|
44
48
|
* enabled: true,
|
|
45
49
|
* });
|
|
46
|
-
* const clientScope = new keycloak.openid.ClientScope("
|
|
47
|
-
*
|
|
50
|
+
* const clientScope = new keycloak.openid.ClientScope("client_scope", {
|
|
51
|
+
* realmId: realm.id,
|
|
52
|
+
* name: "client-scope",
|
|
53
|
+
* });
|
|
54
|
+
* const userSessionNoteMapper = new keycloak.openid.UserSessionNoteProtocolMapper("user_session_note_mapper", {
|
|
48
55
|
* realmId: realm.id,
|
|
49
56
|
* clientScopeId: clientScope.id,
|
|
57
|
+
* name: "user-session-note-mapper",
|
|
50
58
|
* claimName: "foo",
|
|
51
59
|
* claimValueType: "String",
|
|
52
60
|
* sessionNote: "bar",
|
|
@@ -55,14 +63,22 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
55
63
|
*
|
|
56
64
|
* ## Import
|
|
57
65
|
*
|
|
58
|
-
* 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
|
|
59
75
|
*
|
|
60
76
|
* ```sh
|
|
61
|
-
*
|
|
77
|
+
* $ pulumi import keycloak:openid/userSessionNoteProtocolMapper:UserSessionNoteProtocolMapper user_session_note_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
62
78
|
* ```
|
|
63
79
|
*
|
|
64
80
|
* ```sh
|
|
65
|
-
*
|
|
81
|
+
* $ pulumi import keycloak:openid/userSessionNoteProtocolMapper:UserSessionNoteProtocolMapper user_session_note_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
66
82
|
* ```
|
|
67
83
|
*/
|
|
68
84
|
export declare class UserSessionNoteProtocolMapper extends pulumi.CustomResource {
|
|
@@ -14,6 +14,7 @@ const utilities = require("../utilities");
|
|
|
14
14
|
* multiple different clients.
|
|
15
15
|
*
|
|
16
16
|
* ## Example Usage
|
|
17
|
+
*
|
|
17
18
|
* ### Client)
|
|
18
19
|
*
|
|
19
20
|
* ```typescript
|
|
@@ -24,21 +25,24 @@ const utilities = require("../utilities");
|
|
|
24
25
|
* realm: "my-realm",
|
|
25
26
|
* enabled: true,
|
|
26
27
|
* });
|
|
27
|
-
* const openidClient = new keycloak.openid.Client("
|
|
28
|
+
* const openidClient = new keycloak.openid.Client("openid_client", {
|
|
28
29
|
* realmId: realm.id,
|
|
29
30
|
* clientId: "client",
|
|
31
|
+
* name: "client",
|
|
30
32
|
* enabled: true,
|
|
31
33
|
* accessType: "CONFIDENTIAL",
|
|
32
34
|
* validRedirectUris: ["http://localhost:8080/openid-callback"],
|
|
33
35
|
* });
|
|
34
|
-
* const userSessionNoteMapper = new keycloak.openid.UserSessionNoteProtocolMapper("
|
|
36
|
+
* const userSessionNoteMapper = new keycloak.openid.UserSessionNoteProtocolMapper("user_session_note_mapper", {
|
|
35
37
|
* realmId: realm.id,
|
|
36
38
|
* clientId: openidClient.id,
|
|
39
|
+
* name: "user-session-note-mapper",
|
|
37
40
|
* claimName: "foo",
|
|
38
41
|
* claimValueType: "String",
|
|
39
42
|
* sessionNote: "bar",
|
|
40
43
|
* });
|
|
41
44
|
* ```
|
|
45
|
+
*
|
|
42
46
|
* ### Client Scope)
|
|
43
47
|
*
|
|
44
48
|
* ```typescript
|
|
@@ -49,10 +53,14 @@ const utilities = require("../utilities");
|
|
|
49
53
|
* realm: "my-realm",
|
|
50
54
|
* enabled: true,
|
|
51
55
|
* });
|
|
52
|
-
* const clientScope = new keycloak.openid.ClientScope("
|
|
53
|
-
*
|
|
56
|
+
* const clientScope = new keycloak.openid.ClientScope("client_scope", {
|
|
57
|
+
* realmId: realm.id,
|
|
58
|
+
* name: "client-scope",
|
|
59
|
+
* });
|
|
60
|
+
* const userSessionNoteMapper = new keycloak.openid.UserSessionNoteProtocolMapper("user_session_note_mapper", {
|
|
54
61
|
* realmId: realm.id,
|
|
55
62
|
* clientScopeId: clientScope.id,
|
|
63
|
+
* name: "user-session-note-mapper",
|
|
56
64
|
* claimName: "foo",
|
|
57
65
|
* claimValueType: "String",
|
|
58
66
|
* sessionNote: "bar",
|
|
@@ -61,14 +69,22 @@ const utilities = require("../utilities");
|
|
|
61
69
|
*
|
|
62
70
|
* ## Import
|
|
63
71
|
*
|
|
64
|
-
* Protocol mappers can be imported using one of the following formats
|
|
72
|
+
* Protocol mappers can be imported using one of the following formats:
|
|
73
|
+
*
|
|
74
|
+
* - Client: `{{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}`
|
|
75
|
+
*
|
|
76
|
+
* - Client Scope: `{{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}`
|
|
77
|
+
*
|
|
78
|
+
* Example:
|
|
79
|
+
*
|
|
80
|
+
* bash
|
|
65
81
|
*
|
|
66
82
|
* ```sh
|
|
67
|
-
*
|
|
83
|
+
* $ pulumi import keycloak:openid/userSessionNoteProtocolMapper:UserSessionNoteProtocolMapper user_session_note_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
68
84
|
* ```
|
|
69
85
|
*
|
|
70
86
|
* ```sh
|
|
71
|
-
*
|
|
87
|
+
* $ pulumi import keycloak:openid/userSessionNoteProtocolMapper:UserSessionNoteProtocolMapper user_session_note_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4
|
|
72
88
|
* ```
|
|
73
89
|
*/
|
|
74
90
|
class UserSessionNoteProtocolMapper extends pulumi.CustomResource {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userSessionNoteProtocolMapper.js","sourceRoot":"","sources":["../../openid/userSessionNoteProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"userSessionNoteProtocolMapper.js","sourceRoot":"","sources":["../../openid/userSessionNoteProtocolMapper.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;AACH,MAAa,6BAA8B,SAAQ,MAAM,CAAC,cAAc;IACpE;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA0C,EAAE,IAAmC;QACxI,OAAO,IAAI,6BAA6B,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACpF,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,6BAA6B,CAAC,YAAY,CAAC;IAC9E,CAAC;IA+CD,YAAY,IAAY,EAAE,WAAoF,EAAE,IAAmC;QAC/I,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA6D,CAAC;YAC5E,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,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,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,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SACzE;aAAM;YACH,MAAM,IAAI,GAAG,WAA4D,CAAC;YAC1E,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,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,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,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,6BAA6B,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAClF,CAAC;;AA3GL,sEA4GC;AA9FG,gBAAgB;AACO,0CAAY,GAAG,6EAA6E,CAAC"}
|