@keycloak/keycloak-admin-client 17.0.0-dev.21 → 17.0.0-dev.25
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/lib/client.d.ts +4 -0
- package/lib/client.js +4 -0
- package/lib/client.js.map +1 -1
- package/lib/defs/policyRepresentation.d.ts +4 -0
- package/lib/defs/policyRepresentation.js +6 -1
- package/lib/defs/policyRepresentation.js.map +1 -1
- package/lib/defs/policyResultRepresentation.d.ts +7 -0
- package/lib/defs/policyResultRepresentation.js +3 -0
- package/lib/defs/policyResultRepresentation.js.map +1 -0
- package/lib/resources/agent.d.ts +1 -1
- package/lib/resources/agent.js +4 -14
- package/lib/resources/agent.js.map +1 -1
- package/lib/resources/attackDetection.d.ts +3 -3
- package/lib/resources/authenticationManagement.d.ts +27 -27
- package/lib/resources/cache.d.ts +1 -1
- package/lib/resources/clientPolicies.d.ts +4 -4
- package/lib/resources/clientScopes.d.ts +21 -21
- package/lib/resources/clients.d.ts +68 -68
- package/lib/resources/components.d.ts +5 -5
- package/lib/resources/groups.d.ts +18 -18
- package/lib/resources/identityProviders.d.ts +11 -11
- package/lib/resources/realms.d.ts +26 -26
- package/lib/resources/resource.d.ts +1 -1
- package/lib/resources/roles.d.ts +10 -10
- package/lib/resources/serverInfo.d.ts +1 -1
- package/lib/resources/sessions.d.ts +1 -1
- package/lib/resources/userStorageProvider.d.ts +5 -5
- package/lib/resources/users.d.ts +38 -38
- package/lib/resources/whoAmI.d.ts +1 -1
- package/package.json +1 -1
|
@@ -20,17 +20,17 @@ export declare class Groups extends Resource<{
|
|
|
20
20
|
}> {
|
|
21
21
|
find: (payload?: (GroupQuery & {
|
|
22
22
|
realm?: string | undefined;
|
|
23
|
-
}) | undefined) => Promise<GroupRepresentation[]>;
|
|
23
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<GroupRepresentation[]>;
|
|
24
24
|
create: (payload?: (GroupRepresentation & {
|
|
25
25
|
realm?: string | undefined;
|
|
26
|
-
}) | undefined) => Promise<{
|
|
26
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
|
|
27
27
|
id: string;
|
|
28
28
|
}>;
|
|
29
29
|
findOne: (payload?: ({
|
|
30
30
|
id: string;
|
|
31
31
|
} & {
|
|
32
32
|
realm?: string | undefined;
|
|
33
|
-
}) | undefined) => Promise<GroupRepresentation | undefined>;
|
|
33
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<GroupRepresentation | undefined>;
|
|
34
34
|
update: (query: {
|
|
35
35
|
id: string;
|
|
36
36
|
} & {
|
|
@@ -40,10 +40,10 @@ export declare class Groups extends Resource<{
|
|
|
40
40
|
id: string;
|
|
41
41
|
} & {
|
|
42
42
|
realm?: string | undefined;
|
|
43
|
-
}) | undefined) => Promise<void>;
|
|
43
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
44
44
|
count: (payload?: (GroupCountQuery & {
|
|
45
45
|
realm?: string | undefined;
|
|
46
|
-
}) | undefined) => Promise<{
|
|
46
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
|
|
47
47
|
count: number;
|
|
48
48
|
}>;
|
|
49
49
|
setOrCreateChild: (query: {
|
|
@@ -59,71 +59,71 @@ export declare class Groups extends Resource<{
|
|
|
59
59
|
max?: number | undefined;
|
|
60
60
|
} & {
|
|
61
61
|
realm?: string | undefined;
|
|
62
|
-
}) | undefined) => Promise<UserRepresentation[]>;
|
|
62
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserRepresentation[]>;
|
|
63
63
|
listRoleMappings: (payload?: ({
|
|
64
64
|
id: string;
|
|
65
65
|
} & {
|
|
66
66
|
realm?: string | undefined;
|
|
67
|
-
}) | undefined) => Promise<MappingsRepresentation>;
|
|
67
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<MappingsRepresentation>;
|
|
68
68
|
addRealmRoleMappings: (payload?: ({
|
|
69
69
|
id: string;
|
|
70
70
|
roles: RoleMappingPayload[];
|
|
71
71
|
} & {
|
|
72
72
|
realm?: string | undefined;
|
|
73
|
-
}) | undefined) => Promise<void>;
|
|
73
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
74
74
|
listRealmRoleMappings: (payload?: ({
|
|
75
75
|
id: string;
|
|
76
76
|
} & {
|
|
77
77
|
realm?: string | undefined;
|
|
78
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
78
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
79
79
|
delRealmRoleMappings: (payload?: ({
|
|
80
80
|
id: string;
|
|
81
81
|
roles: RoleMappingPayload[];
|
|
82
82
|
} & {
|
|
83
83
|
realm?: string | undefined;
|
|
84
|
-
}) | undefined) => Promise<void>;
|
|
84
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
85
85
|
listAvailableRealmRoleMappings: (payload?: ({
|
|
86
86
|
id: string;
|
|
87
87
|
} & {
|
|
88
88
|
realm?: string | undefined;
|
|
89
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
89
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
90
90
|
listCompositeRealmRoleMappings: (payload?: ({
|
|
91
91
|
id: string;
|
|
92
92
|
} & {
|
|
93
93
|
realm?: string | undefined;
|
|
94
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
94
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
95
95
|
listClientRoleMappings: (payload?: ({
|
|
96
96
|
id: string;
|
|
97
97
|
clientUniqueId: string;
|
|
98
98
|
} & {
|
|
99
99
|
realm?: string | undefined;
|
|
100
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
100
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
101
101
|
addClientRoleMappings: (payload?: ({
|
|
102
102
|
id: string;
|
|
103
103
|
clientUniqueId: string;
|
|
104
104
|
roles: RoleMappingPayload[];
|
|
105
105
|
} & {
|
|
106
106
|
realm?: string | undefined;
|
|
107
|
-
}) | undefined) => Promise<void>;
|
|
107
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
108
108
|
delClientRoleMappings: (payload?: ({
|
|
109
109
|
id: string;
|
|
110
110
|
clientUniqueId: string;
|
|
111
111
|
roles: RoleMappingPayload[];
|
|
112
112
|
} & {
|
|
113
113
|
realm?: string | undefined;
|
|
114
|
-
}) | undefined) => Promise<void>;
|
|
114
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
115
115
|
listAvailableClientRoleMappings: (payload?: ({
|
|
116
116
|
id: string;
|
|
117
117
|
clientUniqueId: string;
|
|
118
118
|
} & {
|
|
119
119
|
realm?: string | undefined;
|
|
120
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
120
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
121
121
|
listCompositeClientRoleMappings: (payload?: ({
|
|
122
122
|
id: string;
|
|
123
123
|
clientUniqueId: string;
|
|
124
124
|
} & {
|
|
125
125
|
realm?: string | undefined;
|
|
126
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
126
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
127
127
|
updatePermission: (query: {
|
|
128
128
|
id: string;
|
|
129
129
|
} & {
|
|
@@ -133,6 +133,6 @@ export declare class Groups extends Resource<{
|
|
|
133
133
|
id: string;
|
|
134
134
|
} & {
|
|
135
135
|
realm?: string | undefined;
|
|
136
|
-
}) | undefined) => Promise<ManagementPermissionReference>;
|
|
136
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<ManagementPermissionReference>;
|
|
137
137
|
constructor(client: KeycloakAdminClient);
|
|
138
138
|
}
|
|
@@ -8,17 +8,17 @@ export declare class IdentityProviders extends Resource<{
|
|
|
8
8
|
}> {
|
|
9
9
|
find: (payload?: (void & {
|
|
10
10
|
realm?: string | undefined;
|
|
11
|
-
}) | undefined) => Promise<IdentityProviderRepresentation[]>;
|
|
11
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;
|
|
12
12
|
create: (payload?: (IdentityProviderRepresentation & {
|
|
13
13
|
realm?: string | undefined;
|
|
14
|
-
}) | undefined) => Promise<{
|
|
14
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
|
|
15
15
|
id: string;
|
|
16
16
|
}>;
|
|
17
17
|
findOne: (payload?: ({
|
|
18
18
|
alias: string;
|
|
19
19
|
} & {
|
|
20
20
|
realm?: string | undefined;
|
|
21
|
-
}) | undefined) => Promise<IdentityProviderRepresentation | undefined>;
|
|
21
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation | undefined>;
|
|
22
22
|
update: (query: {
|
|
23
23
|
alias: string;
|
|
24
24
|
} & {
|
|
@@ -28,29 +28,29 @@ export declare class IdentityProviders extends Resource<{
|
|
|
28
28
|
alias: string;
|
|
29
29
|
} & {
|
|
30
30
|
realm?: string | undefined;
|
|
31
|
-
}) | undefined) => Promise<void>;
|
|
31
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
32
32
|
findFactory: (payload?: ({
|
|
33
33
|
providerId: string;
|
|
34
34
|
} & {
|
|
35
35
|
realm?: string | undefined;
|
|
36
|
-
}) | undefined) => Promise<any>;
|
|
36
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
|
|
37
37
|
findMappers: (payload?: ({
|
|
38
38
|
alias: string;
|
|
39
39
|
} & {
|
|
40
40
|
realm?: string | undefined;
|
|
41
|
-
}) | undefined) => Promise<IdentityProviderMapperRepresentation[]>;
|
|
41
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderMapperRepresentation[]>;
|
|
42
42
|
findOneMapper: (payload?: ({
|
|
43
43
|
alias: string;
|
|
44
44
|
id: string;
|
|
45
45
|
} & {
|
|
46
46
|
realm?: string | undefined;
|
|
47
|
-
}) | undefined) => Promise<IdentityProviderMapperRepresentation | undefined>;
|
|
47
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderMapperRepresentation | undefined>;
|
|
48
48
|
createMapper: (payload?: ({
|
|
49
49
|
alias: string;
|
|
50
50
|
identityProviderMapper: IdentityProviderMapperRepresentation;
|
|
51
51
|
} & {
|
|
52
52
|
realm?: string | undefined;
|
|
53
|
-
}) | undefined) => Promise<{
|
|
53
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
|
|
54
54
|
id: string;
|
|
55
55
|
}>;
|
|
56
56
|
updateMapper: (query: {
|
|
@@ -64,17 +64,17 @@ export declare class IdentityProviders extends Resource<{
|
|
|
64
64
|
id: string;
|
|
65
65
|
} & {
|
|
66
66
|
realm?: string | undefined;
|
|
67
|
-
}) | undefined) => Promise<void>;
|
|
67
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
68
68
|
findMapperTypes: (payload?: ({
|
|
69
69
|
alias: string;
|
|
70
70
|
} & {
|
|
71
71
|
realm?: string | undefined;
|
|
72
|
-
}) | undefined) => Promise<Record<string, IdentityProviderMapperTypeRepresentation>>;
|
|
72
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<Record<string, IdentityProviderMapperTypeRepresentation>>;
|
|
73
73
|
importFromUrl: (payload?: ({
|
|
74
74
|
fromUrl: string;
|
|
75
75
|
providerId: string;
|
|
76
76
|
} & {
|
|
77
77
|
realm?: string | undefined;
|
|
78
|
-
}) | undefined) => Promise<Record<string, string>>;
|
|
78
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<Record<string, string>>;
|
|
79
79
|
constructor(client: KeycloakAdminClient);
|
|
80
80
|
}
|
|
@@ -13,39 +13,39 @@ import GroupRepresentation from '../defs/groupRepresentation';
|
|
|
13
13
|
export declare class Realms extends Resource {
|
|
14
14
|
find: (payload?: {
|
|
15
15
|
briefRepresentation?: boolean | undefined;
|
|
16
|
-
} | undefined) => Promise<RealmRepresentation[]>;
|
|
17
|
-
create: (payload?: RealmRepresentation | undefined) => Promise<{
|
|
16
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RealmRepresentation[]>;
|
|
17
|
+
create: (payload?: RealmRepresentation | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
|
|
18
18
|
realmName: string;
|
|
19
19
|
}>;
|
|
20
20
|
findOne: (payload?: {
|
|
21
21
|
realm: string;
|
|
22
|
-
} | undefined) => Promise<RealmRepresentation | undefined>;
|
|
22
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RealmRepresentation | undefined>;
|
|
23
23
|
update: (query: {
|
|
24
24
|
realm: string;
|
|
25
25
|
}, payload: RealmRepresentation) => Promise<void>;
|
|
26
26
|
del: (payload?: {
|
|
27
27
|
realm: string;
|
|
28
|
-
} | undefined) => Promise<void>;
|
|
28
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
29
29
|
partialImport: (payload?: {
|
|
30
30
|
realm: string;
|
|
31
31
|
rep: PartialImportRealmRepresentation;
|
|
32
|
-
} | undefined) => Promise<PartialImportResponse>;
|
|
32
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<PartialImportResponse>;
|
|
33
33
|
export: (payload?: {
|
|
34
34
|
realm: string;
|
|
35
35
|
exportClients?: boolean | undefined;
|
|
36
36
|
exportGroupsAndRoles?: boolean | undefined;
|
|
37
|
-
} | undefined) => Promise<RealmRepresentation>;
|
|
37
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RealmRepresentation>;
|
|
38
38
|
getDefaultGroups: (payload?: {
|
|
39
39
|
realm: string;
|
|
40
|
-
} | undefined) => Promise<GroupRepresentation[]>;
|
|
40
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<GroupRepresentation[]>;
|
|
41
41
|
addDefaultGroup: (payload?: {
|
|
42
42
|
realm: string;
|
|
43
43
|
id: string;
|
|
44
|
-
} | undefined) => Promise<any>;
|
|
44
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
|
|
45
45
|
removeDefaultGroup: (payload?: {
|
|
46
46
|
realm: string;
|
|
47
47
|
id: string;
|
|
48
|
-
} | undefined) => Promise<any>;
|
|
48
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
|
|
49
49
|
findEvents: (payload?: {
|
|
50
50
|
realm: string;
|
|
51
51
|
client?: string | undefined;
|
|
@@ -56,22 +56,22 @@ export declare class Realms extends Resource {
|
|
|
56
56
|
max?: number | undefined;
|
|
57
57
|
type?: EventType | EventType[] | undefined;
|
|
58
58
|
user?: string | undefined;
|
|
59
|
-
} | undefined) => Promise<EventRepresentation[]>;
|
|
59
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<EventRepresentation[]>;
|
|
60
60
|
getConfigEvents: (payload?: {
|
|
61
61
|
realm: string;
|
|
62
|
-
} | undefined) => Promise<RealmEventsConfigRepresentation>;
|
|
62
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RealmEventsConfigRepresentation>;
|
|
63
63
|
updateConfigEvents: (query: {
|
|
64
64
|
realm: string;
|
|
65
65
|
}, payload: RealmEventsConfigRepresentation) => Promise<void>;
|
|
66
66
|
clearEvents: (payload?: {
|
|
67
67
|
realm: string;
|
|
68
|
-
} | undefined) => Promise<void>;
|
|
68
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
69
69
|
clearAdminEvents: (payload?: {
|
|
70
70
|
realm: string;
|
|
71
|
-
} | undefined) => Promise<void>;
|
|
71
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
72
72
|
getClientsInitialAccess: (payload?: {
|
|
73
73
|
realm: string;
|
|
74
|
-
} | undefined) => Promise<ClientInitialAccessPresentation[]>;
|
|
74
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<ClientInitialAccessPresentation[]>;
|
|
75
75
|
createClientsInitialAccess: (query: {
|
|
76
76
|
realm: string;
|
|
77
77
|
}, payload: {
|
|
@@ -81,11 +81,11 @@ export declare class Realms extends Resource {
|
|
|
81
81
|
delClientsInitialAccess: (payload?: {
|
|
82
82
|
realm: string;
|
|
83
83
|
id: string;
|
|
84
|
-
} | undefined) => Promise<void>;
|
|
84
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
85
85
|
removeSession: (payload?: {
|
|
86
86
|
realm: string;
|
|
87
87
|
sessionId: string;
|
|
88
|
-
} | undefined) => Promise<void>;
|
|
88
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
89
89
|
findAdminEvents: (payload?: {
|
|
90
90
|
realm: string;
|
|
91
91
|
authClient?: string | undefined;
|
|
@@ -99,27 +99,27 @@ export declare class Realms extends Resource {
|
|
|
99
99
|
operationTypes?: string | undefined;
|
|
100
100
|
resourcePath?: string | undefined;
|
|
101
101
|
resourceTypes?: string | undefined;
|
|
102
|
-
} | undefined) => Promise<AdminEventRepresentation[]>;
|
|
102
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<AdminEventRepresentation[]>;
|
|
103
103
|
getUsersManagementPermissions: (payload?: {
|
|
104
104
|
realm: string;
|
|
105
|
-
} | undefined) => Promise<void>;
|
|
105
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
106
106
|
updateUsersManagementPermissions: (payload?: {
|
|
107
107
|
realm: string;
|
|
108
108
|
enabled: boolean;
|
|
109
|
-
} | undefined) => Promise<void>;
|
|
109
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
110
110
|
logoutAll: (payload?: {
|
|
111
111
|
realm: string;
|
|
112
|
-
} | undefined) => Promise<void>;
|
|
112
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
113
113
|
deleteSession: (payload?: {
|
|
114
114
|
realm: string;
|
|
115
115
|
session: string;
|
|
116
|
-
} | undefined) => Promise<void>;
|
|
116
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
117
117
|
pushRevocation: (payload?: {
|
|
118
118
|
realm: string;
|
|
119
|
-
} | undefined) => Promise<GlobalRequestResult>;
|
|
119
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<GlobalRequestResult>;
|
|
120
120
|
getKeys: (payload?: {
|
|
121
121
|
realm: string;
|
|
122
|
-
} | undefined) => Promise<KeysMetadataRepresentation>;
|
|
122
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<KeysMetadataRepresentation>;
|
|
123
123
|
testLDAPConnection: (query: {
|
|
124
124
|
realm: string;
|
|
125
125
|
}, payload: TestLdapConnectionRepresentation) => Promise<any>;
|
|
@@ -128,13 +128,13 @@ export declare class Realms extends Resource {
|
|
|
128
128
|
}, payload: Record<string, string | number>) => Promise<any>;
|
|
129
129
|
getRealmSpecificLocales: (payload?: {
|
|
130
130
|
realm: string;
|
|
131
|
-
} | undefined) => Promise<string[]>;
|
|
131
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<string[]>;
|
|
132
132
|
getRealmLocalizationTexts: (payload?: {
|
|
133
133
|
realm: string;
|
|
134
134
|
selectedLocale: string;
|
|
135
135
|
first?: number | undefined;
|
|
136
136
|
max?: number | undefined;
|
|
137
|
-
} | undefined) => Promise<Record<string, string>>;
|
|
137
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<Record<string, string>>;
|
|
138
138
|
addLocalization: (query: {
|
|
139
139
|
realm: string;
|
|
140
140
|
selectedLocale: string;
|
|
@@ -144,6 +144,6 @@ export declare class Realms extends Resource {
|
|
|
144
144
|
realm: string;
|
|
145
145
|
selectedLocale: string;
|
|
146
146
|
key?: string | undefined;
|
|
147
|
-
} | undefined) => Promise<void>;
|
|
147
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
148
148
|
constructor(client: KeycloakAdminClient);
|
|
149
149
|
}
|
|
@@ -7,6 +7,6 @@ export default class Resource<ParamType = {}> {
|
|
|
7
7
|
getUrlParams?: () => Record<string, any>;
|
|
8
8
|
getBaseUrl?: () => string;
|
|
9
9
|
});
|
|
10
|
-
makeRequest: <PayloadType = any, ResponseType_1 = any>(args: RequestArgs) => (payload?: (PayloadType & ParamType) | undefined) => Promise<ResponseType_1>;
|
|
10
|
+
makeRequest: <PayloadType = any, ResponseType_1 = any>(args: RequestArgs) => (payload?: (PayloadType & ParamType) | undefined, options?: Pick<RequestArgs, "catchNotFound"> | undefined) => Promise<ResponseType_1>;
|
|
11
11
|
makeUpdateRequest: <QueryType = any, PayloadType = any, ResponseType_1 = any>(args: RequestArgs) => (query: QueryType & ParamType, payload: PayloadType) => Promise<ResponseType_1>;
|
|
12
12
|
}
|
package/lib/resources/roles.d.ts
CHANGED
|
@@ -12,17 +12,17 @@ export declare class Roles extends Resource<{
|
|
|
12
12
|
}> {
|
|
13
13
|
find: (payload?: (RoleQuery & {
|
|
14
14
|
realm?: string | undefined;
|
|
15
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
15
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
16
16
|
create: (payload?: (RoleRepresentation & {
|
|
17
17
|
realm?: string | undefined;
|
|
18
|
-
}) | undefined) => Promise<{
|
|
18
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
|
|
19
19
|
roleName: string;
|
|
20
20
|
}>;
|
|
21
21
|
findOneByName: (payload?: ({
|
|
22
22
|
name: string;
|
|
23
23
|
} & {
|
|
24
24
|
realm?: string | undefined;
|
|
25
|
-
}) | undefined) => Promise<RoleRepresentation | undefined>;
|
|
25
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation | undefined>;
|
|
26
26
|
updateByName: (query: {
|
|
27
27
|
name: string;
|
|
28
28
|
} & {
|
|
@@ -32,19 +32,19 @@ export declare class Roles extends Resource<{
|
|
|
32
32
|
name: string;
|
|
33
33
|
} & {
|
|
34
34
|
realm?: string | undefined;
|
|
35
|
-
}) | undefined) => Promise<void>;
|
|
35
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
36
36
|
findUsersWithRole: (payload?: ({
|
|
37
37
|
name: string;
|
|
38
38
|
first?: number | undefined;
|
|
39
39
|
max?: number | undefined;
|
|
40
40
|
} & {
|
|
41
41
|
realm?: string | undefined;
|
|
42
|
-
}) | undefined) => Promise<UserRepresentation[]>;
|
|
42
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserRepresentation[]>;
|
|
43
43
|
findOneById: (payload?: ({
|
|
44
44
|
id: string;
|
|
45
45
|
} & {
|
|
46
46
|
realm?: string | undefined;
|
|
47
|
-
}) | undefined) => Promise<RoleRepresentation | undefined>;
|
|
47
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation | undefined>;
|
|
48
48
|
createComposite: (query: {
|
|
49
49
|
roleId: string;
|
|
50
50
|
} & {
|
|
@@ -57,18 +57,18 @@ export declare class Roles extends Resource<{
|
|
|
57
57
|
max?: number | undefined;
|
|
58
58
|
} & {
|
|
59
59
|
realm?: string | undefined;
|
|
60
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
60
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
61
61
|
getCompositeRolesForRealm: (payload?: ({
|
|
62
62
|
id: string;
|
|
63
63
|
} & {
|
|
64
64
|
realm?: string | undefined;
|
|
65
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
65
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
66
66
|
getCompositeRolesForClient: (payload?: ({
|
|
67
67
|
id: string;
|
|
68
68
|
clientId: string;
|
|
69
69
|
} & {
|
|
70
70
|
realm?: string | undefined;
|
|
71
|
-
}) | undefined) => Promise<RoleRepresentation[]>;
|
|
71
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
|
|
72
72
|
delCompositeRoles: (query: {
|
|
73
73
|
id: string;
|
|
74
74
|
} & {
|
|
@@ -83,6 +83,6 @@ export declare class Roles extends Resource<{
|
|
|
83
83
|
id: string;
|
|
84
84
|
} & {
|
|
85
85
|
realm?: string | undefined;
|
|
86
|
-
}) | undefined) => Promise<void>;
|
|
86
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
87
87
|
constructor(client: KeycloakAdminClient);
|
|
88
88
|
}
|
|
@@ -3,5 +3,5 @@ import { ServerInfoRepresentation } from '../defs/serverInfoRepesentation';
|
|
|
3
3
|
import KeycloakAdminClient from '..';
|
|
4
4
|
export declare class ServerInfo extends Resource {
|
|
5
5
|
constructor(client: KeycloakAdminClient);
|
|
6
|
-
find: (payload?: {} | undefined) => Promise<ServerInfoRepresentation>;
|
|
6
|
+
find: (payload?: {} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<ServerInfoRepresentation>;
|
|
7
7
|
}
|
|
@@ -5,6 +5,6 @@ export declare class Sessions extends Resource<{
|
|
|
5
5
|
}> {
|
|
6
6
|
find: (payload?: {
|
|
7
7
|
realm?: string | undefined;
|
|
8
|
-
} | undefined) => Promise<Record<string, any>[]>;
|
|
8
|
+
} | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<Record<string, any>[]>;
|
|
9
9
|
constructor(client: KeycloakAdminClient);
|
|
10
10
|
}
|
|
@@ -14,30 +14,30 @@ export declare class UserStorageProvider extends Resource<{
|
|
|
14
14
|
id: string;
|
|
15
15
|
} & {
|
|
16
16
|
realm?: string | undefined;
|
|
17
|
-
}) | undefined) => Promise<NameResponse>;
|
|
17
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<NameResponse>;
|
|
18
18
|
removeImportedUsers: (payload?: ({
|
|
19
19
|
id: string;
|
|
20
20
|
} & {
|
|
21
21
|
realm?: string | undefined;
|
|
22
|
-
}) | undefined) => Promise<void>;
|
|
22
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
23
23
|
sync: (payload?: ({
|
|
24
24
|
id: string;
|
|
25
25
|
action?: ActionType | undefined;
|
|
26
26
|
} & {
|
|
27
27
|
realm?: string | undefined;
|
|
28
|
-
}) | undefined) => Promise<SynchronizationResultRepresentation>;
|
|
28
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<SynchronizationResultRepresentation>;
|
|
29
29
|
unlinkUsers: (payload?: ({
|
|
30
30
|
id: string;
|
|
31
31
|
} & {
|
|
32
32
|
realm?: string | undefined;
|
|
33
|
-
}) | undefined) => Promise<void>;
|
|
33
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
|
|
34
34
|
mappersSync: (payload?: ({
|
|
35
35
|
id: string;
|
|
36
36
|
parentId: string;
|
|
37
37
|
direction?: DirectionType | undefined;
|
|
38
38
|
} & {
|
|
39
39
|
realm?: string | undefined;
|
|
40
|
-
}) | undefined) => Promise<SynchronizationResultRepresentation>;
|
|
40
|
+
}) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<SynchronizationResultRepresentation>;
|
|
41
41
|
constructor(client: KeycloakAdminClient);
|
|
42
42
|
}
|
|
43
43
|
export {};
|