ory/keto-client
Ory Keto is a cloud native access control server providing best-practice patterns (RBAC, ABAC, ACL, AWS IAM Policies, Kubernetes Roles, ...) via REST APIs.
This PHP package is automatically generated by the OpenAPI Generator project:
- API version: Latest
- Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://www.ory.sh
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install with Composer, run:
$ composer require ory/keto-client:*Manual Installation
Download the files and include autoload.php:
require_once('/path/to/ory/keto-client/vendor/autoload.php');Tests
To run the unit tests:
composer install
./vendor/bin/phpunitGetting Started
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Ory\Keto\Client\Api\EnginesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$flavor = 'flavor_example'; // string | The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\".
$id = 'id_example'; // string | The ID of the ORY Access Control Policy Role.
$body = new \Ory\Keto\Client\Model\AddOryAccessControlPolicyRoleMembersBody(); // \Ory\Keto\Client\Model\AddOryAccessControlPolicyRoleMembersBody |
try {
$result = $apiInstance->addOryAccessControlPolicyRoleMembers($flavor, $id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EnginesApi->addOryAccessControlPolicyRoleMembers: ', $e->getMessage(), PHP_EOL;
}
?>Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| EnginesApi | addOryAccessControlPolicyRoleMembers | PUT /engines/acp/ory/{flavor}/roles/{id}/members | Add a member to an ORY Access Control Policy Role |
| EnginesApi | deleteOryAccessControlPolicy | DELETE /engines/acp/ory/{flavor}/policies/{id} | |
| EnginesApi | deleteOryAccessControlPolicyRole | DELETE /engines/acp/ory/{flavor}/roles/{id} | Delete an ORY Access Control Policy Role |
| EnginesApi | doOryAccessControlPoliciesAllow | POST /engines/acp/ory/{flavor}/allowed | Check if a request is allowed |
| EnginesApi | getOryAccessControlPolicy | GET /engines/acp/ory/{flavor}/policies/{id} | |
| EnginesApi | getOryAccessControlPolicyRole | GET /engines/acp/ory/{flavor}/roles/{id} | Get an ORY Access Control Policy Role |
| EnginesApi | listOryAccessControlPolicies | GET /engines/acp/ory/{flavor}/policies | |
| EnginesApi | listOryAccessControlPolicyRoles | GET /engines/acp/ory/{flavor}/roles | List ORY Access Control Policy Roles |
| EnginesApi | removeOryAccessControlPolicyRoleMembers | DELETE /engines/acp/ory/{flavor}/roles/{id}/members/{member} | Remove a member from an ORY Access Control Policy Role |
| EnginesApi | upsertOryAccessControlPolicy | PUT /engines/acp/ory/{flavor}/policies | |
| EnginesApi | upsertOryAccessControlPolicyRole | PUT /engines/acp/ory/{flavor}/roles | Upsert an ORY Access Control Policy Role |
| HealthApi | isInstanceAlive | GET /health/alive | Check alive status |
| HealthApi | isInstanceReady | GET /health/ready | Check readiness status |
| VersionApi | getVersion | GET /version | Get service version |
Documentation For Models
- AddOryAccessControlPolicyRoleMembersBody
- AuthorizationResult
- HealthNotReadyStatus
- HealthStatus
- InlineResponse500
- OryAccessControlPolicy
- OryAccessControlPolicyAllowedInput
- OryAccessControlPolicyRole
- Version
Documentation For Authorization
All endpoints do not require authorization.