From cd8728aa180cb2dae3fdf697ac2cdd4be462230e Mon Sep 17 00:00:00 2001 From: SferaDev <2181866+SferaDev@users.noreply.github.com> Date: Thu, 6 Nov 2025 12:36:51 +0000 Subject: [PATCH] Update OpenAPI Spec --- .changeset/5fpzo.md | 5 ++ packages/keycloak-api/src/admin/components.ts | 31 ++++++++--- packages/keycloak-api/src/admin/schemas.ts | 51 +++++++++++++++---- 3 files changed, 72 insertions(+), 15 deletions(-) create mode 100644 .changeset/5fpzo.md diff --git a/.changeset/5fpzo.md b/.changeset/5fpzo.md new file mode 100644 index 000000000..3de5b57fc --- /dev/null +++ b/.changeset/5fpzo.md @@ -0,0 +1,5 @@ +--- +"keycloak-api": patch +--- + +Enhance user search query parameters with additional filters. \ No newline at end of file diff --git a/packages/keycloak-api/src/admin/components.ts b/packages/keycloak-api/src/admin/components.ts index 47f47ddb1..848da6de0 100644 --- a/packages/keycloak-api/src/admin/components.ts +++ b/packages/keycloak-api/src/admin/components.ts @@ -13468,29 +13468,47 @@ export type GetAdminRealmsRealmUsersCountPathParams = { export type GetAdminRealmsRealmUsersCountQueryParams = { /** - * email filter + * A String contained in email, or the complete email, if param "exact" is true */ email?: string; + /** + * whether the email has been verified + */ emailVerified?: boolean; /** * Boolean representing if user is enabled or not */ enabled?: boolean; /** - * first name filter + * Boolean which defines whether the params "last", "first", "email" and "username" must match exactly + */ + exact?: boolean; + /** + * A String contained in firstName, or the complete firstName, if param "exact" is true */ firstName?: string; /** - * last name filter + * The alias of an Identity Provider linked to the user + */ + idpAlias?: string; + /** + * The userId at an Identity Provider linked to the user + */ + idpUserId?: string; + /** + * A String contained in lastName, or the complete lastName, if param "exact" is true */ lastName?: string; + /** + * A query to search for custom attributes, in the format 'key1:value2 key2:value2' + */ q?: string; /** - * 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. + * 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. */ search?: string; /** - * username filter + * A String contained in username, or the complete username, if param "exact" is true */ username?: string; }; @@ -14195,6 +14213,7 @@ export type PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderError = export type PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderVariables = { + body?: Schemas.FederatedIdentityRepresentation; pathParams: PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderPathParams; } & FetcherExtraProps; @@ -14205,7 +14224,7 @@ export const postAdminRealmsRealmUsersUserIdFederatedIdentityProvider = ( fetch< undefined, PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderError, - undefined, + Schemas.FederatedIdentityRepresentation, {}, {}, PostAdminRealmsRealmUsersUserIdFederatedIdentityProviderPathParams diff --git a/packages/keycloak-api/src/admin/schemas.ts b/packages/keycloak-api/src/admin/schemas.ts index 75817d447..eb145c4b5 100644 --- a/packages/keycloak-api/src/admin/schemas.ts +++ b/packages/keycloak-api/src/admin/schemas.ts @@ -583,6 +583,7 @@ export type ComponentTypeRepresentation = { id?: string; helpText?: string; properties?: ConfigPropertyRepresentation[]; + clientProperties?: ConfigPropertyRepresentation[]; metadata?: { [key: string]: any; }; @@ -921,7 +922,7 @@ export type KeyStoreConfig = { validity?: number; }; -export type KeyUse = "ENC" | "SIG"; +export type KeyUse = "ENC" | "JWT_SVID" | "SIG"; export type KeysMetadataRepresentation = { active?: { @@ -1641,14 +1642,6 @@ export type RealmRepresentation = { * @deprecated true */ clientTemplates?: ClientTemplateRepresentation[]; - /** - * @format int32 - */ - oAuth2DeviceCodeLifespan?: number; - /** - * @format int32 - */ - oAuth2DevicePollingInterval?: number; }; export type RequiredActionConfigInfoRepresentation = { @@ -1812,6 +1805,7 @@ export type UPAttribute = { selector?: UPAttributeSelector; group?: string; multivalued?: boolean; + defaultValue?: string; }; export type UPAttributePermissions = { @@ -1938,6 +1932,7 @@ export type UserProfileAttributeMetadata = { }; group?: string; multivalued?: boolean; + defaultValue?: string; }; export type UserProfileMetadata = { @@ -2017,3 +2012,41 @@ export type UserSessionRepresentation = { }; transientUser?: boolean; }; + +export type WorkflowConditionRepresentation = { + uses?: string; + id?: string; + config?: MultivaluedHashMapStringString; +}; + +export type WorkflowRepresentation = { + id?: string; + name?: string; + uses?: string; + enabled?: boolean; + on?: void; + ["reset-on"]?: void; + recurring?: boolean; + ["if"]?: WorkflowConditionRepresentation[]; + steps?: WorkflowStepRepresentation[]; + state?: WorkflowStateRepresentation; + ["with"]?: MultivaluedHashMapStringString; + onValues?: string[]; + onEventsReset?: string[]; +}; + +export type WorkflowSetRepresentation = { + workflows?: WorkflowRepresentation[]; +}; + +export type WorkflowStateRepresentation = { + errors?: string[]; +}; + +export type WorkflowStepRepresentation = { + id?: string; + uses?: string; + after?: string; + priority?: string; + config?: MultivaluedHashMapStringString; +};