-
Notifications
You must be signed in to change notification settings - Fork 6
/
userPropertyProtocolMapper.ts
278 lines (269 loc) · 11.6 KB
/
userPropertyProtocolMapper.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as utilities from "../utilities";
/**
* ## # keycloak.openid.UserPropertyProtocolMapper
*
* Allows for creating and managing user property protocol mappers within
* Keycloak.
*
* User property protocol mappers allow you to map built in properties defined
* on the Keycloak user interface to a claim in a token. Protocol mappers can be
* defined for a single client, or they can be defined for a client scope which
* can be shared between multiple different clients.
*
* ### Example Usage (Client)
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as keycloak from "@pulumi/keycloak";
*
* const realm = new keycloak.Realm("realm", {
* enabled: true,
* realm: "my-realm",
* });
* const openidClient = new keycloak.openid.Client("openidClient", {
* accessType: "CONFIDENTIAL",
* clientId: "test-client",
* enabled: true,
* realmId: realm.id,
* validRedirectUris: ["http://localhost:8080/openid-callback"],
* });
* const userPropertyMapper = new keycloak.openid.UserPropertyProtocolMapper("userPropertyMapper", {
* claimName: "email",
* clientId: openidClient.id,
* realmId: realm.id,
* userProperty: "email",
* });
* ```
*
* ### Example Usage (Client Scope)
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as keycloak from "@pulumi/keycloak";
*
* const realm = new keycloak.Realm("realm", {
* enabled: true,
* realm: "my-realm",
* });
* const clientScope = new keycloak.openid.ClientScope("clientScope", {
* realmId: realm.id,
* });
* const userPropertyMapper = new keycloak.openid.UserPropertyProtocolMapper("userPropertyMapper", {
* claimName: "email",
* clientScopeId: clientScope.id,
* realmId: realm.id,
* userProperty: "email",
* });
* ```
*
* ### Argument Reference
*
* The following arguments are supported:
*
* - `realmId` - (Required) The realm this protocol mapper exists within.
* - `clientId` - (Required if `clientScopeId` is not specified) The client this protocol mapper is attached to.
* - `clientScopeId` - (Required if `clientId` is not specified) The client scope this protocol mapper is attached to.
* - `name` - (Required) The display name of this protocol mapper in the GUI.
* - `userProperty` - (Required) The built in user property (such as email) to map a claim for.
* - `claimName` - (Required) The name of the claim to insert into a token.
* - `claimValueType` - (Optional) The claim type used when serializing JSON tokens. Can be one of `String`, `long`, `int`, or `boolean`. Defaults to `String`.
* - `addToIdToken` - (Optional) Indicates if the property should be added as a claim to the id token. Defaults to `true`.
* - `addToAccessToken` - (Optional) Indicates if the property should be added as a claim to the access token. Defaults to `true`.
* - `addToUserinfo` - (Optional) Indicates if the property should be added as a claim to the UserInfo response body. Defaults to `true`.
*
* > This content is derived from https://github.com/mrparkers/terraform-provider-keycloak/blob/master/website/docs/r/keycloak_openid_user_property_protocol_mapper.html.markdown.
*/
export class UserPropertyProtocolMapper extends pulumi.CustomResource {
/**
* Get an existing UserPropertyProtocolMapper resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserPropertyProtocolMapperState, opts?: pulumi.CustomResourceOptions): UserPropertyProtocolMapper {
return new UserPropertyProtocolMapper(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'keycloak:openid/userPropertyProtocolMapper:UserPropertyProtocolMapper';
/**
* Returns true if the given object is an instance of UserPropertyProtocolMapper. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is UserPropertyProtocolMapper {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === UserPropertyProtocolMapper.__pulumiType;
}
/**
* Indicates if the property should be a claim in the access token.
*/
public readonly addToAccessToken!: pulumi.Output<boolean | undefined>;
/**
* Indicates if the property should be a claim in the id token.
*/
public readonly addToIdToken!: pulumi.Output<boolean | undefined>;
/**
* Indicates if the property should appear in the userinfo response body.
*/
public readonly addToUserinfo!: pulumi.Output<boolean | undefined>;
public readonly claimName!: pulumi.Output<string>;
/**
* Claim type used when serializing tokens.
*/
public readonly claimValueType!: pulumi.Output<string | undefined>;
/**
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
*/
public readonly clientId!: pulumi.Output<string | undefined>;
/**
* The mapper's associated client scope. Cannot be used at the same time as client_id.
*/
public readonly clientScopeId!: pulumi.Output<string | undefined>;
/**
* A human-friendly name that will appear in the Keycloak console.
*/
public readonly name!: pulumi.Output<string>;
/**
* The realm id where the associated client or client scope exists.
*/
public readonly realmId!: pulumi.Output<string>;
public readonly userProperty!: pulumi.Output<string>;
/**
* Create a UserPropertyProtocolMapper resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UserPropertyProtocolMapperArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: UserPropertyProtocolMapperArgs | UserPropertyProtocolMapperState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as UserPropertyProtocolMapperState | undefined;
inputs["addToAccessToken"] = state ? state.addToAccessToken : undefined;
inputs["addToIdToken"] = state ? state.addToIdToken : undefined;
inputs["addToUserinfo"] = state ? state.addToUserinfo : undefined;
inputs["claimName"] = state ? state.claimName : undefined;
inputs["claimValueType"] = state ? state.claimValueType : undefined;
inputs["clientId"] = state ? state.clientId : undefined;
inputs["clientScopeId"] = state ? state.clientScopeId : undefined;
inputs["name"] = state ? state.name : undefined;
inputs["realmId"] = state ? state.realmId : undefined;
inputs["userProperty"] = state ? state.userProperty : undefined;
} else {
const args = argsOrState as UserPropertyProtocolMapperArgs | undefined;
if (!args || args.claimName === undefined) {
throw new Error("Missing required property 'claimName'");
}
if (!args || args.realmId === undefined) {
throw new Error("Missing required property 'realmId'");
}
if (!args || args.userProperty === undefined) {
throw new Error("Missing required property 'userProperty'");
}
inputs["addToAccessToken"] = args ? args.addToAccessToken : undefined;
inputs["addToIdToken"] = args ? args.addToIdToken : undefined;
inputs["addToUserinfo"] = args ? args.addToUserinfo : undefined;
inputs["claimName"] = args ? args.claimName : undefined;
inputs["claimValueType"] = args ? args.claimValueType : undefined;
inputs["clientId"] = args ? args.clientId : undefined;
inputs["clientScopeId"] = args ? args.clientScopeId : undefined;
inputs["name"] = args ? args.name : undefined;
inputs["realmId"] = args ? args.realmId : undefined;
inputs["userProperty"] = args ? args.userProperty : undefined;
}
if (!opts) {
opts = {}
}
if (!opts.version) {
opts.version = utilities.getVersion();
}
super(UserPropertyProtocolMapper.__pulumiType, name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering UserPropertyProtocolMapper resources.
*/
export interface UserPropertyProtocolMapperState {
/**
* Indicates if the property should be a claim in the access token.
*/
readonly addToAccessToken?: pulumi.Input<boolean>;
/**
* Indicates if the property should be a claim in the id token.
*/
readonly addToIdToken?: pulumi.Input<boolean>;
/**
* Indicates if the property should appear in the userinfo response body.
*/
readonly addToUserinfo?: pulumi.Input<boolean>;
readonly claimName?: pulumi.Input<string>;
/**
* Claim type used when serializing tokens.
*/
readonly claimValueType?: pulumi.Input<string>;
/**
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
*/
readonly clientId?: pulumi.Input<string>;
/**
* The mapper's associated client scope. Cannot be used at the same time as client_id.
*/
readonly clientScopeId?: pulumi.Input<string>;
/**
* A human-friendly name that will appear in the Keycloak console.
*/
readonly name?: pulumi.Input<string>;
/**
* The realm id where the associated client or client scope exists.
*/
readonly realmId?: pulumi.Input<string>;
readonly userProperty?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a UserPropertyProtocolMapper resource.
*/
export interface UserPropertyProtocolMapperArgs {
/**
* Indicates if the property should be a claim in the access token.
*/
readonly addToAccessToken?: pulumi.Input<boolean>;
/**
* Indicates if the property should be a claim in the id token.
*/
readonly addToIdToken?: pulumi.Input<boolean>;
/**
* Indicates if the property should appear in the userinfo response body.
*/
readonly addToUserinfo?: pulumi.Input<boolean>;
readonly claimName: pulumi.Input<string>;
/**
* Claim type used when serializing tokens.
*/
readonly claimValueType?: pulumi.Input<string>;
/**
* The mapper's associated client. Cannot be used at the same time as client_scope_id.
*/
readonly clientId?: pulumi.Input<string>;
/**
* The mapper's associated client scope. Cannot be used at the same time as client_id.
*/
readonly clientScopeId?: pulumi.Input<string>;
/**
* A human-friendly name that will appear in the Keycloak console.
*/
readonly name?: pulumi.Input<string>;
/**
* The realm id where the associated client or client scope exists.
*/
readonly realmId: pulumi.Input<string>;
readonly userProperty: pulumi.Input<string>;
}