/persona-python-client

Autogenerated Python client for our login service

Primary LanguagePython

persona

KSF Media unified login service

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

  • API version: 1.3.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/KSF-Media/persona-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/KSF-Media/persona-python-client.git)

Then import the package:

import persona 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import persona

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import persona
from persona.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = persona.AccountApi(persona.ApiClient(configuration))
body = 'body_example' # str | 

try:
    # Validate password reset token
    api_instance.account_password_check_token_post(body)
except ApiException as e:
    print("Exception when calling AccountApi->account_password_check_token_post: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi account_password_check_token_post POST /account/password/check-token Validate password reset token
AccountApi account_password_forgot_post POST /account/password/forgot Request password reset link
AccountApi account_password_reset_post POST /account/password/reset Reset a forgotten password with a token
AdminApi admin_free_pass_delete DELETE /admin/free-pass Revokes an existing free pass
AdminApi admin_free_pass_put PUT /admin/free-pass Creates a free pass to an article
AdminApi admin_free_passes_get GET /admin/free-passes Lists all free passes
AdminApi admin_search_post POST /admin/search Search for users
AdminApi admin_transfer_passive_subscribers_listid_post POST /admin/transfer-passive-subscribers/{listid} Transfers passive customers from Kayak to Mailchimp
AdminApi admin_user_post POST /admin/user Create a new user with admin options.
AdminApi admin_user_uuid_delete DELETE /admin/user/{uuid} Delete user
EntitlementsApi entitlements_allow_delete DELETE /entitlements/allow Remove an entitlement
EntitlementsApi entitlements_allow_get GET /entitlements/allow Check if global entitlements are enabled
EntitlementsApi entitlements_allow_post POST /entitlements/allow Add an entitlement for all users
EntitlementsApi entitlements_allow_uuid_post POST /entitlements/allow/{uuid} Grant product access to a customer
EntitlementsApi entitlements_free_pass_get GET /entitlements/free-pass Verify given free pass hash
EntitlementsApi entitlements_get GET /entitlements List all entitlements
EntitlementsApi entitlements_global_get GET /entitlements/global Lists all past and future global entitlements
IdentificationApi identification_login_get GET /identification/login Authenticate with OpenID Connect
IdentificationApi identification_login_monitor_get GET /identification/login/monitor Get token for off band response login flow monitor
IdentificationApi identification_login_return_get GET /identification/login/return Redirect endpoint for OpenID Connect
IdentificationApi identification_user_stamp_uuid_post POST /identification/user/stamp/{uuid} Query when the strong identification was last updated
LoginApi login_ip_get GET /login/ip Login with IP
LoginApi login_post POST /login Login with email and password
LoginApi login_sso_post POST /login/sso Disabled. Always returns 403.
LoginApi login_uuid_delete DELETE /login/{uuid} Logout
UsersApi users_post POST /users Create a new user.
UsersApi users_temporary_post POST /users/temporary Create a new user with email.
UsersApi users_uuid_entitlement_get GET /users/{uuid}/entitlement Get users entitlements.
UsersApi users_uuid_gdpr_put PUT /users/{uuid}/gdpr Updates the GDPR consent settings for a given user.
UsersApi users_uuid_get GET /users/{uuid} Get user by UUID.
UsersApi users_uuid_legal_put PUT /users/{uuid}/legal Updates the legal consent settings for a given user.
UsersApi users_uuid_newsletters_get GET /users/{uuid}/newsletters Get newsletter subscriptions
UsersApi users_uuid_newsletters_put PUT /users/{uuid}/newsletters Update newsletter subscriptions
UsersApi users_uuid_password_put PUT /users/{uuid}/password Set / Change user password
UsersApi users_uuid_patch PATCH /users/{uuid} Update a user
UsersApi users_uuid_payments_get GET /users/{uuid}/payments Get user's subscriptions and payment events
UsersApi users_uuid_scope_get GET /users/{uuid}/scope Check if user has valid token for a scope
UsersApi users_uuid_subscriptions_subsno_address_change_delete DELETE /users/{uuid}/subscriptions/{subsno}/addressChange Delete temporary address change for subscription
UsersApi users_uuid_subscriptions_subsno_address_change_patch PATCH /users/{uuid}/subscriptions/{subsno}/addressChange Edit temporary address change dates of a subscription
UsersApi users_uuid_subscriptions_subsno_address_change_post POST /users/{uuid}/subscriptions/{subsno}/addressChange Make a temporary address change for a subscription
UsersApi users_uuid_subscriptions_subsno_cancel_put PUT /users/{uuid}/subscriptions/{subsno}/cancel Cancels user subscription
UsersApi users_uuid_subscriptions_subsno_pause_patch PATCH /users/{uuid}/subscriptions/{subsno}/pause Edit pause duration
UsersApi users_uuid_subscriptions_subsno_pause_post POST /users/{uuid}/subscriptions/{subsno}/pause Pause users subscription
UsersApi users_uuid_subscriptions_subsno_reclamation_post POST /users/{uuid}/subscriptions/{subsno}/reclamation Create a new delivery reclamation for a subscription
UsersApi users_uuid_subscriptions_subsno_reclamations_reclaimno_get GET /users/{uuid}/subscriptions/{subsno}/reclamations/{reclaimno} Get a delivery reclamation
UsersApi users_uuid_subscriptions_subsno_unpause_post POST /users/{uuid}/subscriptions/{subsno}/unpause Unpause users subscription

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author