cheshirecat-typescript-client 1.7.11 → 1.7.12
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.
|
@@ -11,10 +11,11 @@ export declare class UsersEndpoint extends AbstractEndpoint {
|
|
|
11
11
|
* @param username The username of the user.
|
|
12
12
|
* @param password The password of the user.
|
|
13
13
|
* @param permissions The permissions of the user.
|
|
14
|
+
* @param metadata The metadata of the user.
|
|
14
15
|
*
|
|
15
16
|
* @returns The created user.
|
|
16
17
|
*/
|
|
17
|
-
postUser(agentId: string, username: string, password: string, permissions?: Record<string, string[]> | null): Promise<UserOutput>;
|
|
18
|
+
postUser(agentId: string, username: string, password: string, permissions?: Record<string, string[]> | null, metadata?: Record<string, any> | null): Promise<UserOutput>;
|
|
18
19
|
/**
|
|
19
20
|
* This endpoint is used to get a list of users in the system. The list includes the username and the permissions of
|
|
20
21
|
* each user. The permissions are used to define the access rights of the users in the system and are defined by the
|
|
@@ -48,10 +49,11 @@ export declare class UsersEndpoint extends AbstractEndpoint {
|
|
|
48
49
|
* @param username The username of the user.
|
|
49
50
|
* @param password The password of the user.
|
|
50
51
|
* @param permissions The permissions of the user.
|
|
52
|
+
* @param metadata The metadata of the user.
|
|
51
53
|
*
|
|
52
54
|
* @returns The updated user.
|
|
53
55
|
*/
|
|
54
|
-
putUser(userId: string, agentId: string, username?: string | null, password?: string | null, permissions?: Record<string, string[]> | null): Promise<UserOutput>;
|
|
56
|
+
putUser(userId: string, agentId: string, username?: string | null, password?: string | null, permissions?: Record<string, string[]> | null, metadata?: Record<string, any> | null): Promise<UserOutput>;
|
|
55
57
|
/**
|
|
56
58
|
* This endpoint is used to delete the user in the system. The user is identified by the userId parameter,
|
|
57
59
|
* previously provided by the CheshireCat API when the user was created.
|
package/dist/endpoints/users.js
CHANGED
|
@@ -13,18 +13,17 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
13
13
|
* @param username The username of the user.
|
|
14
14
|
* @param password The password of the user.
|
|
15
15
|
* @param permissions The permissions of the user.
|
|
16
|
+
* @param metadata The metadata of the user.
|
|
16
17
|
*
|
|
17
18
|
* @returns The created user.
|
|
18
19
|
*/
|
|
19
|
-
async postUser(agentId, username, password, permissions) {
|
|
20
|
+
async postUser(agentId, username, password, permissions, metadata) {
|
|
20
21
|
const payload = {
|
|
21
22
|
username,
|
|
22
23
|
password,
|
|
23
|
-
permissions: permissions
|
|
24
|
+
...permissions && { permissions: permissions },
|
|
25
|
+
...metadata && { metadata: metadata },
|
|
24
26
|
};
|
|
25
|
-
if (permissions) {
|
|
26
|
-
payload.permissions = permissions;
|
|
27
|
-
}
|
|
28
27
|
return this.post(this.prefix, agentId, payload);
|
|
29
28
|
}
|
|
30
29
|
/**
|
|
@@ -70,20 +69,17 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
70
69
|
* @param username The username of the user.
|
|
71
70
|
* @param password The password of the user.
|
|
72
71
|
* @param permissions The permissions of the user.
|
|
72
|
+
* @param metadata The metadata of the user.
|
|
73
73
|
*
|
|
74
74
|
* @returns The updated user.
|
|
75
75
|
*/
|
|
76
|
-
async putUser(userId, agentId, username, password, permissions) {
|
|
77
|
-
const payload = {
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
}
|
|
84
|
-
if (permissions) {
|
|
85
|
-
payload.permissions = permissions;
|
|
86
|
-
}
|
|
76
|
+
async putUser(userId, agentId, username, password, permissions, metadata) {
|
|
77
|
+
const payload = {
|
|
78
|
+
...username && { username: username },
|
|
79
|
+
...password && { password: password },
|
|
80
|
+
...permissions && { permissions: permissions },
|
|
81
|
+
...metadata && { metadata: metadata },
|
|
82
|
+
};
|
|
87
83
|
return this.put(this.formatUrl(userId), agentId, payload);
|
|
88
84
|
}
|
|
89
85
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/endpoints/users.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAG5C,MAAa,aAAc,SAAQ,2BAAgB;IACrC,MAAM,GAAG,QAAQ,CAAC;IAE5B
|
|
1
|
+
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/endpoints/users.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAG5C,MAAa,aAAc,SAAQ,2BAAgB;IACrC,MAAM,GAAG,QAAQ,CAAC;IAE5B;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,QAAQ,CACV,OAAe,EACf,QAAgB,EAChB,QAAgB,EAChB,WAA6C,EAC7C,QAAqC;QAErC,MAAM,OAAO,GAAG;YACZ,QAAQ;YACR,QAAQ;YACR,GAAG,WAAW,IAAI,EAAC,WAAW,EAAE,WAAW,EAAC;YAC5C,GAAG,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAa,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAa,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,OAAe;QACzC,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,OAAO,CACT,MAAc,EACd,OAAe,EACf,QAAwB,EACxB,QAAwB,EACxB,WAA6C,EAC7C,QAAqC;QAErC,MAAM,OAAO,GAAQ;YACjB,GAAG,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC;YACnC,GAAG,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC;YACnC,GAAG,WAAW,IAAI,EAAC,WAAW,EAAE,WAAW,EAAC;YAC5C,GAAG,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAAe;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACJ;AAjHD,sCAiHC"}
|