ory/kratos-client
Welcome to the ORY Kratos HTTP API documentation!
This PHP package is automatically generated by the OpenAPI Generator project:
- API version: v0.4.6-alpha.1
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install with Composer, run:
$ composer require ory/kratos-client:*Manual Installation
Download the files and include autoload.php:
require_once('/path/to/ory/kratos-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\Kratos\Client\Api\AdminApi(
// 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()
);
$body = new \Ory\Kratos\Client\Model\Identity(); // \Ory\Kratos\Client\Model\Identity |
try {
$result = $apiInstance->createIdentity($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AdminApi->createIdentity: ', $e->getMessage(), PHP_EOL;
}
?>Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminApi | createIdentity | POST /identities | Create an identity |
| AdminApi | deleteIdentity | DELETE /identities/{id} | Delete an identity |
| AdminApi | getIdentity | GET /identities/{id} | Get an identity |
| AdminApi | getSchema | GET /schemas/{id} | |
| AdminApi | getSelfServiceBrowserLoginRequest | GET /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows |
| AdminApi | getSelfServiceBrowserRecoveryRequest | GET /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows |
| AdminApi | getSelfServiceBrowserRegistrationRequest | GET /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows |
| AdminApi | getSelfServiceBrowserSettingsRequest | GET /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows |
| AdminApi | getSelfServiceError | GET /self-service/errors | Get user-facing self-service errors |
| AdminApi | getSelfServiceVerificationRequest | GET /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows |
| AdminApi | listIdentities | GET /identities | List all identities in the system |
| AdminApi | updateIdentity | PUT /identities/{id} | Update an identity |
| CommonApi | getSchema | GET /schemas/{id} | |
| CommonApi | getSelfServiceBrowserLoginRequest | GET /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows |
| CommonApi | getSelfServiceBrowserRecoveryRequest | GET /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows |
| CommonApi | getSelfServiceBrowserRegistrationRequest | GET /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows |
| CommonApi | getSelfServiceBrowserSettingsRequest | GET /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows |
| CommonApi | getSelfServiceError | GET /self-service/errors | Get user-facing self-service errors |
| CommonApi | getSelfServiceVerificationRequest | GET /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows |
| HealthApi | isInstanceAlive | GET /health/alive | Check alive status |
| HealthApi | isInstanceReady | GET /health/ready | Check readiness status |
| PublicApi | completeSelfServiceBrowserRecoveryLinkStrategyFlow | POST /self-service/browser/flows/recovery/link | Complete the browser-based recovery flow using a recovery link |
| PublicApi | completeSelfServiceBrowserSettingsOIDCSettingsFlow | POST /self-service/browser/flows/registration/strategies/oidc/settings/connections | Complete the browser-based settings flow for the OpenID Connect strategy |
| PublicApi | completeSelfServiceBrowserSettingsPasswordStrategyFlow | POST /self-service/browser/flows/settings/strategies/password | Complete the browser-based settings flow for the password strategy |
| PublicApi | completeSelfServiceBrowserSettingsProfileStrategyFlow | POST /self-service/browser/flows/settings/strategies/profile | Complete the browser-based settings flow for profile data |
| PublicApi | completeSelfServiceBrowserVerificationFlow | POST /self-service/browser/flows/verification/{via}/complete | Complete the browser-based verification flows |
| PublicApi | getSchema | GET /schemas/{id} | |
| PublicApi | getSelfServiceBrowserLoginRequest | GET /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows |
| PublicApi | getSelfServiceBrowserRecoveryRequest | GET /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows |
| PublicApi | getSelfServiceBrowserRegistrationRequest | GET /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows |
| PublicApi | getSelfServiceBrowserSettingsRequest | GET /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows |
| PublicApi | getSelfServiceError | GET /self-service/errors | Get user-facing self-service errors |
| PublicApi | getSelfServiceVerificationRequest | GET /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows |
| PublicApi | initializeSelfServiceBrowserLoginFlow | GET /self-service/browser/flows/login | Initialize browser-based login user flow |
| PublicApi | initializeSelfServiceBrowserLogoutFlow | GET /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow |
| PublicApi | initializeSelfServiceBrowserRegistrationFlow | GET /self-service/browser/flows/registration | Initialize browser-based registration user flow |
| PublicApi | initializeSelfServiceBrowserVerificationFlow | GET /self-service/browser/flows/verification/init/{via} | Initialize browser-based verification flow |
| PublicApi | initializeSelfServiceRecoveryFlow | GET /self-service/browser/flows/recovery | Initialize browser-based account recovery flow |
| PublicApi | initializeSelfServiceSettingsFlow | GET /self-service/browser/flows/settings | Initialize browser-based settings flow |
| PublicApi | selfServiceBrowserVerify | GET /self-service/browser/flows/verification/{via}/confirm/{code} | Complete the browser-based verification flows |
| PublicApi | whoami | GET /sessions/whoami | Check who the current HTTP session belongs to |
| VersionApi | getVersion | GET /version | Get service version |
Documentation For Models
- CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload
- ErrorContainer
- Form
- FormField
- GenericError
- GenericErrorPayload
- HealthNotReadyStatus
- HealthStatus
- Identity
- LoginRequest
- LoginRequestMethod
- LoginRequestMethodConfig
- Message
- ProviderCredentialsConfig
- RecoveryAddress
- RecoveryRequest
- RecoveryRequestMethod
- RegistrationRequest
- RegistrationRequestMethod
- RegistrationRequestMethodConfig
- RequestMethodConfig
- Session
- SettingsRequest
- SettingsRequestMethod
- VerifiableAddress
- VerificationRequest
- Version
Documentation For Authorization
All endpoints do not require authorization.