Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release v22.0.500 #92

Merged
merged 1 commit into from
Mar 29, 2024
Merged

Release v22.0.500 #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "keycloak"
version = "22.0.301"
version = "22.0.500"
authors = ["Alexander Korolev <[email protected]>"]
edition = "2021"
categories = ["api-bindings", "asynchronous"]
Expand Down
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).

## Features

Implements [Keycloak Admin REST API version 22.0.3](https://www.keycloak.org/docs-api/22.0.3/rest-api/index.html).
Implements [Keycloak Admin REST API version 22.0.5](https://www.keycloak.org/docs-api/22.0.5/rest-api/index.html).

To add [schemars](https://crates.io/crates/schemars) support enable feature `schemars`.
### Feature flags

Default flags: `tags-all`.

- `rc`: use `Arc` for deserialization.
- `schemars`: add [schemars](https://crates.io/crates/schemars) support.
- `tags-all`: activate all tags (resource groups) in REST API, it is default behavior. Disable default features and use individual `tag-xxx` features to activate only required resource groups. For a full list reference the [Cargo.toml](Cargo.toml).

## Usage

Expand Down
55 changes: 55 additions & 0 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8945,6 +8945,32 @@
}
} ]
},
"/admin/realms/{realm}/users/profile/metadata" : {
"get" : {
"tags" : [ "Users" ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserProfileMetadata"
}
}
}
}
}
},
"parameters" : [ {
"name" : "realm",
"in" : "path",
"description" : "realm name (not id!)",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/users/{id}" : {
"get" : {
"tags" : [ "Users" ],
Expand Down Expand Up @@ -13497,6 +13523,26 @@
"UserManagedAccessConfig" : {
"type" : "object"
},
"UserProfileAttributeGroupMetadata" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"displayHeader" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"annotations" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"UserProfileAttributeMetadata" : {
"type" : "object",
"properties" : {
Expand Down Expand Up @@ -13526,6 +13572,9 @@
"type" : "object"
}
}
},
"group" : {
"type" : "string"
}
}
},
Expand All @@ -13537,6 +13586,12 @@
"items" : {
"$ref" : "#/components/schemas/UserProfileAttributeMetadata"
}
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserProfileAttributeGroupMetadata"
}
}
}
},
Expand Down
132 changes: 128 additions & 4 deletions docs/rest-api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,7 @@ <h1>Keycloak Admin REST API</h1>
<li><a href="#UserConsentRepresentation">UserConsentRepresentation</a></li>
<li><a href="#UserFederationMapperRepresentation">UserFederationMapperRepresentation</a></li>
<li><a href="#UserFederationProviderRepresentation">UserFederationProviderRepresentation</a></li>
<li><a href="#UserProfileAttributeGroupMetadata">UserProfileAttributeGroupMetadata</a></li>
<li><a href="#UserProfileAttributeMetadata">UserProfileAttributeMetadata</a></li>
<li><a href="#UserProfileMetadata">UserProfileMetadata</a></li>
<li><a href="#UserRepresentation">UserRepresentation</a></li>
Expand Down Expand Up @@ -28136,8 +28137,8 @@ <h5 id="_responses_313">Responses</h5>
</table>
</div>
</div>
<div class="sect3 adminRealmsRealmUsersProfilePut">
<h4 id="_put_adminrealmsrealmusersprofile">PUT /admin/realms/{realm}/users/profile</h4>
<div class="sect3 adminRealmsRealmUsersProfileMetadataGet">
<h4 id="_get_adminrealmsrealmusersprofilemetadata">GET /admin/realms/{realm}/users/profile/metadata</h4>
<div class="sect4">
<h5 id="_parameters_314">Parameters</h5>
<div class="sect5">
Expand Down Expand Up @@ -28168,6 +28169,74 @@ <h6 id="_path_parameters_312">Path Parameters</h6>
</tbody>
</table>
</div>
</div>
<div class="sect4">
<h5 id="_content_type_171">Content Type</h5>
<div class="ulist">
<ul>
<li>
<p><code>application/json</code></p>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="_responses_314">Responses</h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 50%;">
<col style="width: 16.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Code</th>
<th class="tableblock halign-left valign-top">Message</th>
<th class="tableblock halign-left valign-top">Datatype</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">OK</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#UserProfileMetadata">UserProfileMetadata</a></p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect3 adminRealmsRealmUsersProfilePut">
<h4 id="_put_adminrealmsrealmusersprofile">PUT /admin/realms/{realm}/users/profile</h4>
<div class="sect4">
<h5 id="_parameters_315">Parameters</h5>
<div class="sect5">
<h6 id="_path_parameters_313">Path Parameters</h6>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 42.8571%;">
<col style="width: 14.2857%;">
<col style="width: 14.2858%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
<th class="tableblock halign-left valign-top">Pattern</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>realm</strong><br>
<em>required</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">realm name (not id!)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">null</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
<div class="sect5">
<h6 id="_body_parameter_96">Body Parameter</h6>
<table class="tableblock frame-all grid-all stretch">
Expand Down Expand Up @@ -28198,7 +28267,7 @@ <h6 id="_body_parameter_96">Body Parameter</h6>
</div>
</div>
<div class="sect4">
<h5 id="_responses_314">Responses</h5>
<h5 id="_responses_315">Responses</h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
Expand Down Expand Up @@ -34052,6 +34121,49 @@ <h3 id="UserFederationProviderRepresentation">UserFederationProviderRepresentati
</table>
</div>
<div class="sect2">
<h3 id="UserProfileAttributeGroupMetadata">UserProfileAttributeGroupMetadata</h3>
<table class="tableblock frame-all grid-all stretch fields-UserProfileAttributeGroupMetadata">
<colgroup>
<col style="width: 40%;">
<col style="width: 40%;">
<col style="width: 20%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Format</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>name</strong><br>
<em>optional</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>displayHeader</strong><br>
<em>optional</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>displayDescription</strong><br>
<em>optional</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>annotations</strong><br>
<em>optional</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Map of <a href="#object">[object]</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="UserProfileAttributeMetadata">UserProfileAttributeMetadata</h3>
<table class="tableblock frame-all grid-all stretch fields-UserProfileAttributeMetadata">
<colgroup>
Expand Down Expand Up @@ -34103,6 +34215,12 @@ <h3 id="UserProfileAttributeMetadata">UserProfileAttributeMetadata</h3>
<td class="tableblock halign-left valign-top"><p class="tableblock">Map of <a href="#map">[map]</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>group</strong><br>
<em>optional</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
Expand All @@ -34128,6 +34246,12 @@ <h3 id="UserProfileMetadata">UserProfileMetadata</h3>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of <a href="#UserProfileAttributeMetadata">UserProfileAttributeMetadata</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>groups</strong><br>
<em>optional</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of <a href="#UserProfileAttributeGroupMetadata">UserProfileAttributeGroupMetadata</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -34317,7 +34441,7 @@ <h3 id="UserRepresentation">UserRepresentation</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-09-12 17:20:13 UTC
Last updated 2023-10-24 09:35:47 UTC
</div>
</div>
</body>
Expand Down
10 changes: 8 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,15 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).

## Features

Implements [Keycloak Admin REST API version 22.0.3](https://www.keycloak.org/docs-api/22.0.3/rest-api/index.html).
Implements [Keycloak Admin REST API version 22.0.5](https://www.keycloak.org/docs-api/22.0.5/rest-api/index.html).

To add [schemars](https://crates.io/crates/schemars) support enable feature `schemars`.
### Feature flags

Default flags: `tags-all`.

- `rc`: use `Arc` for deserialization.
- `schemars`: add [schemars](https://crates.io/crates/schemars) support.
- `tags-all`: activate all tags (resource groups) in REST API, it is default behavior. Disable default features and use individual `tag-xxx` features to activate only required resource groups. For a full list reference the [Cargo.toml](Cargo.toml).

## Usage

Expand Down
Loading
Loading