@keycloak/keycloak-admin-client 16.0.0-dev.62 → 16.0.0-dev.66
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/README.md +2 -0
- package/lib/defs/userProfileConfig.d.ts +31 -0
- package/lib/defs/userProfileConfig.js +3 -0
- package/lib/defs/userProfileConfig.js.map +1 -0
- package/lib/resources/users.d.ts +22 -1
- package/lib/resources/users.js +18 -0
- package/lib/resources/users.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -185,6 +185,8 @@ Demo code: https://github.com/keycloak/keycloak-nodejs-admin-client/blob/master/
|
|
|
185
185
|
- Set up a temporary password for the user User will have to reset the temporary password next time they log in. (`PUT /{realm}/users/{id}/reset-password`)
|
|
186
186
|
- Send an email-verification email to the user An email contains a link the user can click to verify their email address. (`PUT /{realm}/users/{id}/send-verify-email`)
|
|
187
187
|
- Update a credential label for a user (`PUT /{realm}/users/{id}/credentials/{credentialId}/userLabel`)
|
|
188
|
+
- Move a credential to a position behind another credential (`POST /{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}`)
|
|
189
|
+
- Move a credential to a first position in the credentials list of the user (`PUT /{realm}/users/{id}/credentials/{credentialId}/moveToFirst`)
|
|
188
190
|
|
|
189
191
|
### User group-mapping
|
|
190
192
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
export default interface UserProfileConfig {
|
|
2
|
+
attributes?: UserProfileAttribute[];
|
|
3
|
+
groups?: UserProfileGroup[];
|
|
4
|
+
}
|
|
5
|
+
export interface UserProfileAttribute {
|
|
6
|
+
name?: string;
|
|
7
|
+
validations?: Record<string, unknown>[];
|
|
8
|
+
annotations?: Record<string, unknown>[];
|
|
9
|
+
required?: UserProfileAttributeRequired;
|
|
10
|
+
permissions?: UserProfileAttributePermissions;
|
|
11
|
+
selector?: UserProfileAttributeSelector;
|
|
12
|
+
displayName?: string;
|
|
13
|
+
group?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface UserProfileAttributeRequired {
|
|
16
|
+
roles?: string[];
|
|
17
|
+
scopes?: string[];
|
|
18
|
+
}
|
|
19
|
+
export interface UserProfileAttributePermissions {
|
|
20
|
+
view?: string[];
|
|
21
|
+
edit?: string[];
|
|
22
|
+
}
|
|
23
|
+
export interface UserProfileAttributeSelector {
|
|
24
|
+
scopes?: string[];
|
|
25
|
+
}
|
|
26
|
+
export interface UserProfileGroup {
|
|
27
|
+
name?: string;
|
|
28
|
+
displayHeader?: string;
|
|
29
|
+
displayDescription?: string;
|
|
30
|
+
annotations?: Record<string, unknown>[];
|
|
31
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"userProfileConfig.js","sourceRoot":"","sources":["../../src/defs/userProfileConfig.ts"],"names":[],"mappings":""}
|
package/lib/resources/users.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ import { RequiredActionAlias } from '../defs/requiredActionProviderRepresentatio
|
|
|
9
9
|
import FederatedIdentityRepresentation from '../defs/federatedIdentityRepresentation';
|
|
10
10
|
import GroupRepresentation from '../defs/groupRepresentation';
|
|
11
11
|
import CredentialRepresentation from '../defs/credentialRepresentation';
|
|
12
|
+
import UserProfileConfig from '../defs/userProfileConfig';
|
|
12
13
|
export interface UserQuery {
|
|
13
14
|
email?: string;
|
|
14
15
|
first?: number;
|
|
@@ -17,7 +18,8 @@ export interface UserQuery {
|
|
|
17
18
|
max?: number;
|
|
18
19
|
search?: string;
|
|
19
20
|
username?: string;
|
|
20
|
-
|
|
21
|
+
exact?: boolean;
|
|
22
|
+
[key: string]: string | number | undefined | boolean;
|
|
21
23
|
}
|
|
22
24
|
export declare class Users extends Resource<{
|
|
23
25
|
realm?: string;
|
|
@@ -48,6 +50,12 @@ export declare class Users extends Resource<{
|
|
|
48
50
|
count: (payload?: (UserQuery & {
|
|
49
51
|
realm?: string | undefined;
|
|
50
52
|
}) | undefined) => Promise<number>;
|
|
53
|
+
getProfile: (payload?: {
|
|
54
|
+
realm?: string | undefined;
|
|
55
|
+
} | undefined) => Promise<UserProfileConfig>;
|
|
56
|
+
updateProfile: (payload?: (UserProfileConfig & {
|
|
57
|
+
realm?: string | undefined;
|
|
58
|
+
}) | undefined) => Promise<UserProfileConfig>;
|
|
51
59
|
listRoleMappings: (payload?: ({
|
|
52
60
|
id: string;
|
|
53
61
|
} & {
|
|
@@ -193,6 +201,19 @@ export declare class Users extends Resource<{
|
|
|
193
201
|
} & {
|
|
194
202
|
realm?: string | undefined;
|
|
195
203
|
}, payload: string) => Promise<void>;
|
|
204
|
+
moveCredentialPositionDown: (payload?: ({
|
|
205
|
+
id: string;
|
|
206
|
+
credentialId: string;
|
|
207
|
+
newPreviousCredentialId: string;
|
|
208
|
+
} & {
|
|
209
|
+
realm?: string | undefined;
|
|
210
|
+
}) | undefined) => Promise<void>;
|
|
211
|
+
moveCredentialPositionUp: (payload?: ({
|
|
212
|
+
id: string;
|
|
213
|
+
credentialId: string;
|
|
214
|
+
} & {
|
|
215
|
+
realm?: string | undefined;
|
|
216
|
+
}) | undefined) => Promise<void>;
|
|
196
217
|
sendVerifyEmail: (payload?: ({
|
|
197
218
|
id: string;
|
|
198
219
|
clientId?: string | undefined;
|
package/lib/resources/users.js
CHANGED
|
@@ -57,6 +57,14 @@ var Users = (function (_super) {
|
|
|
57
57
|
method: 'GET',
|
|
58
58
|
path: '/count'
|
|
59
59
|
});
|
|
60
|
+
_this.getProfile = _this.makeRequest({
|
|
61
|
+
method: 'GET',
|
|
62
|
+
path: '/profile'
|
|
63
|
+
});
|
|
64
|
+
_this.updateProfile = _this.makeRequest({
|
|
65
|
+
method: 'PUT',
|
|
66
|
+
path: '/profile'
|
|
67
|
+
});
|
|
60
68
|
_this.listRoleMappings = _this.makeRequest({
|
|
61
69
|
method: 'GET',
|
|
62
70
|
path: '/{id}/role-mappings',
|
|
@@ -190,6 +198,16 @@ var Users = (function (_super) {
|
|
|
190
198
|
urlParamKeys: ['id', 'credentialId'],
|
|
191
199
|
headers: { 'content-type': 'text/plain' }
|
|
192
200
|
});
|
|
201
|
+
_this.moveCredentialPositionDown = _this.makeRequest({
|
|
202
|
+
method: 'POST',
|
|
203
|
+
path: '/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}',
|
|
204
|
+
urlParamKeys: ['id', 'credentialId', 'newPreviousCredentialId']
|
|
205
|
+
});
|
|
206
|
+
_this.moveCredentialPositionUp = _this.makeRequest({
|
|
207
|
+
method: 'POST',
|
|
208
|
+
path: '/{id}/credentials/{credentialId}/moveToFirst',
|
|
209
|
+
urlParamKeys: ['id', 'credentialId']
|
|
210
|
+
});
|
|
193
211
|
_this.sendVerifyEmail = _this.makeRequest({
|
|
194
212
|
method: 'PUT',
|
|
195
213
|
path: '/{id}/send-verify-email',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/resources/users.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,wDAAkC;
|
|
1
|
+
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/resources/users.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,wDAAkC;AA2BlC;IAA2B,yBAA0B;IAibnD,eAAY,MAA2B;QAAvC,YACE,kBAAM,MAAM,EAAE;YACZ,IAAI,EAAE,6BAA6B;YACnC,YAAY,EAAE,cAAM,OAAA,CAAC;gBACnB,KAAK,EAAE,MAAM,CAAC,SAAS;aACxB,CAAC,EAFkB,CAElB;YACF,UAAU,EAAE,cAAM,OAAA,MAAM,CAAC,OAAO,EAAd,CAAc;SACjC,CAAC,SACH;QAxbM,UAAI,GAAG,KAAI,CAAC,WAAW,CAAkC;YAC9D,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QAEI,YAAM,GAAG,KAAI,CAAC,WAAW,CAAmC;YACjE,MAAM,EAAE,MAAM;YACd,gCAAgC,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC;SAChD,CAAC,CAAC;QAMI,aAAO,GAAG,KAAI,CAAC,WAAW,CAG/B;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,OAAO;YACb,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;QAEI,YAAM,GAAG,KAAI,CAAC,iBAAiB,CAIpC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,OAAO;YACb,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,SAAG,GAAG,KAAI,CAAC,WAAW,CAAqB;YAChD,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,OAAO;YACb,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,WAAK,GAAG,KAAI,CAAC,WAAW,CAAoB;YACjD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QAEI,gBAAU,GAAG,KAAI,CAAC,WAAW,CAAwB;YAC1D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;QAEI,mBAAa,GAAG,KAAI,CAAC,WAAW,CAAuC;YAC5E,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;QAMI,sBAAgB,GAAG,KAAI,CAAC,WAAW,CAGxC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,0BAAoB,GAAG,KAAI,CAAC,WAAW,CAG5C;YACA,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,2BAA2B;YACjC,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;QAEI,2BAAqB,GAAG,KAAI,CAAC,WAAW,CAG7C;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,2BAA2B;YACjC,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,0BAAoB,GAAG,KAAI,CAAC,WAAW,CAG5C;YACA,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,2BAA2B;YACjC,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;QAEI,oCAA8B,GAAG,KAAI,CAAC,WAAW,CAGtD;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qCAAqC;YAC3C,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAGI,oCAA8B,GAAG,KAAI,CAAC,WAAW,CAGtD;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qCAAqC;YAC3C,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAOI,4BAAsB,GAAG,KAAI,CAAC,WAAW,CAG9C;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,8CAA8C;YACpD,YAAY,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC;SACvC,CAAC,CAAC;QAEI,2BAAqB,GAAG,KAAI,CAAC,WAAW,CAG7C;YACA,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,8CAA8C;YACpD,YAAY,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC;YACtC,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;QAEI,2BAAqB,GAAG,KAAI,CAAC,WAAW,CAG7C;YACA,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,8CAA8C;YACpD,YAAY,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC;YACtC,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;QAEI,qCAA+B,GAAG,KAAI,CAAC,WAAW,CAGvD;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,wDAAwD;YAC9D,YAAY,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC;SACvC,CAAC,CAAC;QAEI,qCAA+B,GAAG,KAAI,CAAC,WAAW,CAGvD;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,wDAAwD;YAC9D,YAAY,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC;SACvC,CAAC,CAAC;QAOI,yBAAmB,GAAG,KAAI,CAAC,WAAW,CAS3C;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,6BAA6B;YACnC,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,UAAU,EAAE,SAAS;YACrB,cAAc,EAAE,CAAC,UAAU,EAAE,aAAa,EAAE,UAAU,CAAC;YACvD,YAAY,EAAE;gBACZ,QAAQ,EAAE,WAAW;gBACrB,WAAW,EAAE,cAAc;aAC5B;SACF,CAAC,CAAC;QAMI,gBAAU,GAAG,KAAI,CAAC,WAAW,CAAqE;YACvG,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,cAAc;YACpB,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,gBAAU,GAAG,KAAI,CAAC,WAAW,CAAwC;YAC1E,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,wBAAwB;YAC9B,YAAY,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC;SAChC,CAAC,CAAC;QAEI,kBAAY,GAAG,KAAI,CAAC,WAAW,CACpC;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,wBAAwB;YAC9B,YAAY,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC;SAChC,CACF,CAAC;QAEK,iBAAW,GAAG,KAAI,CAAC,WAAW,CAGnC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,oBAAoB;YAC1B,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAMI,6BAAuB,GAAG,KAAI,CAAC,WAAW,CAG/C;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,0BAA0B;YAChC,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,4BAAsB,GAAG,KAAI,CAAC,WAAW,CAO9C;YACA,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gDAAgD;YACtD,YAAY,EAAE,CAAC,IAAI,EAAE,qBAAqB,CAAC;YAC3C,UAAU,EAAE,mBAAmB;SAChC,CAAC,CAAC;QAEI,8BAAwB,GAAG,KAAI,CAAC,WAAW,CAGhD;YACA,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,gDAAgD;YACtD,YAAY,EAAE,CAAC,IAAI,EAAE,qBAAqB,CAAC;SAC5C,CAAC,CAAC;QAKI,gBAAU,GAAG,KAAI,CAAC,WAAW,CAAqB;YACvD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mBAAmB;YACzB,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAKI,mBAAa,GAAG,KAAI,CAAC,WAAW,CAGrC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,sBAAsB;YAC5B,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,UAAU,EAAE,YAAY;SACzB,CAAC,CAAC;QAKI,oBAAc,GAAG,KAAI,CAAC,WAAW,CAGtC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mBAAmB;YACzB,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAKI,sBAAgB,GAAG,KAAI,CAAC,WAAW,CAGxC;YACA,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,kCAAkC;YACxC,YAAY,EAAE,CAAC,IAAI,EAAE,cAAc,CAAC;SACrC,CAAC,CAAC;QAKI,2BAAqB,GAAG,KAAI,CAAC,iBAAiB,CAInD;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,4CAA4C;YAClD,YAAY,EAAE,CAAC,IAAI,EAAE,cAAc,CAAC;YACpC,OAAO,EAAE,EAAC,cAAc,EAAE,YAAY,EAAC;SACxC,CAAC,CAAC;QAGI,gCAA0B,GAAG,KAAI,CAAC,WAAW,CAOlD;YACA,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,sEAAsE;YAC5E,YAAY,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,yBAAyB,CAAC;SAChE,CAAC,CAAC;QAGI,8BAAwB,GAAG,KAAI,CAAC,WAAW,CAMhD;YACA,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,8CAA8C;YACpD,YAAY,EAAE,CAAC,IAAI,EAAE,cAAc,CAAC;SACrC,CAAC,CAAC;QAKI,qBAAe,GAAG,KAAI,CAAC,WAAW,CAGvC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,yBAAyB;YAC/B,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,cAAc,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC;YAC3C,YAAY,EAAE;gBACZ,QAAQ,EAAE,WAAW;gBACrB,WAAW,EAAE,cAAc;aAC5B;SACF,CAAC,CAAC;QAKI,kBAAY,GAAG,KAAI,CAAC,WAAW,CAGpC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAKI,yBAAmB,GAAG,KAAI,CAAC,WAAW,CAG3C;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mCAAmC;YACzC,YAAY,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC;SACjC,CAAC,CAAC;QAKI,YAAM,GAAG,KAAI,CAAC,WAAW,CAAqB;YACnD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAKI,kBAAY,GAAG,KAAI,CAAC,WAAW,CAGpC;YACA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAEI,mBAAa,GAAG,KAAI,CAAC,iBAAiB,CAI3C;YACA,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qBAAqB;YAC3B,YAAY,EAAE,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;QAKI,mBAAa,GAAG,KAAI,CAAC,WAAW,CACrC;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,2BAA2B;YACjC,YAAY,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC;SACjC,CACF,CAAC;;IAUF,CAAC;IACH,YAAC;AAAD,CAAC,AA1bD,CAA2B,qBAAQ,GA0blC;AA1bY,sBAAK"}
|