Skip to content

Commit 1f5e6fb

Browse files
committed
Update OpenAPI Spec
1 parent fee0531 commit 1f5e6fb

File tree

3 files changed

+72
-15
lines changed

3 files changed

+72
-15
lines changed

.changeset/jqd82.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"keycloak-api": patch
3+
---
4+
5+
Enhance GetAdminRealmsRealmUsersCountQueryParams with new filters and exact match option.

packages/keycloak-api/src/admin/components.ts

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13468,29 +13468,47 @@ export type GetAdminRealmsRealmUsersCountPathParams = {
1346813468

1346913469
export type GetAdminRealmsRealmUsersCountQueryParams = {
1347013470
/**
13471-
* email filter
13471+
* A String contained in email, or the complete email, if param "exact" is true
1347213472
*/
1347313473
email?: string;
13474+
/**
13475+
* whether the email has been verified
13476+
*/
1347413477
emailVerified?: boolean;
1347513478
/**
1347613479
* Boolean representing if user is enabled or not
1347713480
*/
1347813481
enabled?: boolean;
1347913482
/**
13480-
* first name filter
13483+
* Boolean which defines whether the params "last", "first", "email" and "username" must match exactly
13484+
*/
13485+
exact?: boolean;
13486+
/**
13487+
* A String contained in firstName, or the complete firstName, if param "exact" is true
1348113488
*/
1348213489
firstName?: string;
1348313490
/**
13484-
* last name filter
13491+
* The alias of an Identity Provider linked to the user
13492+
*/
13493+
idpAlias?: string;
13494+
/**
13495+
* The userId at an Identity Provider linked to the user
13496+
*/
13497+
idpUserId?: string;
13498+
/**
13499+
* A String contained in lastName, or the complete lastName, if param "exact" is true
1348513500
*/
1348613501
lastName?: string;
13502+
/**
13503+
* A query to search for custom attributes, in the format 'key1:value2 key2:value2'
13504+
*/
1348713505
q?: string;
1348813506
/**
13489-
* arbitrary search string for all the fields below. Default search behavior is prefix-based (e.g., foo or foo*). Use *foo* for infix search and "foo" for exact search.
13507+
* A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use *foo* for infix search and "foo" for exact search.
1349013508
*/
1349113509
search?: string;
1349213510
/**
13493-
* username filter
13511+
* A String contained in username, or the complete username, if param "exact" is true
1349413512
*/
1349513513
username?: string;
1349613514
};
@@ -14195,6 +14213,7 @@ export type PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderError =
1419514213

1419614214
export type PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderVariables =
1419714215
{
14216+
body?: Schemas.FederatedIdentityRepresentation;
1419814217
pathParams: PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderPathParams;
1419914218
} & FetcherExtraProps;
1420014219

@@ -14205,7 +14224,7 @@ export const postAdminRealmsRealmUsersUserIdFederatedIdentityProvider = (
1420514224
fetch<
1420614225
undefined,
1420714226
PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderError,
14208-
undefined,
14227+
Schemas.FederatedIdentityRepresentation,
1420914228
{},
1421014229
{},
1421114230
PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderPathParams

packages/keycloak-api/src/admin/schemas.ts

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,7 @@ export type ComponentTypeRepresentation = {
583583
id?: string;
584584
helpText?: string;
585585
properties?: ConfigPropertyRepresentation[];
586+
clientProperties?: ConfigPropertyRepresentation[];
586587
metadata?: {
587588
[key: string]: any;
588589
};
@@ -921,7 +922,7 @@ export type KeyStoreConfig = {
921922
validity?: number;
922923
};
923924

924-
export type KeyUse = "ENC" | "SIG";
925+
export type KeyUse = "ENC" | "JWT_SVID" | "SIG";
925926

926927
export type KeysMetadataRepresentation = {
927928
active?: {
@@ -1641,14 +1642,6 @@ export type RealmRepresentation = {
16411642
* @deprecated true
16421643
*/
16431644
clientTemplates?: ClientTemplateRepresentation[];
1644-
/**
1645-
* @format int32
1646-
*/
1647-
oAuth2DeviceCodeLifespan?: number;
1648-
/**
1649-
* @format int32
1650-
*/
1651-
oAuth2DevicePollingInterval?: number;
16521645
};
16531646

16541647
export type RequiredActionConfigInfoRepresentation = {
@@ -1812,6 +1805,7 @@ export type UPAttribute = {
18121805
selector?: UPAttributeSelector;
18131806
group?: string;
18141807
multivalued?: boolean;
1808+
defaultValue?: string;
18151809
};
18161810

18171811
export type UPAttributePermissions = {
@@ -1938,6 +1932,7 @@ export type UserProfileAttributeMetadata = {
19381932
};
19391933
group?: string;
19401934
multivalued?: boolean;
1935+
defaultValue?: string;
19411936
};
19421937

19431938
export type UserProfileMetadata = {
@@ -2017,3 +2012,41 @@ export type UserSessionRepresentation = {
20172012
};
20182013
transientUser?: boolean;
20192014
};
2015+
2016+
export type WorkflowConditionRepresentation = {
2017+
uses?: string;
2018+
id?: string;
2019+
config?: MultivaluedHashMapStringString;
2020+
};
2021+
2022+
export type WorkflowRepresentation = {
2023+
id?: string;
2024+
name?: string;
2025+
uses?: string;
2026+
enabled?: boolean;
2027+
on?: void;
2028+
["reset-on"]?: void;
2029+
recurring?: boolean;
2030+
["if"]?: WorkflowConditionRepresentation[];
2031+
steps?: WorkflowStepRepresentation[];
2032+
state?: WorkflowStateRepresentation;
2033+
["with"]?: MultivaluedHashMapStringString;
2034+
onValues?: string[];
2035+
onEventsReset?: string[];
2036+
};
2037+
2038+
export type WorkflowSetRepresentation = {
2039+
workflows?: WorkflowRepresentation[];
2040+
};
2041+
2042+
export type WorkflowStateRepresentation = {
2043+
errors?: string[];
2044+
};
2045+
2046+
export type WorkflowStepRepresentation = {
2047+
id?: string;
2048+
uses?: string;
2049+
after?: string;
2050+
priority?: string;
2051+
config?: MultivaluedHashMapStringString;
2052+
};

0 commit comments

Comments
 (0)