lalanikarim / client-php

ory/client

Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/ory/client-client-php.git"
    }
  ],
  "require": {
    "ory/client-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/ory/client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: oryToken
$config = Ory\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Ory\Client\Api\DefaultApi(
    // 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(),
    $config
);
$createIdentity = new \Ory\Client\Model\CreateIdentity(); // \Ory\Client\Model\CreateIdentity

try {
    $result = $apiInstance->createIdentityAdmin($createIdentity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createIdentityAdmin: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://playground.projects.oryapis.com

Class	Method	HTTP request	Description
DefaultApi	createIdentityAdmin	POST /api/kratos/admin/identities	Create an Identity
DefaultApi	createRecoveryLinkAdmin	POST /api/kratos/admin/recovery/link	Create a Recovery Link
DefaultApi	deleteIdentityAdmin	DELETE /api/kratos/admin/identities/{id}	Delete an Identity
DefaultApi	getIdentityAdmin	GET /api/kratos/admin/identities/{id}	Get an Identity
DefaultApi	getSchema	GET /api/kratos/public/schemas/{id}
DefaultApi	getSchemaAdmin	GET /api/kratos/admin/schemas/{id}
DefaultApi	getSelfServiceError	GET /api/kratos/public/self-service/errors	Get User-Facing Self-Service Errors
DefaultApi	getSelfServiceErrorAdmin	GET /api/kratos/admin/self-service/errors	Get User-Facing Self-Service Errors
DefaultApi	getSelfServiceLoginFlow	GET /api/kratos/public/self-service/login/flows	Get Login Flow
DefaultApi	getSelfServiceLoginFlowAdmin	GET /api/kratos/admin/self-service/login/flows	Get Login Flow
DefaultApi	getSelfServiceRecoveryFlow	GET /api/kratos/public/self-service/recovery/flows	Get information about a recovery flow
DefaultApi	getSelfServiceRecoveryFlowAdmin	GET /api/kratos/admin/self-service/recovery/flows	Get information about a recovery flow
DefaultApi	getSelfServiceRegistrationFlow	GET /api/kratos/public/self-service/registration/flows	Get Registration Flow
DefaultApi	getSelfServiceRegistrationFlowAdmin	GET /api/kratos/admin/self-service/registration/flows	Get Registration Flow
DefaultApi	getSelfServiceSettingsFlow	GET /api/kratos/public/self-service/settings/flows	Get Settings Flow
DefaultApi	getSelfServiceSettingsFlowAdmin	GET /api/kratos/admin/self-service/settings/flows	Get Settings Flow
DefaultApi	getSelfServiceVerificationFlow	GET /api/kratos/public/self-service/verification/flows	Get Verification Flow
DefaultApi	getSelfServiceVerificationFlowAdmin	GET /api/kratos/admin/self-service/verification/flows	Get Verification Flow
DefaultApi	getVersionAdmin	GET /api/kratos/admin/version	Return Running Software Version.
DefaultApi	initializeSelfServiceBrowserLogoutFlow	GET /api/kratos/public/self-service/browser/flows/logout	Initialize Browser-Based Logout User Flow
DefaultApi	initializeSelfServiceLoginForBrowsers	GET /api/kratos/public/self-service/login/browser	Initialize Login Flow for Browsers
DefaultApi	initializeSelfServiceLoginWithoutBrowser	GET /api/kratos/public/self-service/login/api	Initialize Login Flow for APIs, Services, Apps, ...
DefaultApi	initializeSelfServiceRecoveryForBrowsers	GET /api/kratos/public/self-service/recovery/browser	Initialize Recovery Flow for Browser Clients
DefaultApi	initializeSelfServiceRecoveryForNativeApps	GET /api/kratos/public/self-service/recovery/api	Initialize Recovery Flow for Native Apps and API clients
DefaultApi	initializeSelfServiceRegistrationForBrowsers	GET /api/kratos/public/self-service/registration/browser	Initialize Registration Flow for Browsers
DefaultApi	initializeSelfServiceRegistrationWithoutBrowser	GET /api/kratos/public/self-service/registration/api	Initialize Registration Flow for APIs, Services, Apps, ...
DefaultApi	initializeSelfServiceSettingsForBrowsers	GET /api/kratos/public/self-service/settings/browser	Initialize Settings Flow for Browsers
DefaultApi	initializeSelfServiceSettingsForNativeApps	GET /api/kratos/public/self-service/settings/api	Initialize Settings Flow for Native Apps and API clients
DefaultApi	initializeSelfServiceVerificationForBrowsers	GET /api/kratos/public/self-service/verification/browser	Initialize Verification Flow for Browser Clients
DefaultApi	initializeSelfServiceVerificationForNativeApps	GET /api/kratos/public/self-service/verification/api	Initialize Verification Flow for Native Apps and API clients
DefaultApi	isAliveAdmin	GET /api/kratos/admin/health/alive	Check HTTP Server Status
DefaultApi	isReadyAdmin	GET /api/kratos/admin/health/ready	Check HTTP Server and Database Status
DefaultApi	listIdentitiesAdmin	GET /api/kratos/admin/identities	List Identities
DefaultApi	prometheusAdmin	GET /api/kratos/admin/metrics/prometheus	Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
DefaultApi	revokeSession	DELETE /api/kratos/public/sessions	Initialize Logout Flow for API Clients - Revoke a Session
DefaultApi	submitSelfServiceLoginFlow	POST /api/kratos/public/self-service/login	Submit a Login Flow
DefaultApi	submitSelfServiceRecoveryFlow	POST /api/kratos/public/self-service/recovery	Complete Recovery Flow
DefaultApi	submitSelfServiceRecoveryFlowWithLinkMethod	POST /api/kratos/public/self-service/recovery/methods/link	Complete Recovery Flow with Link Method
DefaultApi	submitSelfServiceRegistrationFlow	POST /api/kratos/public/self-service/registration	Submit a Registration Flow
DefaultApi	submitSelfServiceSettingsFlow	POST /api/kratos/public/self-service/settings	Complete Settings Flow
DefaultApi	submitSelfServiceVerificationFlow	POST /api/kratos/public/self-service/verification/flows	Complete Verification Flow
DefaultApi	toSession	GET /api/kratos/public/sessions/whoami	Check Who the Current HTTP Session Belongs To
DefaultApi	updateIdentityAdmin	PUT /api/kratos/admin/identities/{id}	Update an Identity

Models

• AuthenticateOKBody
• ContainerChangeResponseItem
• ContainerCreateCreatedBody
• ContainerTopOKBody
• ContainerUpdateOKBody
• ContainerWaitOKBody
• ContainerWaitOKBodyError
• CreateIdentity
• CreateRecoveryLink
• ErrorResponse
• GenericError
• GraphDriverData
• HealthNotReadyStatus
• HealthStatus
• IdResponse
• Identity
• IdentityCredentials
• ImageDeleteResponseItem
• ImageSummary
• InlineResponse200
• InlineResponse2001
• InlineResponse503
• JsonError
• LoginFlow
• LoginViaApiResponse
• Meta
• Plugin
• PluginConfig
• PluginConfigArgs
• PluginConfigInterface
• PluginConfigLinux
• PluginConfigNetwork
• PluginConfigRootfs
• PluginConfigUser
• PluginDevice
• PluginEnv
• PluginInterfaceType
• PluginMount
• PluginSettings
• Port
• RecoveryAddress
• RecoveryFlow
• RecoveryLink
• RegistrationFlow
• RegistrationViaApiResponse
• RevokeSession
• SelfServiceErrorContainer
• ServiceUpdateResponse
• Session
• SettingsFlow
• SettingsProfileFormConfig
• SettingsViaApiResponse
• SubmitSelfServiceBrowserSettingsOIDCFlowPayload
• SubmitSelfServiceLoginFlow
• SubmitSelfServiceLoginFlowWithPasswordMethod
• SubmitSelfServiceRecoveryFlowWithLinkMethod
• SubmitSelfServiceRegistrationFlow
• SubmitSelfServiceRegistrationFlowWithPasswordMethod
• SubmitSelfServiceSettingsFlow
• SubmitSelfServiceSettingsFlowWithPasswordMethod
• SubmitSelfServiceSettingsFlowWithProfileMethod
• SubmitSelfServiceVerificationFlowWithLinkMethod
• UiContainer
• UiNode
• UiNodeAnchorAttributes
• UiNodeAttributes
• UiNodeImageAttributes
• UiNodeInputAttributes
• UiNodeTextAttributes
• UiText
• UpdateIdentity
• VerifiableIdentityAddress
• VerificationFlow
• Version
• Volume
• VolumeUsageData

Authorization

oryToken

• Type: Bearer authentication

sessionCookie

• Type: API key
• API key parameter name: ory_kratos_session
• Location:

sessionToken

• Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[e-mail]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v0.0.1-alpha.9
• Build package: org.openapitools.codegen.languages.PhpClientCodegen