Skip to content

Commit

Permalink
Merge pull request #123 from MohammadWaleed/develop
Browse files Browse the repository at this point in the history 
prepare for 0.38.0
  • Loading branch information
@MohammadWaleed
MohammadWaleed authored Apr 2, 2024
2 parents 0c75a00 + fcd7873 commit 54cf84c
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 34 deletions.
63 changes: 33 additions & 30 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ $client = Keycloak\Admin\KeycloakClient::factory([
]);
```

Since version 0.30, if your Keycloak base URL starts with `auth/`, add it to `baseUri` (e.g. http://127.0.0.1:8180/auth). Base URL for Keycloak versions 7 to 16 have systematically `auth/`. On Keycloak 17+ it depends on your settings.
Since version 0.30, if your Keycloak base URL starts with `auth/`, add it to `baseUri` (e.g. http://127.0.0.1:8180/auth/). Base URL for Keycloak versions 7 to 16 have systematically `auth/`. On Keycloak 17+ it depends on your settings.


#### 2. Use it
Expand Down Expand Up @@ -375,6 +375,7 @@ $client = KeycloakClient::factory([
| Get group hierarchy. | getGroups | ✔️ |
| Returns the groups counts. | getGroupsCount | ✔️ |
| Get Group | getGroup | ✔️ |
| Get Group Children (subgroups) | getGroupChildren | ✔️ |
| Update group, ignores subgroups. | updateGroup | ✔️ |
| Delete Group | removeGroup | ✔️ |
| Set or create child. | createChildGroup | ✔️ |
Expand Down Expand Up @@ -434,6 +435,7 @@ Note: Ids are sent as clientScopeId or clientId and mapperId everything else is

| API | Function Name | Supported |
|---------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------:|:---------:|
| Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view. | getRealms | ✔️ |
| Import a realm Imports a realm from a full representation of that realm. | importRealm | ✔️ |
| Get the top-level representation of the realm It will not include nested information like User and Client representations. | getRealm | ✔️ |
| Update the top-level information of the realm Any user, roles or client information in the representation will be ignored. | updateRealm | ✔️ |
Expand Down Expand Up @@ -462,10 +464,10 @@ Note: Ids are sent as clientScopeId or clientId and mapperId everything else is
| Get user group by path | getGroupByPath | ✔️ |
| GET /{realm}/localization | getLocalizationLocales | ✔️ |
| POST /{realm}/localization/{locale} | updateLocalizationTexts | ✔️ |
| GET /{realm}/localization/{locale} | getLocalizationTexts | ✔️ |
| GET /{realm}/localization/{locale} | getLocalizationTexts | ✔️ |
| DELETE /{realm}/localization/{locale} | deleteLocalizationTexts | ✔️ |
| GET /{realm}/localization/{locale}/{key} | getLocalizationText | ✔️ |
| PUT /{realm}/localization/{locale}/{key} | saveLocalizationText | ✔️ |
| PUT /{realm}/localization/{locale}/{key} | saveLocalizationText | ✔️ |
| Removes all user sessions. (Keycloak throws an exception when this one is called) | logoutAllUsers | ❌ |
| Partial export of existing realm into a JSON file. | partialExportRealm | ✔️ |
| Partial import from a JSON file to an existing realm. | partialImportRealm | ✔️ |
Expand Down Expand Up @@ -581,33 +583,34 @@ Note: Ids are sent as clientScopeId or clientId and mapperId everything else is

## [Users]()

| API | Function Name | Supported |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------:|:---------:|
| Create a new user Username must be unique. | createUser | ✔️ |
| Get users Returns a list of users, filtered according to query parameters | getUsers | ✔️ |
| GET /{realm}/users/count | getUserCount | ✔️ |
| Get representation of the user | getUser | ️️️✔️ |
| Update the user | updateUser | ️️️✔️ |
| Delete the user | deleteUser | ️️️✔️ |
| Get consents granted by the user | | ️✔️ |
| Revoke consent and offline tokens for particular client from user | | ❌ |
| Disable all credentials for a user of a specific type | | ❌ |
| Send a update account email to the user An email contains a link the user can click to perform a set of required actions. | executeActionsEmail | ✔️ |
| Get social logins associated with the user | | ✔️ |
| Add a social login provider to the user | | ✔️ |
| Remove a social login provider from user | | ✔️ |
| GET /{realm}/users/{id}/groups | getUserGroups | ✔️ |
| GET /{realm}/users/{id}/groups/count | getUserGroupsCount | ✔️ |
| PUT /{realm}/users/{id}/groups/{groupId} | addUserToGroup | ✔️ |
| DELETE /{realm}/users/{id}/groups/{groupId} | deleteUserFromGroup | ✔️ |
| Impersonate the user | impersonateUser | ✔️ |
| Remove all user sessions associated with the user Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user. | logoutUser | ✔️ |
| Get offline sessions associated with the user and client | | ❌ |
| Remove TOTP from the user | | ❌ |
| Set up a new password for the user. | resetUserPassword | ✔️ |
| Send an email-verification email to the user An email contains a link the user can click to verify their email address. | sendVerifyEmail | ✔️ |
| Get sessions associated with the user | getUserSessions | ✔️ |
| Get credentials associated with the user | getUserCredentials | ✔️ |
| API | Function Name | Supported |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------:|:---------:|
| Create a new user Username must be unique. | createUser | ✔️ |
| Get users Returns a list of users, filtered according to query parameters | getUsers | ✔️ |
| GET /{realm}/users/count | getUserCount | ✔️ |
| Get representation of the user | getUser | ️️️✔️ |
| Update the user | updateUser | ️️️✔️ |
| Delete the user | deleteUser | ️️️✔️ |
| Get consents granted by the user | | ️✔️ |
| Revoke consent and offline tokens for particular client from user | | ❌ |
| Disable all credentials for a user of a specific type | | ❌ |
| Send a update account email to the user An email contains a link the user can click to perform a set of required actions. | executeActionsEmail | ✔️ |
| Get social logins associated with the user | | ✔️ |
| Add a social login provider to the user | | ✔️ |
| Remove a social login provider from user | | ✔️ |
| GET /{realm}/users/{id}/groups | getUserGroups | ✔️ |
| GET /{realm}/users/{id}/groups/count | getUserGroupsCount | ✔️ |
| PUT /{realm}/users/{id}/groups/{groupId} | addUserToGroup | ✔️ |
| DELETE /{realm}/users/{id}/groups/{groupId} | deleteUserFromGroup | ✔️ |
| Impersonate the user | impersonateUser | ✔️ |
| Remove all user sessions associated with the user Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user. | logoutUser | ✔️ |
| Get offline sessions associated with the user and client | | ❌ |
| Remove TOTP from the user | | ❌ |
| Set up a new password for the user. | resetUserPassword | ✔️ |
| Send an email-verification email to the user An email contains a link the user can click to verify their email address. | sendVerifyEmail | ✔️ |
| Get sessions associated with the user | getUserSessions | ✔️ |
| Get credentials associated with the user | getUserCredentials | ✔️ |
| Delete credential associated with the user | deleteUserCredential | ✔️ |

## [Root]()

Expand Down
2 changes: 1 addition & 1 deletion src/Admin/Classes/FullTextLocation.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function visit(
$value = $param->filter($value);

if ($oldValue !== '') {
$value = $oldValue.$vaule;
$value = $oldValue.$value;
}

if ($this->contentType && !$request->hasHeader('Content-Type')) {
Expand Down
3 changes: 3 additions & 0 deletions src/Admin/KeycloakClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
* @method array getGroups(array $args = array()) { @command Keycloak getGroups }
* @method array getGroupsCount(array $args = array()) { @command Keycloak getGroupsCount }
* @method array getGroup(array $args = array()) { @command Keycloak getGroup }
* @method array getGroupChildren(array $args = array()) { @command Keycloak getGroupChildren }
* @method array updateGroup(array $args = array()) { @command Keycloak updateGroup }
* @method array removeGroup(array $args = array()) { @command Keycloak removeGroup }
* @method array createChildGroup(array $args = array()) { @command Keycloak createChildGroup }
Expand Down Expand Up @@ -168,6 +169,7 @@
* @method array deleteClientProtocolMapper(array $args = array()) { @command Keycloak deleteClientProtocolMapper }
* @method array getClientProtocolMappersByProtocolName(array $args = array()) { @command Keycloak getClientProtocolMappersByProtocolName }
*
* @method array getRealms(array $args = array()) { @command Keycloak getRealms }
* @method array importRealm(array $args = array()) { @command Keycloak importRealm }
* @method array getRealm(array $args = array()) { @command Keycloak getRealm }
* @method array updateRealm(array $args = array()) { @command Keycloak updateRealm }
Expand Down Expand Up @@ -279,6 +281,7 @@
* @method array resetUserPassword(array $args = array()) { @command Keycloak resetUserPassword }
* @method array getUserSessions(array $args = array()) { @command Keycloak getUserSessions }
* @method array getUserCredentials(array $args = array()) { @command Keycloak getUserCredentials }
* @method array deleteUserCredential(array $args = array()) { @command Keycloak deleteUserCredential }
* @method array impersonateUser(array $args = array()) { @command Keycloak impersonateUser }
* @method array logoutUser(array $args = array()) { @command Keycloak logoutUser }
*
Expand Down
Loading

0 comments on commit 54cf84c

Please sign in to comment.