cloudspot-license-api 1.0.0

Wrapper for the Cloudspot License API endpoints

Cloudspot API wrapper

Basic wrapper for the Cloudspot License API.

Use cases

1. Authenticate and authorize users on an external app, linked to Cloudspot License

Getting started

Install

Install with pip.

pip install cloudspot-license-api

Import

from cloudspotlicense.api import CloudspotLicense_API

Functionalities

Setup

When setting up the class, one parameter is expected: the id of the external application as present on the license server. This is a crucial and important step. This id is used to determine what application is making the request and what permissions are linked to it. By using a wrong id, your users will be able to authenticate themselves if their credentials are correct but the permissions will not be mapped correctly. This may lead to giving users too much or too little permissions on the external application.

from cloudspot.api import CloudspotLicense_API
api = CloudspotLicense_API('app-id')

Authentication and authorization

After setting up the connection, you can use the api to send requests to the Cloudspot License. Users that are trying to log in will give their username and password. Send this username and password to the License server to validate their credentials. If correct, the License server will return a token and the user's permissions for the external application. If not correct, a BadCredentials error will be raised.

try:
    api.authenticate(username, password)
except BadCredentials as e:
    print(e)

If a request is succesful, you can retrieve the returned token and permissions by using api.token and api.permissions respectively.

token = api.token
for perm in api.permissions.items():
    print(perm.permission) # Contains the slug of the permission

Retrieving user info

By default, an empty User object will be attached to the api. You can retrieve the object with api.user. To populate the User, you need to execute the function api.get_user() first.

The User object has four attributes: first_name, last_name, email and company.

If you've already authenticated the user before using the api, you do not need to supply a token to the function. If you're using a new api object and want to retrieve the user for a specific token without authenticating first, you can supply the token to the function.

If succesful, the user will be attached to api.user and overwrite any previous user.

Retrieve user by authenticating first.

api.authenticate(username, password)
api.get_user()
    
print(user.first_name)

Retrieve user by supplying a token. You can catch the error NoValidToken to handle a token that is not valid.

try:
    api.get_user(token)
except NoValidToken as e:
    print(e)
    
print(user.first_name)