@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
package/openid/clientScope.d.ts
CHANGED
|
@@ -1,35 +1,49 @@
|
|
|
1
1
|
import * as pulumi from "@pulumi/pulumi";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* ## # keycloak.openid.ClientScope
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* Allows for creating and managing Keycloak client scopes that can be attached to
|
|
6
|
+
* clients that use the OpenID Connect protocol.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
8
|
+
* Client Scopes can be used to share common protocol and role mappings between multiple
|
|
9
|
+
* clients within a realm. They can also be used by clients to conditionally request
|
|
10
|
+
* claims or roles for a user based on the OAuth 2.0 `scope` parameter.
|
|
9
11
|
*
|
|
12
|
+
* ### Example Usage
|
|
13
|
+
*
|
|
14
|
+
* <!--Start PulumiCodeChooser -->
|
|
10
15
|
* ```typescript
|
|
11
16
|
* import * as pulumi from "@pulumi/pulumi";
|
|
12
17
|
* import * as keycloak from "@pulumi/keycloak";
|
|
13
18
|
*
|
|
14
19
|
* const realm = new keycloak.Realm("realm", {
|
|
15
|
-
* realm: "my-realm",
|
|
16
20
|
* enabled: true,
|
|
21
|
+
* realm: "my-realm",
|
|
17
22
|
* });
|
|
18
23
|
* const openidClientScope = new keycloak.openid.ClientScope("openidClientScope", {
|
|
19
|
-
* realmId: realm.id,
|
|
20
24
|
* description: "When requested, this scope will map a user's group memberships to a claim",
|
|
21
|
-
*
|
|
22
|
-
* guiOrder: 1,
|
|
25
|
+
* realmId: realm.id,
|
|
23
26
|
* });
|
|
24
27
|
* ```
|
|
28
|
+
* <!--End PulumiCodeChooser -->
|
|
25
29
|
*
|
|
26
|
-
*
|
|
30
|
+
* ### Argument Reference
|
|
27
31
|
*
|
|
28
|
-
*
|
|
32
|
+
* The following arguments are supported:
|
|
29
33
|
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
34
|
+
* - `realmId` - (Required) The realm this client scope belongs to.
|
|
35
|
+
* - `name` - (Required) The display name of this client scope in the GUI.
|
|
36
|
+
* - `description` - (Optional) The description of this client scope in the GUI.
|
|
37
|
+
* - `consentScreenText` - (Optional) When set, a consent screen will be displayed to users
|
|
38
|
+
* authenticating to clients with this scope attached. The consent screen will display the string
|
|
39
|
+
* value of this attribute.
|
|
40
|
+
*
|
|
41
|
+
* ### Import
|
|
42
|
+
*
|
|
43
|
+
* Client scopes can be imported using the format `{{realm_id}}/{{client_scope_id}}`, where `clientScopeId` is the unique ID that Keycloak
|
|
44
|
+
* assigns to the client scope upon creation. This value can be found in the URI when editing this client scope in the GUI, and is typically a GUID.
|
|
45
|
+
*
|
|
46
|
+
* Example:
|
|
33
47
|
*/
|
|
34
48
|
export declare class ClientScope extends pulumi.CustomResource {
|
|
35
49
|
/**
|
|
@@ -47,29 +61,11 @@ export declare class ClientScope extends pulumi.CustomResource {
|
|
|
47
61
|
* when multiple copies of the Pulumi SDK have been loaded into the same process.
|
|
48
62
|
*/
|
|
49
63
|
static isInstance(obj: any): obj is ClientScope;
|
|
50
|
-
/**
|
|
51
|
-
* When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
|
|
52
|
-
*/
|
|
53
64
|
readonly consentScreenText: pulumi.Output<string | undefined>;
|
|
54
|
-
/**
|
|
55
|
-
* The description of this client scope in the GUI.
|
|
56
|
-
*/
|
|
57
65
|
readonly description: pulumi.Output<string | undefined>;
|
|
58
|
-
/**
|
|
59
|
-
* Specify order of the client scope in GUI (such as in Consent page) as integer.
|
|
60
|
-
*/
|
|
61
66
|
readonly guiOrder: pulumi.Output<number | undefined>;
|
|
62
|
-
/**
|
|
63
|
-
* When `true`, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.
|
|
64
|
-
*/
|
|
65
67
|
readonly includeInTokenScope: pulumi.Output<boolean | undefined>;
|
|
66
|
-
/**
|
|
67
|
-
* The display name of this client scope in the GUI.
|
|
68
|
-
*/
|
|
69
68
|
readonly name: pulumi.Output<string>;
|
|
70
|
-
/**
|
|
71
|
-
* The realm this client scope belongs to.
|
|
72
|
-
*/
|
|
73
69
|
readonly realmId: pulumi.Output<string>;
|
|
74
70
|
/**
|
|
75
71
|
* Create a ClientScope resource with the given unique name, arguments, and options.
|
|
@@ -84,57 +80,21 @@ export declare class ClientScope extends pulumi.CustomResource {
|
|
|
84
80
|
* Input properties used for looking up and filtering ClientScope resources.
|
|
85
81
|
*/
|
|
86
82
|
export interface ClientScopeState {
|
|
87
|
-
/**
|
|
88
|
-
* When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
|
|
89
|
-
*/
|
|
90
83
|
consentScreenText?: pulumi.Input<string>;
|
|
91
|
-
/**
|
|
92
|
-
* The description of this client scope in the GUI.
|
|
93
|
-
*/
|
|
94
84
|
description?: pulumi.Input<string>;
|
|
95
|
-
/**
|
|
96
|
-
* Specify order of the client scope in GUI (such as in Consent page) as integer.
|
|
97
|
-
*/
|
|
98
85
|
guiOrder?: pulumi.Input<number>;
|
|
99
|
-
/**
|
|
100
|
-
* When `true`, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.
|
|
101
|
-
*/
|
|
102
86
|
includeInTokenScope?: pulumi.Input<boolean>;
|
|
103
|
-
/**
|
|
104
|
-
* The display name of this client scope in the GUI.
|
|
105
|
-
*/
|
|
106
87
|
name?: pulumi.Input<string>;
|
|
107
|
-
/**
|
|
108
|
-
* The realm this client scope belongs to.
|
|
109
|
-
*/
|
|
110
88
|
realmId?: pulumi.Input<string>;
|
|
111
89
|
}
|
|
112
90
|
/**
|
|
113
91
|
* The set of arguments for constructing a ClientScope resource.
|
|
114
92
|
*/
|
|
115
93
|
export interface ClientScopeArgs {
|
|
116
|
-
/**
|
|
117
|
-
* When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
|
|
118
|
-
*/
|
|
119
94
|
consentScreenText?: pulumi.Input<string>;
|
|
120
|
-
/**
|
|
121
|
-
* The description of this client scope in the GUI.
|
|
122
|
-
*/
|
|
123
95
|
description?: pulumi.Input<string>;
|
|
124
|
-
/**
|
|
125
|
-
* Specify order of the client scope in GUI (such as in Consent page) as integer.
|
|
126
|
-
*/
|
|
127
96
|
guiOrder?: pulumi.Input<number>;
|
|
128
|
-
/**
|
|
129
|
-
* When `true`, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.
|
|
130
|
-
*/
|
|
131
97
|
includeInTokenScope?: pulumi.Input<boolean>;
|
|
132
|
-
/**
|
|
133
|
-
* The display name of this client scope in the GUI.
|
|
134
|
-
*/
|
|
135
98
|
name?: pulumi.Input<string>;
|
|
136
|
-
/**
|
|
137
|
-
* The realm this client scope belongs to.
|
|
138
|
-
*/
|
|
139
99
|
realmId: pulumi.Input<string>;
|
|
140
100
|
}
|
package/openid/clientScope.js
CHANGED
|
@@ -6,36 +6,50 @@ exports.ClientScope = void 0;
|
|
|
6
6
|
const pulumi = require("@pulumi/pulumi");
|
|
7
7
|
const utilities = require("../utilities");
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* ## # keycloak.openid.ClientScope
|
|
10
10
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
11
|
+
* Allows for creating and managing Keycloak client scopes that can be attached to
|
|
12
|
+
* clients that use the OpenID Connect protocol.
|
|
13
13
|
*
|
|
14
|
-
*
|
|
14
|
+
* Client Scopes can be used to share common protocol and role mappings between multiple
|
|
15
|
+
* clients within a realm. They can also be used by clients to conditionally request
|
|
16
|
+
* claims or roles for a user based on the OAuth 2.0 `scope` parameter.
|
|
15
17
|
*
|
|
18
|
+
* ### Example Usage
|
|
19
|
+
*
|
|
20
|
+
* <!--Start PulumiCodeChooser -->
|
|
16
21
|
* ```typescript
|
|
17
22
|
* import * as pulumi from "@pulumi/pulumi";
|
|
18
23
|
* import * as keycloak from "@pulumi/keycloak";
|
|
19
24
|
*
|
|
20
25
|
* const realm = new keycloak.Realm("realm", {
|
|
21
|
-
* realm: "my-realm",
|
|
22
26
|
* enabled: true,
|
|
27
|
+
* realm: "my-realm",
|
|
23
28
|
* });
|
|
24
29
|
* const openidClientScope = new keycloak.openid.ClientScope("openidClientScope", {
|
|
25
|
-
* realmId: realm.id,
|
|
26
30
|
* description: "When requested, this scope will map a user's group memberships to a claim",
|
|
27
|
-
*
|
|
28
|
-
* guiOrder: 1,
|
|
31
|
+
* realmId: realm.id,
|
|
29
32
|
* });
|
|
30
33
|
* ```
|
|
34
|
+
* <!--End PulumiCodeChooser -->
|
|
31
35
|
*
|
|
32
|
-
*
|
|
36
|
+
* ### Argument Reference
|
|
33
37
|
*
|
|
34
|
-
*
|
|
38
|
+
* The following arguments are supported:
|
|
35
39
|
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
40
|
+
* - `realmId` - (Required) The realm this client scope belongs to.
|
|
41
|
+
* - `name` - (Required) The display name of this client scope in the GUI.
|
|
42
|
+
* - `description` - (Optional) The description of this client scope in the GUI.
|
|
43
|
+
* - `consentScreenText` - (Optional) When set, a consent screen will be displayed to users
|
|
44
|
+
* authenticating to clients with this scope attached. The consent screen will display the string
|
|
45
|
+
* value of this attribute.
|
|
46
|
+
*
|
|
47
|
+
* ### Import
|
|
48
|
+
*
|
|
49
|
+
* Client scopes can be imported using the format `{{realm_id}}/{{client_scope_id}}`, where `clientScopeId` is the unique ID that Keycloak
|
|
50
|
+
* assigns to the client scope upon creation. This value can be found in the URI when editing this client scope in the GUI, and is typically a GUID.
|
|
51
|
+
*
|
|
52
|
+
* Example:
|
|
39
53
|
*/
|
|
40
54
|
class ClientScope extends pulumi.CustomResource {
|
|
41
55
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clientScope.js","sourceRoot":"","sources":["../../openid/clientScope.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"clientScope.js","sourceRoot":"","sources":["../../openid/clientScope.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAa,WAAY,SAAQ,MAAM,CAAC,cAAc;IAClD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAwB,EAAE,IAAmC;QACtH,OAAO,IAAI,WAAW,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,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,WAAW,CAAC,YAAY,CAAC;IAC5D,CAAC;IAiBD,YAAY,IAAY,EAAE,WAAgD,EAAE,IAAmC;QAC3G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA2C,CAAC;YAC1D,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,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,WAA0C,CAAC;YACxD,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,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,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,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;;AApEL,kCAqEC;AAvDG,gBAAgB;AACO,wBAAY,GAAG,yCAAyC,CAAC"}
|
|
@@ -8,6 +8,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
8
8
|
*
|
|
9
9
|
* ## Example Usage
|
|
10
10
|
*
|
|
11
|
+
* <!--Start PulumiCodeChooser -->
|
|
11
12
|
* ```typescript
|
|
12
13
|
* import * as pulumi from "@pulumi/pulumi";
|
|
13
14
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -27,13 +28,18 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
27
28
|
* role: realmRole.name,
|
|
28
29
|
* });
|
|
29
30
|
* ```
|
|
31
|
+
* <!--End PulumiCodeChooser -->
|
|
30
32
|
*
|
|
31
33
|
* ## Import
|
|
32
34
|
*
|
|
33
|
-
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{roleId}}`.
|
|
35
|
+
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{roleId}}`.
|
|
36
|
+
*
|
|
37
|
+
* Example:
|
|
38
|
+
*
|
|
39
|
+
* bash
|
|
34
40
|
*
|
|
35
41
|
* ```sh
|
|
36
|
-
*
|
|
42
|
+
* $ pulumi import keycloak:openid/clientServiceAccountRealmRole:ClientServiceAccountRealmRole client_service_account_role my-realm/489ba513-1ceb-49ba-ae0b-1ab1f5099ebf/c7230ab7-8e4e-4135-995d-e81b50696ad8
|
|
37
43
|
* ```
|
|
38
44
|
*/
|
|
39
45
|
export declare class ClientServiceAccountRealmRole extends pulumi.CustomResource {
|
|
@@ -14,6 +14,7 @@ const utilities = require("../utilities");
|
|
|
14
14
|
*
|
|
15
15
|
* ## Example Usage
|
|
16
16
|
*
|
|
17
|
+
* <!--Start PulumiCodeChooser -->
|
|
17
18
|
* ```typescript
|
|
18
19
|
* import * as pulumi from "@pulumi/pulumi";
|
|
19
20
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -33,13 +34,18 @@ const utilities = require("../utilities");
|
|
|
33
34
|
* role: realmRole.name,
|
|
34
35
|
* });
|
|
35
36
|
* ```
|
|
37
|
+
* <!--End PulumiCodeChooser -->
|
|
36
38
|
*
|
|
37
39
|
* ## Import
|
|
38
40
|
*
|
|
39
|
-
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{roleId}}`.
|
|
41
|
+
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{roleId}}`.
|
|
42
|
+
*
|
|
43
|
+
* Example:
|
|
44
|
+
*
|
|
45
|
+
* bash
|
|
40
46
|
*
|
|
41
47
|
* ```sh
|
|
42
|
-
*
|
|
48
|
+
* $ pulumi import keycloak:openid/clientServiceAccountRealmRole:ClientServiceAccountRealmRole client_service_account_role my-realm/489ba513-1ceb-49ba-ae0b-1ab1f5099ebf/c7230ab7-8e4e-4135-995d-e81b50696ad8
|
|
43
49
|
* ```
|
|
44
50
|
*/
|
|
45
51
|
class ClientServiceAccountRealmRole extends pulumi.CustomResource {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clientServiceAccountRealmRole.js","sourceRoot":"","sources":["../../openid/clientServiceAccountRealmRole.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"clientServiceAccountRealmRole.js","sourceRoot":"","sources":["../../openid/clientServiceAccountRealmRole.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;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;IAuBD,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,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;aAAM;YACH,MAAM,IAAI,GAAG,WAA4D,CAAC;YAC1E,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,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;aACvE;YACD,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;SACzF;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;;AA1EL,sEA2EC;AA7DG,gBAAgB;AACO,0CAAY,GAAG,6EAA6E,CAAC"}
|
|
@@ -8,6 +8,7 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
8
8
|
*
|
|
9
9
|
* ## Example Usage
|
|
10
10
|
*
|
|
11
|
+
* <!--Start PulumiCodeChooser -->
|
|
11
12
|
* ```typescript
|
|
12
13
|
* import * as pulumi from "@pulumi/pulumi";
|
|
13
14
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -35,13 +36,18 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
35
36
|
* role: client1Role.name,
|
|
36
37
|
* });
|
|
37
38
|
* ```
|
|
39
|
+
* <!--End PulumiCodeChooser -->
|
|
38
40
|
*
|
|
39
41
|
* ## Import
|
|
40
42
|
*
|
|
41
|
-
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{clientId}}/{{roleId}}`.
|
|
43
|
+
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{clientId}}/{{roleId}}`.
|
|
44
|
+
*
|
|
45
|
+
* Example:
|
|
46
|
+
*
|
|
47
|
+
* bash
|
|
42
48
|
*
|
|
43
49
|
* ```sh
|
|
44
|
-
*
|
|
50
|
+
* $ pulumi import keycloak:openid/clientServiceAccountRole:ClientServiceAccountRole client2_service_account_role my-realm/489ba513-1ceb-49ba-ae0b-1ab1f5099ebf/baf01820-0f8b-4494-9be2-fb3bc8a397a4/c7230ab7-8e4e-4135-995d-e81b50696ad8
|
|
45
51
|
* ```
|
|
46
52
|
*/
|
|
47
53
|
export declare class ClientServiceAccountRole extends pulumi.CustomResource {
|
|
@@ -14,6 +14,7 @@ const utilities = require("../utilities");
|
|
|
14
14
|
*
|
|
15
15
|
* ## Example Usage
|
|
16
16
|
*
|
|
17
|
+
* <!--Start PulumiCodeChooser -->
|
|
17
18
|
* ```typescript
|
|
18
19
|
* import * as pulumi from "@pulumi/pulumi";
|
|
19
20
|
* import * as keycloak from "@pulumi/keycloak";
|
|
@@ -41,13 +42,18 @@ const utilities = require("../utilities");
|
|
|
41
42
|
* role: client1Role.name,
|
|
42
43
|
* });
|
|
43
44
|
* ```
|
|
45
|
+
* <!--End PulumiCodeChooser -->
|
|
44
46
|
*
|
|
45
47
|
* ## Import
|
|
46
48
|
*
|
|
47
|
-
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{clientId}}/{{roleId}}`.
|
|
49
|
+
* This resource can be imported using the format `{{realmId}}/{{serviceAccountUserId}}/{{clientId}}/{{roleId}}`.
|
|
50
|
+
*
|
|
51
|
+
* Example:
|
|
52
|
+
*
|
|
53
|
+
* bash
|
|
48
54
|
*
|
|
49
55
|
* ```sh
|
|
50
|
-
*
|
|
56
|
+
* $ pulumi import keycloak:openid/clientServiceAccountRole:ClientServiceAccountRole client2_service_account_role my-realm/489ba513-1ceb-49ba-ae0b-1ab1f5099ebf/baf01820-0f8b-4494-9be2-fb3bc8a397a4/c7230ab7-8e4e-4135-995d-e81b50696ad8
|
|
51
57
|
* ```
|
|
52
58
|
*/
|
|
53
59
|
class ClientServiceAccountRole extends pulumi.CustomResource {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clientServiceAccountRole.js","sourceRoot":"","sources":["../../openid/clientServiceAccountRole.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C
|
|
1
|
+
{"version":3,"file":"clientServiceAccountRole.js","sourceRoot":"","sources":["../../openid/clientServiceAccountRole.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAa,wBAAyB,SAAQ,MAAM,CAAC,cAAc;IAC/D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAqC,EAAE,IAAmC;QACnI,OAAO,IAAI,wBAAwB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC/E,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,wBAAwB,CAAC,YAAY,CAAC;IACzE,CAAC;IA2BD,YAAY,IAAY,EAAE,WAA0E,EAAE,IAAmC;QACrI,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAwD,CAAC;YACvE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;aAAM;YACH,MAAM,IAAI,GAAG,WAAuD,CAAC;YACrE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;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,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;aACvE;YACD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;SACzF;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,wBAAwB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7E,CAAC;;AAnFL,4DAoFC;AAtEG,gBAAgB;AACO,qCAAY,GAAG,mEAAmE,CAAC"}
|
|
@@ -1,63 +1,78 @@
|
|
|
1
1
|
import * as pulumi from "@pulumi/pulumi";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* ## # keycloak.openid.FullNameProtocolMapper
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Allows for creating and managing full name protocol mappers within
|
|
6
|
+
* Keycloak.
|
|
6
7
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
8
|
+
* Full name protocol mappers allow you to map a user's first and last name
|
|
9
|
+
* to the OpenID Connect `name` claim in a token. Protocol mappers can be defined
|
|
10
|
+
* for a single client, or they can be defined for a client scope which can
|
|
11
|
+
* 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 fullNameMapper = new keycloak.openid.FullNameProtocolMapper("fullNameMapper", {
|
|
29
|
-
* realmId: realm.id,
|
|
30
32
|
* clientId: openidClient.id,
|
|
33
|
+
* realmId: realm.id,
|
|
31
34
|
* });
|
|
32
35
|
* ```
|
|
33
|
-
*
|
|
36
|
+
* <!--End PulumiCodeChooser -->
|
|
37
|
+
*
|
|
38
|
+
* ### Example Usage (Client Scope)
|
|
34
39
|
*
|
|
40
|
+
* <!--Start PulumiCodeChooser -->
|
|
35
41
|
* ```typescript
|
|
36
42
|
* import * as pulumi from "@pulumi/pulumi";
|
|
37
43
|
* import * as keycloak from "@pulumi/keycloak";
|
|
38
44
|
*
|
|
39
45
|
* const realm = new keycloak.Realm("realm", {
|
|
40
|
-
* realm: "my-realm",
|
|
41
46
|
* enabled: true,
|
|
47
|
+
* realm: "my-realm",
|
|
42
48
|
* });
|
|
43
49
|
* const clientScope = new keycloak.openid.ClientScope("clientScope", {realmId: realm.id});
|
|
44
50
|
* const fullNameMapper = new keycloak.openid.FullNameProtocolMapper("fullNameMapper", {
|
|
45
|
-
* realmId: realm.id,
|
|
46
51
|
* clientScopeId: clientScope.id,
|
|
52
|
+
* realmId: realm.id,
|
|
47
53
|
* });
|
|
48
54
|
* ```
|
|
55
|
+
* <!--End PulumiCodeChooser -->
|
|
49
56
|
*
|
|
50
|
-
*
|
|
57
|
+
* ### Argument Reference
|
|
51
58
|
*
|
|
52
|
-
*
|
|
59
|
+
* The following arguments are supported:
|
|
53
60
|
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
61
|
+
* - `realmId` - (Required) The realm this protocol mapper exists within.
|
|
62
|
+
* - `clientId` - (Required if `clientScopeId` is not specified) The client this protocol mapper is attached to.
|
|
63
|
+
* - `clientScopeId` - (Required if `clientId` is not specified) The client scope this protocol mapper is attached to.
|
|
64
|
+
* - `name` - (Required) The display name of this protocol mapper in the GUI.
|
|
65
|
+
* - `addToIdToken` - (Optional) Indicates if the user's full name should be added as a claim to the id token. Defaults to `true`.
|
|
66
|
+
* - `addToAccessToken` - (Optional) Indicates if the user's full name should be added as a claim to the access token. Defaults to `true`.
|
|
67
|
+
* - `addToUserinfo` - (Optional) Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
57
68
|
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
69
|
+
* ### Import
|
|
70
|
+
*
|
|
71
|
+
* Protocol mappers can be imported using one of the following formats:
|
|
72
|
+
* - Client: `{{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}`
|
|
73
|
+
* - Client Scope: `{{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}`
|
|
74
|
+
*
|
|
75
|
+
* Example:
|
|
61
76
|
*/
|
|
62
77
|
export declare class FullNameProtocolMapper extends pulumi.CustomResource {
|
|
63
78
|
/**
|
|
@@ -75,32 +90,23 @@ export declare class FullNameProtocolMapper extends pulumi.CustomResource {
|
|
|
75
90
|
* when multiple copies of the Pulumi SDK have been loaded into the same process.
|
|
76
91
|
*/
|
|
77
92
|
static isInstance(obj: any): obj is FullNameProtocolMapper;
|
|
78
|
-
/**
|
|
79
|
-
* Indicates if the user's full name should be added as a claim to the access token. Defaults to `true`.
|
|
80
|
-
*/
|
|
81
93
|
readonly addToAccessToken: pulumi.Output<boolean | undefined>;
|
|
82
|
-
/**
|
|
83
|
-
* Indicates if the user's full name should be added as a claim to the id token. Defaults to `true`.
|
|
84
|
-
*/
|
|
85
94
|
readonly addToIdToken: pulumi.Output<boolean | undefined>;
|
|
86
|
-
/**
|
|
87
|
-
* Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
88
|
-
*/
|
|
89
95
|
readonly addToUserinfo: pulumi.Output<boolean | undefined>;
|
|
90
96
|
/**
|
|
91
|
-
* The
|
|
97
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
92
98
|
*/
|
|
93
99
|
readonly clientId: pulumi.Output<string | undefined>;
|
|
94
100
|
/**
|
|
95
|
-
* The
|
|
101
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
96
102
|
*/
|
|
97
103
|
readonly clientScopeId: pulumi.Output<string | undefined>;
|
|
98
104
|
/**
|
|
99
|
-
*
|
|
105
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
100
106
|
*/
|
|
101
107
|
readonly name: pulumi.Output<string>;
|
|
102
108
|
/**
|
|
103
|
-
* The realm
|
|
109
|
+
* The realm id where the associated client or client scope exists.
|
|
104
110
|
*/
|
|
105
111
|
readonly realmId: pulumi.Output<string>;
|
|
106
112
|
/**
|
|
@@ -116,32 +122,23 @@ export declare class FullNameProtocolMapper extends pulumi.CustomResource {
|
|
|
116
122
|
* Input properties used for looking up and filtering FullNameProtocolMapper resources.
|
|
117
123
|
*/
|
|
118
124
|
export interface FullNameProtocolMapperState {
|
|
119
|
-
/**
|
|
120
|
-
* Indicates if the user's full name should be added as a claim to the access token. Defaults to `true`.
|
|
121
|
-
*/
|
|
122
125
|
addToAccessToken?: pulumi.Input<boolean>;
|
|
123
|
-
/**
|
|
124
|
-
* Indicates if the user's full name should be added as a claim to the id token. Defaults to `true`.
|
|
125
|
-
*/
|
|
126
126
|
addToIdToken?: pulumi.Input<boolean>;
|
|
127
|
-
/**
|
|
128
|
-
* Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
129
|
-
*/
|
|
130
127
|
addToUserinfo?: pulumi.Input<boolean>;
|
|
131
128
|
/**
|
|
132
|
-
* The
|
|
129
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
133
130
|
*/
|
|
134
131
|
clientId?: pulumi.Input<string>;
|
|
135
132
|
/**
|
|
136
|
-
* The
|
|
133
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
137
134
|
*/
|
|
138
135
|
clientScopeId?: pulumi.Input<string>;
|
|
139
136
|
/**
|
|
140
|
-
*
|
|
137
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
141
138
|
*/
|
|
142
139
|
name?: pulumi.Input<string>;
|
|
143
140
|
/**
|
|
144
|
-
* The realm
|
|
141
|
+
* The realm id where the associated client or client scope exists.
|
|
145
142
|
*/
|
|
146
143
|
realmId?: pulumi.Input<string>;
|
|
147
144
|
}
|
|
@@ -149,32 +146,23 @@ export interface FullNameProtocolMapperState {
|
|
|
149
146
|
* The set of arguments for constructing a FullNameProtocolMapper resource.
|
|
150
147
|
*/
|
|
151
148
|
export interface FullNameProtocolMapperArgs {
|
|
152
|
-
/**
|
|
153
|
-
* Indicates if the user's full name should be added as a claim to the access token. Defaults to `true`.
|
|
154
|
-
*/
|
|
155
149
|
addToAccessToken?: pulumi.Input<boolean>;
|
|
156
|
-
/**
|
|
157
|
-
* Indicates if the user's full name should be added as a claim to the id token. Defaults to `true`.
|
|
158
|
-
*/
|
|
159
150
|
addToIdToken?: pulumi.Input<boolean>;
|
|
160
|
-
/**
|
|
161
|
-
* Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to `true`.
|
|
162
|
-
*/
|
|
163
151
|
addToUserinfo?: pulumi.Input<boolean>;
|
|
164
152
|
/**
|
|
165
|
-
* The
|
|
153
|
+
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
|
|
166
154
|
*/
|
|
167
155
|
clientId?: pulumi.Input<string>;
|
|
168
156
|
/**
|
|
169
|
-
* The
|
|
157
|
+
* The mapper's associated client scope. Cannot be used at the same time as client_id.
|
|
170
158
|
*/
|
|
171
159
|
clientScopeId?: pulumi.Input<string>;
|
|
172
160
|
/**
|
|
173
|
-
*
|
|
161
|
+
* A human-friendly name that will appear in the Keycloak console.
|
|
174
162
|
*/
|
|
175
163
|
name?: pulumi.Input<string>;
|
|
176
164
|
/**
|
|
177
|
-
* The realm
|
|
165
|
+
* The realm id where the associated client or client scope exists.
|
|
178
166
|
*/
|
|
179
167
|
realmId: pulumi.Input<string>;
|
|
180
168
|
}
|