KSF-Media / persona-php-client

Autogenerated PHP client for our login service

persona

KSF Media unified login service

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

• API version: 1.3.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/persona/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



$apiInstance = new PersonaClient\Api\AccountApi(
    // 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 = 'body_example'; // string | 

try {
    $apiInstance->accountPasswordCheckTokenPost($body);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountPasswordCheckTokenPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://http:/v1

Class	Method	HTTP request	Description
AccountApi	accountPasswordCheckTokenPost	POST /account/password/check-token	Validate password reset token
AccountApi	accountPasswordForgotPost	POST /account/password/forgot	Request password reset link
AccountApi	accountPasswordResetPost	POST /account/password/reset	Reset a forgotten password with a token
AdminApi	adminFreePassDelete	DELETE /admin/free-pass	Revokes an existing free pass
AdminApi	adminFreePassPut	PUT /admin/free-pass	Creates a free pass to an article
AdminApi	adminFreePassesGet	GET /admin/free-passes	Lists all free passes
AdminApi	adminSearchPost	POST /admin/search	Search for users
AdminApi	adminTransferPassiveSubscribersListidPost	POST /admin/transfer-passive-subscribers/{listid}	Transfers passive customers from Kayak to Mailchimp
AdminApi	adminUserPost	POST /admin/user	Create a new user with admin options.
AdminApi	adminUserUuidDelete	DELETE /admin/user/{uuid}	Delete user
EntitlementsApi	entitlementsAllowDelete	DELETE /entitlements/allow	Remove an entitlement
EntitlementsApi	entitlementsAllowGet	GET /entitlements/allow	Check if global entitlements are enabled
EntitlementsApi	entitlementsAllowPost	POST /entitlements/allow	Add an entitlement for all users
EntitlementsApi	entitlementsAllowUuidPost	POST /entitlements/allow/{uuid}	Grant product access to a customer
EntitlementsApi	entitlementsFreePassGet	GET /entitlements/free-pass	Verify given free pass hash
EntitlementsApi	entitlementsGet	GET /entitlements	List all entitlements
EntitlementsApi	entitlementsGlobalGet	GET /entitlements/global	Lists all past and future global entitlements
IdentificationApi	identificationLoginGet	GET /identification/login	Authenticate with OpenID Connect
IdentificationApi	identificationLoginMonitorGet	GET /identification/login/monitor	Get token for off band response login flow monitor
IdentificationApi	identificationLoginReturnGet	GET /identification/login/return	Redirect endpoint for OpenID Connect
IdentificationApi	identificationUserStampUuidPost	POST /identification/user/stamp/{uuid}	Query when the strong identification was last updated
LoginApi	loginIpGet	GET /login/ip	Login with IP
LoginApi	loginPost	POST /login	Login with email and password
LoginApi	loginSsoPost	POST /login/sso	Disabled. Always returns 403.
LoginApi	loginUuidDelete	DELETE /login/{uuid}	Logout
UsersApi	usersPost	POST /users	Create a new user.
UsersApi	usersTemporaryPost	POST /users/temporary	Create a new user with email.
UsersApi	usersUuidEntitlementGet	GET /users/{uuid}/entitlement	Get users entitlements.
UsersApi	usersUuidGdprPut	PUT /users/{uuid}/gdpr	Updates the GDPR consent settings for a given user.
UsersApi	usersUuidGet	GET /users/{uuid}	Get user by UUID.
UsersApi	usersUuidLegalPut	PUT /users/{uuid}/legal	Updates the legal consent settings for a given user.
UsersApi	usersUuidNewslettersGet	GET /users/{uuid}/newsletters	Get newsletter subscriptions
UsersApi	usersUuidNewslettersPut	PUT /users/{uuid}/newsletters	Update newsletter subscriptions
UsersApi	usersUuidPasswordPut	PUT /users/{uuid}/password	Set / Change user password
UsersApi	usersUuidPatch	PATCH /users/{uuid}	Update a user
UsersApi	usersUuidPaymentsGet	GET /users/{uuid}/payments	Get user's subscriptions and payment events
UsersApi	usersUuidScopeGet	GET /users/{uuid}/scope	Check if user has valid token for a scope
UsersApi	usersUuidSubscriptionsSubsnoAddressChangeDelete	DELETE /users/{uuid}/subscriptions/{subsno}/addressChange	Delete temporary address change for subscription
UsersApi	usersUuidSubscriptionsSubsnoAddressChangePatch	PATCH /users/{uuid}/subscriptions/{subsno}/addressChange	Edit temporary address change dates of a subscription
UsersApi	usersUuidSubscriptionsSubsnoAddressChangePost	POST /users/{uuid}/subscriptions/{subsno}/addressChange	Make a temporary address change for a subscription
UsersApi	usersUuidSubscriptionsSubsnoCancelPut	PUT /users/{uuid}/subscriptions/{subsno}/cancel	Cancels user subscription
UsersApi	usersUuidSubscriptionsSubsnoPausePatch	PATCH /users/{uuid}/subscriptions/{subsno}/pause	Edit pause duration
UsersApi	usersUuidSubscriptionsSubsnoPausePost	POST /users/{uuid}/subscriptions/{subsno}/pause	Pause users subscription
UsersApi	usersUuidSubscriptionsSubsnoReclamationPost	POST /users/{uuid}/subscriptions/{subsno}/reclamation	Create a new delivery reclamation for a subscription
UsersApi	usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet	GET /users/{uuid}/subscriptions/{subsno}/reclamations/{reclaimno}	Get a delivery reclamation
UsersApi	usersUuidSubscriptionsSubsnoUnpausePost	POST /users/{uuid}/subscriptions/{subsno}/unpause	Unpause users subscription

Documentation For Models

• ActiveDays
• Address
• AdminNewUser
• CancelSubscriptionReason
• DeleteTempAddressChangeDates
• DeliveryAddress
• DeliveryReclamation
• EntitlementAccess
• FaroUser
• ForgotPasswordData
• FreePass
• FreePassInput
• GdprConsent
• InlineResponse400
• InlineResponse400InvalidRequestBody
• InlineResponse403
• InlineResponse4031
• InlineResponse4031AccessTokenExpired
• InlineResponse403InvalidCredentials
• InlineResponse415
• InlineResponse415UnsupportedMediaType
• InlineResponse500
• InlineResponse500InternalServerError
• JanrainUser
• LegalConsent
• LoginData
• LoginDataSSO
• LoginResponse
• NewDeliveryReclamation
• NewTemporaryUser
• NewUser
• Newsletter
• NewsletterSubscription
• Package
• PackageCampaign
• PackageOffer
• Paper
• PastTemporaryAddress
• PausedSubscription
• Payment
• PendingAddressChange
• PersistedEntitlementAccess
• Product
• SearchQuery
• SearchResult
• Subscription
• SubscriptionDates
• SubscriptionPauseDates
• SubscriptionPauseEdit
• SubscriptionPayments
• TemporaryAddressChange
• TemporaryAddressChangeDates
• UpdatePasswordData
• User
• UserUpdate
• UserUpdateAddress
• UserUpdatePassword

Documentation For Authorization

All endpoints do not require authorization.

Author