Download the PHP package dgrevink/php-keycloak-rest-api-client without Composer
On this page you can find all versions of the php package dgrevink/php-keycloak-rest-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download dgrevink/php-keycloak-rest-api-client
More information about dgrevink/php-keycloak-rest-api-client
Files in dgrevink/php-keycloak-rest-api-client
Download dgrevink/php-keycloak-rest-api-client
More information about dgrevink/php-keycloak-rest-api-client
Files in dgrevink/php-keycloak-rest-api-client
Vendor dgrevink
Package php-keycloak-rest-api-client
Short Description PHP client to interact with Keycloak's Admin REST API.
License mit
Package php-keycloak-rest-api-client
Short Description PHP client to interact with Keycloak's Admin REST API.
License mit
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package php-keycloak-rest-api-client
Keycloak Admin REST API Client
PHP client to interact with Keycloak's Admin REST API.
Inspired by keycloak/keycloak-nodejs-admin-client.
Installation
Install via Composer:
Usage
Example:
will print e.g.
You can authenticate against a specific realm by passing it via the realm parameter when constructing the Keycloak instance.
More examples can be found in the examples directory.
Customization
Custom representations & resources
You can register and use custom resources by providing your own representations and resources, e.g.:
By extending the Resource class, you have access to both the QueryExecutor and CommandExecutor.
The CommandExecutor is designed to run state-changing commands against the server (without returning a response);
the QueryExecutor allows fetching resources and representations from the server.
To use your custom resource, pass the fully-qualified class name (FQCN) to the Keycloak::resource() method.
It provides you with an instance of your resource you can then work with:
Available Resources
Attack Detection
| Endpoint | Response | API |
|---|---|---|
DELETE /admin/realms/{realm}/attack-detection/brute-force/users |
n/a |
AttackDetection::clear() |
GET /admin/realms/{realm}/attack-detection/brute-force/users/{userId} |
Map | AttackDetection::userStatus() |
DELETE /admin/realms/{realm}/attack-detection/brute-force/users/{userId} |
n/a |
AttackDetection::clearUser() |
Clients
| Endpoint | Response | API |
|---|---|---|
GET /admin/realms/{realm}/clients |
ClientCollection | Clients::all() |
GET /admin/realms/{realm}/clients/{client-uuid} |
Client | Clients::get() |
PUT /admin/realms/{realm}/clients/{client-uuid} |
Client | Clients::update() |
POST /admin/realms/{realm}/clients |
Client | Clients::import() |
GET /admin/realms/{realm}/clients/{clientUuid}/client-secret |
Client | Clients::getClientSecret() |
Groups
| Endpoint | Response | API |
|---|---|---|
GET /admin/realms/{realm}/groups |
GroupCollection | Groups::all() |
GET /admin/realms/{realm}/groups/{id}/children |
GroupCollection | Groups::children() |
GET /admin/realms/{realm}/groups/{id}/members |
UserCollection | Groups::members() |
GET /admin/realms/{realm}/groups/{id} |
Group | Groups::get() |
PUT /admin/realms/{realm}/groups/{id} |
n/a |
Groups::update() |
POST /admin/realms/{realm}/groups |
n/a |
Groups::create() |
POST /admin/realms/{realm}/groups/{id}/children |
n/a |
Groups::create() |
DELETE /admin/realms/{realm}/groups |
n/a |
Groups::delete() |
GET /admin/realms/{realm}/group-by-path/{path} |
Group | Groups::byPath() |
Organizations
| Endpoint | Response | API |
|---|---|---|
GET /admin/realms/{realm}/organizations |
OrganizationCollection | Organizations::all() |
GET /admin/realms/{realm}/organizations/{id} |
Organization | Organizations::get() |
POST /admin/realms/{realm}/organizations |
n/a |
Organizations::create() |
DELETE /admin/realms/{realm}/organizations/{id} |
n/a |
Organizations::delete() |
POST /admin/realms/{realm}/organizations/{id}/members/invite-user |
n/a |
Organizations::inviteUser() |
POST /admin/realms/{realm}/organizations/{id}/members |
n/a |
Organizations::addUser() |
PUT /admin/realms/{realm}/organizations/{id} |
n/a |
Organizations::update() |
Realms Admin
| Endpoint | Response | API |
|---|---|---|
POST /admin/realms |
Realm | Realms::import() |
GET /admin/realms |
RealmCollection | Realms::all() |
PUT /admin/realms/{realm} |
Realm | Realms::update() |
DELETE /admin/realms/{realm} |
n/a |
Realms::delete() |
GET /admin/realms/{realm}/admin-events |
array |
Realms::adminEvents() |
GET /admin/realms/{realm}/keys |
KeysMetadata | Realms::keys() |
DELETE /admin/realms/{realm}/admin-events |
n/a |
Realms::deleteAdminEvents() |
POST /admin/realms/{realm}/clear-keys-cache |
n/a |
Realms::clearKeysCache() |
POST /admin/realms/{realm}/clear-realm-cache |
n/a |
Realms::clearRealmCache() |
POST /admin/realms/{realm}/clear-user-cache |
n/a |
Realms::clearUserCache() |
Users
| Endpoint | Response | API |
|---|---|---|
GET /admin/realms/{realm}/users |
UserCollection | Users::all() |
POST /admin/realms/{realm}/users |
n/a |
Users::create() |
GET /admin/realms/{realm}/users/{userId} |
User | Users::get() |
PUT /admin/realms/{realm}/users/{userId} |
n/a |
Users::update() |
DELETE /admin/realms/{realm}/users/{userId} |
n/a |
Users::delete() |
GET /admin/realms/{realm}/users |
UserCollection | Users::search() |
PUT /admin/realms/{realm}/users/{userId}/groups/{groupId} |
n/a |
Users::joinGroup() |
DELETE /admin/realms/{realm}/users/{userId}/groups/{groupId} |
n/a |
Users::leaveGroup() |
GET /admin/realms/{realm}/users/{userId}/groups |
GroupCollection | Users::retrieveGroups() |
GET /admin/realms/{realm}/users/{userId}/role-mappings/realm |
RoleCollection | Users::retrieveRealmRoles() |
GET /admin/realms/{realm}/users/{userId}/role-mappings/realm/available |
RoleCollection | Users::retrieveAvailableRealmRoles() |
POST /admin/realms/{realm}/users/{userId}/role-mappings/realm |
n/a |
Users::addRealmRoles() |
DELETE /admin/realms/{realm}/users/{userId}/role-mappings/realm |
n/a |
Users::removeRealmRoles() |
GET /admin/realms/{realm}/users/{userId}/role-mappings/clients/{clientUuid} |
RoleCollection | Users::retrieveClientRoles() |
GET /admin/realms/{realm}/users/{userId}/role-mappings/clients/{clientUuid}/available |
RoleCollection | Users::retrieveAvailableClientRoles() |
POST /admin/realms/{realm}/users/{userId}/role-mappings/clients/{clientUuid} |
n/a |
Users::addClientRoles() |
DELETE /admin/realms/{realm}/users/{userId}/role-mappings/clients/{clientUuid} |
n/a |
Users::removeClientRoles() |
PUT /admin/realms/{realm}/users/{userId}/execute-actions-email |
n/a |
Users::executeActionsEmail() |
GET /admin/realms/{realm}/users/{userId}/credentials |
CredentialCollection | Users::credentials() |
Roles
| Endpoint | Response | API |
|---|---|---|
GET /admin/realms/{realm}/roles |
RoleCollection | Roles::all() |
GET /admin/realms/{realm}/roles/{roleName} |
Role | Roles::get() |
POST /admin/realms/{realm}/roles |
n/a |
Roles::create() |
DELETE /admin/realms/{realm}/roles/{roleName} |
n/a |
Roles::delete() |
Root
| Endpoint | Response | API |
|---|---|---|
GET /admin/serverinfo |
ServerInfo | ServerInfo::get() |
Local development and testing
Run docker compose up -d keycloak to start a local Keycloak instance listening on http://localhost:8080.
Run your script (e.g. examples/serverinfo.php) from within the php container:
Composer scripts
analyze: Run phpstan analysiscs: Check coding style (PHP CS Fixer)cs:fix: Fix coding style issues (PHP CS Fixer)test: Run unit and integration teststest:unit: Run unit teststest:integration: Run integration tests (requires a fresh and running Keycloak instance)
All versions of php-keycloak-rest-api-client with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.2
ext-json Version *
guzzlehttp/guzzle Version ^7.3
lcobucci/jwt Version ^4.1 || ^5.2
symfony/serializer Version ^6.4 || ^7.1 || ^8.0
symfony/property-access Version ^6.4 || ^7.1 || ^8.0
ext-json Version *
guzzlehttp/guzzle Version ^7.3
lcobucci/jwt Version ^4.1 || ^5.2
symfony/serializer Version ^6.4 || ^7.1 || ^8.0
symfony/property-access Version ^6.4 || ^7.1 || ^8.0
The package dgrevink/php-keycloak-rest-api-client contains the following files
Loading the files please wait ...