Skip to content

Commit

Permalink
Keycloak Admin REST API v26.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kilork committed Jan 22, 2025
1 parent 72c9f0b commit 0874476
Show file tree
Hide file tree
Showing 6 changed files with 619 additions and 497 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "keycloak"
version = "26.0.700"
version = "26.1.0"
authors = ["Alexander Korolev <[email protected]>"]
edition = "2021"
categories = ["api-bindings", "asynchronous"]
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).

## Features

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

### Feature flags

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

```toml
[dependencies]
keycloak = "26.0"
keycloak = "26.1"
```

```rust
Expand Down
102 changes: 80 additions & 22 deletions api/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -8352,7 +8352,7 @@
"/admin/realms/{realm}/groups" : {
"get" : {
"tags" : [ "Groups" ],
"summary" : "Get group hierarchy. Only name and ids are returned.",
"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.",
"parameters" : [ {
"name" : "briefRepresentation",
"in" : "query",
Expand Down Expand Up @@ -10044,12 +10044,12 @@
}
} ]
},
"/admin/realms/{realm}/organizations/members/{id}/organizations" : {
"/admin/realms/{realm}/organizations/members/{member-id}/organizations" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns the organizations associated with the user that has the specified id",
"parameters" : [ {
"name" : "id",
"name" : "member-id",
"in" : "path",
"required" : true,
"schema" : {
Expand Down Expand Up @@ -10082,7 +10082,7 @@
}
} ]
},
"/admin/realms/{realm}/organizations/{id}" : {
"/admin/realms/{realm}/organizations/{org-id}" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns the organization representation",
Expand Down Expand Up @@ -10135,15 +10135,15 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/identity-providers" : {
"/admin/realms/{realm}/organizations/{org-id}/identity-providers" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns all identity providers associated with the organization",
Expand Down Expand Up @@ -10191,15 +10191,15 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/identity-providers/{alias}" : {
"/admin/realms/{realm}/organizations/{org-id}/identity-providers/{alias}" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns the identity provider associated with the organization that has the specified alias",
Expand Down Expand Up @@ -10252,15 +10252,15 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/members" : {
"/admin/realms/{realm}/organizations/{org-id}/members" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns a paginated list of organization members filtered according to the specified parameters",
Expand Down Expand Up @@ -10348,15 +10348,15 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/members/count" : {
"/admin/realms/{realm}/organizations/{org-id}/members/count" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns number of members in the organization.",
Expand All @@ -10383,15 +10383,15 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/members/invite-existing-user" : {
"/admin/realms/{realm}/organizations/{org-id}/members/invite-existing-user" : {
"post" : {
"tags" : [ "Organizations" ],
"summary" : "Invites an existing user to the organization, using the specified user id",
Expand Down Expand Up @@ -10424,15 +10424,15 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/members/invite-user" : {
"/admin/realms/{realm}/organizations/{org-id}/members/invite-user" : {
"post" : {
"tags" : [ "Organizations" ],
"summary" : "Invites an existing user or sends a registration link to a new user, based on the provided e-mail address.",
Expand Down Expand Up @@ -10472,21 +10472,21 @@
"type" : "string"
}
}, {
"name" : "id",
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/members/{id}" : {
"/admin/realms/{realm}/organizations/{org-id}/members/{member-id}" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns the member of the organization with the specified id",
"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",
"parameters" : [ {
"name" : "id",
"name" : "member-id",
"in" : "path",
"required" : true,
"schema" : {
Expand All @@ -10511,7 +10511,7 @@
"summary" : "Removes the user with the specified id from the organization",
"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",
"parameters" : [ {
"name" : "id",
"name" : "member-id",
"in" : "path",
"required" : true,
"schema" : {
Expand All @@ -10532,14 +10532,21 @@
"schema" : {
"type" : "string"
}
}, {
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/organizations/{id}/members/{id}/organizations" : {
"/admin/realms/{realm}/organizations/{org-id}/members/{member-id}/organizations" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "Returns the organizations associated with the user that has the specified id",
"parameters" : [ {
"name" : "id",
"name" : "member-id",
"in" : "path",
"required" : true,
"schema" : {
Expand Down Expand Up @@ -10570,6 +10577,13 @@
"schema" : {
"type" : "string"
}
}, {
"name" : "org-id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ]
},
"/admin/realms/{realm}/partial-export" : {
Expand Down Expand Up @@ -13458,6 +13472,9 @@
"owner" : {
"type" : "string"
},
"resourceType" : {
"type" : "string"
},
"resourcesData" : {
"uniqueItems" : true,
"type" : "array",
Expand Down Expand Up @@ -14096,6 +14113,17 @@
}
}
},
"AuthorizationSchema" : {
"type" : "object",
"properties" : {
"resourceTypes" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/ResourceType"
}
}
}
},
"BruteForceStrategy" : {
"enum" : [ "LINEAR", "MULTIPLE" ],
"type" : "string"
Expand Down Expand Up @@ -16062,6 +16090,9 @@
"owner" : {
"type" : "string"
},
"resourceType" : {
"type" : "string"
},
"resourcesData" : {
"uniqueItems" : true,
"type" : "array",
Expand Down Expand Up @@ -16444,6 +16475,9 @@
"defaultRole" : {
"$ref" : "#/components/schemas/RoleRepresentation"
},
"adminPermissionsClient" : {
"$ref" : "#/components/schemas/ClientRepresentation"
},
"defaultGroups" : {
"type" : "array",
"items" : {
Expand Down Expand Up @@ -16799,6 +16833,12 @@
"$ref" : "#/components/schemas/OrganizationRepresentation"
}
},
"verifiableCredentialsEnabled" : {
"type" : "boolean"
},
"adminPermissionsEnabled" : {
"type" : "boolean"
},
"social" : {
"type" : "boolean",
"deprecated" : true
Expand Down Expand Up @@ -17021,6 +17061,24 @@
},
"decisionStrategy" : {
"$ref" : "#/components/schemas/DecisionStrategy"
},
"authorizationSchema" : {
"$ref" : "#/components/schemas/AuthorizationSchema"
}
}
},
"ResourceType" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"scopes" : {
"uniqueItems" : true,
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).
## Features
Implements [Keycloak Admin REST API version 26.0.7](https://www.keycloak.org/docs-api/26.0.7/rest-api/index.html).
Implements [Keycloak Admin REST API version 26.1.0](https://www.keycloak.org/docs-api/26.1.0/rest-api/index.html).
### Feature flags
Expand All @@ -25,7 +25,7 @@ Add dependency to Cargo.toml:
```toml
[dependencies]
keycloak = "26.0"
keycloak = "26.1"
```
```rust, no_run
Expand Down
Loading

0 comments on commit 0874476

Please sign in to comment.