Skip to content

Commit dfb053e

Browse files
kilorkkilork
authored
Keycloak Admin REST API v26.1.0 (#149)
1 parent 72c9f0b commit dfb053e

File tree

6 files changed

+619
-497
lines changed

6 files changed

+619
-497
lines changed

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "keycloak"
3-
version = "26.0.700"
3+
version = "26.1.0"
44
authors = ["Alexander Korolev <alexander.korolev.germany@gmail.com>"]
55
edition = "2021"
66
categories = ["api-bindings", "asynchronous"]

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).
66

77
## Features
88

9-
Implements [Keycloak Admin REST API version 26.0.7](https://www.keycloak.org/docs-api/26.0.7/rest-api/index.html).
9+
Implements [Keycloak Admin REST API version 26.1.0](https://www.keycloak.org/docs-api/26.1.0/rest-api/index.html).
1010

1111
### Feature flags
1212

@@ -24,7 +24,7 @@ Add dependency to Cargo.toml:
2424

2525
```toml
2626
[dependencies]
27-
keycloak = "26.0"
27+
keycloak = "26.1"
2828
```
2929

3030
```rust

‎api/openapi.json‎

Lines changed: 80 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8352,7 +8352,7 @@
83528352
"/admin/realms/{realm}/groups" : {
83538353
"get" : {
83548354
"tags" : [ "Groups" ],
8355-
"summary" : "Get group hierarchy. Only name and ids are returned.",
8355+
"summary" : "Get group hierarchy. Only `name` and `id` are returned. `subGroups` are only returned when using the `search` or `q` parameter. If none of these parameters is provided, the top-level groups are returned without `subGroups` being filled.",
83568356
"parameters" : [ {
83578357
"name" : "briefRepresentation",
83588358
"in" : "query",
@@ -10044,12 +10044,12 @@
1004410044
}
1004510045
} ]
1004610046
},
10047-
"/admin/realms/{realm}/organizations/members/{id}/organizations" : {
10047+
"/admin/realms/{realm}/organizations/members/{member-id}/organizations" : {
1004810048
"get" : {
1004910049
"tags" : [ "Organizations" ],
1005010050
"summary" : "Returns the organizations associated with the user that has the specified id",
1005110051
"parameters" : [ {
10052-
"name" : "id",
10052+
"name" : "member-id",
1005310053
"in" : "path",
1005410054
"required" : true,
1005510055
"schema" : {
@@ -10082,7 +10082,7 @@
1008210082
}
1008310083
} ]
1008410084
},
10085-
"/admin/realms/{realm}/organizations/{id}" : {
10085+
"/admin/realms/{realm}/organizations/{org-id}" : {
1008610086
"get" : {
1008710087
"tags" : [ "Organizations" ],
1008810088
"summary" : "Returns the organization representation",
@@ -10135,15 +10135,15 @@
1013510135
"type" : "string"
1013610136
}
1013710137
}, {
10138-
"name" : "id",
10138+
"name" : "org-id",
1013910139
"in" : "path",
1014010140
"required" : true,
1014110141
"schema" : {
1014210142
"type" : "string"
1014310143
}
1014410144
} ]
1014510145
},
10146-
"/admin/realms/{realm}/organizations/{id}/identity-providers" : {
10146+
"/admin/realms/{realm}/organizations/{org-id}/identity-providers" : {
1014710147
"get" : {
1014810148
"tags" : [ "Organizations" ],
1014910149
"summary" : "Returns all identity providers associated with the organization",
@@ -10191,15 +10191,15 @@
1019110191
"type" : "string"
1019210192
}
1019310193
}, {
10194-
"name" : "id",
10194+
"name" : "org-id",
1019510195
"in" : "path",
1019610196
"required" : true,
1019710197
"schema" : {
1019810198
"type" : "string"
1019910199
}
1020010200
} ]
1020110201
},
10202-
"/admin/realms/{realm}/organizations/{id}/identity-providers/{alias}" : {
10202+
"/admin/realms/{realm}/organizations/{org-id}/identity-providers/{alias}" : {
1020310203
"get" : {
1020410204
"tags" : [ "Organizations" ],
1020510205
"summary" : "Returns the identity provider associated with the organization that has the specified alias",
@@ -10252,15 +10252,15 @@
1025210252
"type" : "string"
1025310253
}
1025410254
}, {
10255-
"name" : "id",
10255+
"name" : "org-id",
1025610256
"in" : "path",
1025710257
"required" : true,
1025810258
"schema" : {
1025910259
"type" : "string"
1026010260
}
1026110261
} ]
1026210262
},
10263-
"/admin/realms/{realm}/organizations/{id}/members" : {
10263+
"/admin/realms/{realm}/organizations/{org-id}/members" : {
1026410264
"get" : {
1026510265
"tags" : [ "Organizations" ],
1026610266
"summary" : "Returns a paginated list of organization members filtered according to the specified parameters",
@@ -10348,15 +10348,15 @@
1034810348
"type" : "string"
1034910349
}
1035010350
}, {
10351-
"name" : "id",
10351+
"name" : "org-id",
1035210352
"in" : "path",
1035310353
"required" : true,
1035410354
"schema" : {
1035510355
"type" : "string"
1035610356
}
1035710357
} ]
1035810358
},
10359-
"/admin/realms/{realm}/organizations/{id}/members/count" : {
10359+
"/admin/realms/{realm}/organizations/{org-id}/members/count" : {
1036010360
"get" : {
1036110361
"tags" : [ "Organizations" ],
1036210362
"summary" : "Returns number of members in the organization.",
@@ -10383,15 +10383,15 @@
1038310383
"type" : "string"
1038410384
}
1038510385
}, {
10386-
"name" : "id",
10386+
"name" : "org-id",
1038710387
"in" : "path",
1038810388
"required" : true,
1038910389
"schema" : {
1039010390
"type" : "string"
1039110391
}
1039210392
} ]
1039310393
},
10394-
"/admin/realms/{realm}/organizations/{id}/members/invite-existing-user" : {
10394+
"/admin/realms/{realm}/organizations/{org-id}/members/invite-existing-user" : {
1039510395
"post" : {
1039610396
"tags" : [ "Organizations" ],
1039710397
"summary" : "Invites an existing user to the organization, using the specified user id",
@@ -10424,15 +10424,15 @@
1042410424
"type" : "string"
1042510425
}
1042610426
}, {
10427-
"name" : "id",
10427+
"name" : "org-id",
1042810428
"in" : "path",
1042910429
"required" : true,
1043010430
"schema" : {
1043110431
"type" : "string"
1043210432
}
1043310433
} ]
1043410434
},
10435-
"/admin/realms/{realm}/organizations/{id}/members/invite-user" : {
10435+
"/admin/realms/{realm}/organizations/{org-id}/members/invite-user" : {
1043610436
"post" : {
1043710437
"tags" : [ "Organizations" ],
1043810438
"summary" : "Invites an existing user or sends a registration link to a new user, based on the provided e-mail address.",
@@ -10472,21 +10472,21 @@
1047210472
"type" : "string"
1047310473
}
1047410474
}, {
10475-
"name" : "id",
10475+
"name" : "org-id",
1047610476
"in" : "path",
1047710477
"required" : true,
1047810478
"schema" : {
1047910479
"type" : "string"
1048010480
}
1048110481
} ]
1048210482
},
10483-
"/admin/realms/{realm}/organizations/{id}/members/{id}" : {
10483+
"/admin/realms/{realm}/organizations/{org-id}/members/{member-id}" : {
1048410484
"get" : {
1048510485
"tags" : [ "Organizations" ],
1048610486
"summary" : "Returns the member of the organization with the specified id",
1048710487
"description" : "Searches for auser with the given id. If one is found, and is currently a member of the organization, returns it. Otherwise,an error response with status NOT_FOUND is returned",
1048810488
"parameters" : [ {
10489-
"name" : "id",
10489+
"name" : "member-id",
1049010490
"in" : "path",
1049110491
"required" : true,
1049210492
"schema" : {
@@ -10511,7 +10511,7 @@
1051110511
"summary" : "Removes the user with the specified id from the organization",
1051210512
"description" : "Breaks the association between the user and organization. The user itself is deleted in case the membership is managed, otherwise the user is not deleted. If no user is found, or if they are not a member of the organization, an error response is returned",
1051310513
"parameters" : [ {
10514-
"name" : "id",
10514+
"name" : "member-id",
1051510515
"in" : "path",
1051610516
"required" : true,
1051710517
"schema" : {
@@ -10532,14 +10532,21 @@
1053210532
"schema" : {
1053310533
"type" : "string"
1053410534
}
10535+
}, {
10536+
"name" : "org-id",
10537+
"in" : "path",
10538+
"required" : true,
10539+
"schema" : {
10540+
"type" : "string"
10541+
}
1053510542
} ]
1053610543
},
10537-
"/admin/realms/{realm}/organizations/{id}/members/{id}/organizations" : {
10544+
"/admin/realms/{realm}/organizations/{org-id}/members/{member-id}/organizations" : {
1053810545
"get" : {
1053910546
"tags" : [ "Organizations" ],
1054010547
"summary" : "Returns the organizations associated with the user that has the specified id",
1054110548
"parameters" : [ {
10542-
"name" : "id",
10549+
"name" : "member-id",
1054310550
"in" : "path",
1054410551
"required" : true,
1054510552
"schema" : {
@@ -10570,6 +10577,13 @@
1057010577
"schema" : {
1057110578
"type" : "string"
1057210579
}
10580+
}, {
10581+
"name" : "org-id",
10582+
"in" : "path",
10583+
"required" : true,
10584+
"schema" : {
10585+
"type" : "string"
10586+
}
1057310587
} ]
1057410588
},
1057510589
"/admin/realms/{realm}/partial-export" : {
@@ -13458,6 +13472,9 @@
1345813472
"owner" : {
1345913473
"type" : "string"
1346013474
},
13475+
"resourceType" : {
13476+
"type" : "string"
13477+
},
1346113478
"resourcesData" : {
1346213479
"uniqueItems" : true,
1346313480
"type" : "array",
@@ -14096,6 +14113,17 @@
1409614113
}
1409714114
}
1409814115
},
14116+
"AuthorizationSchema" : {
14117+
"type" : "object",
14118+
"properties" : {
14119+
"resourceTypes" : {
14120+
"type" : "object",
14121+
"additionalProperties" : {
14122+
"$ref" : "#/components/schemas/ResourceType"
14123+
}
14124+
}
14125+
}
14126+
},
1409914127
"BruteForceStrategy" : {
1410014128
"enum" : [ "LINEAR", "MULTIPLE" ],
1410114129
"type" : "string"
@@ -16062,6 +16090,9 @@
1606216090
"owner" : {
1606316091
"type" : "string"
1606416092
},
16093+
"resourceType" : {
16094+
"type" : "string"
16095+
},
1606516096
"resourcesData" : {
1606616097
"uniqueItems" : true,
1606716098
"type" : "array",
@@ -16444,6 +16475,9 @@
1644416475
"defaultRole" : {
1644516476
"$ref" : "#/components/schemas/RoleRepresentation"
1644616477
},
16478+
"adminPermissionsClient" : {
16479+
"$ref" : "#/components/schemas/ClientRepresentation"
16480+
},
1644716481
"defaultGroups" : {
1644816482
"type" : "array",
1644916483
"items" : {
@@ -16799,6 +16833,12 @@
1679916833
"$ref" : "#/components/schemas/OrganizationRepresentation"
1680016834
}
1680116835
},
16836+
"verifiableCredentialsEnabled" : {
16837+
"type" : "boolean"
16838+
},
16839+
"adminPermissionsEnabled" : {
16840+
"type" : "boolean"
16841+
},
1680216842
"social" : {
1680316843
"type" : "boolean",
1680416844
"deprecated" : true
@@ -17021,6 +17061,24 @@
1702117061
},
1702217062
"decisionStrategy" : {
1702317063
"$ref" : "#/components/schemas/DecisionStrategy"
17064+
},
17065+
"authorizationSchema" : {
17066+
"$ref" : "#/components/schemas/AuthorizationSchema"
17067+
}
17068+
}
17069+
},
17070+
"ResourceType" : {
17071+
"type" : "object",
17072+
"properties" : {
17073+
"type" : {
17074+
"type" : "string"
17075+
},
17076+
"scopes" : {
17077+
"uniqueItems" : true,
17078+
"type" : "array",
17079+
"items" : {
17080+
"type" : "string"
17081+
}
1702417082
}
1702517083
}
1702617084
},

‎src/lib.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).
77
88
## Features
99
10-
Implements [Keycloak Admin REST API version 26.0.7](https://www.keycloak.org/docs-api/26.0.7/rest-api/index.html).
10+
Implements [Keycloak Admin REST API version 26.1.0](https://www.keycloak.org/docs-api/26.1.0/rest-api/index.html).
1111
1212
### Feature flags
1313
@@ -25,7 +25,7 @@ Add dependency to Cargo.toml:
2525
2626
```toml
2727
[dependencies]
28-
keycloak = "26.0"
28+
keycloak = "26.1"
2929
```
3030
3131
```rust, no_run

0 commit comments

Comments
 (0)