AdministrationApi.md

idcheckio_python_client.AdministrationApi

All URIs are relative to https://localhost/rest

Method	HTTP request	Description
get_health	GET /v0/admin/health	HTTP GET health
get_user	GET /v0/admin/user	HTTP GET user

get_health

HealthResponse get_health()

HTTP GET health

GET server health (OK 200)

Example

import time
import idcheckio_python_client
from idcheckio_python_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = idcheckio_python_client.AdministrationApi()

try: 
    # HTTP GET health
    api_response = api_instance.get_health()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling AdministrationApi->get_health: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user

UserResponse get_user(accept_language=accept_language)

HTTP GET user

Get user informations

Example

import time
import idcheckio_python_client
from idcheckio_python_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
idcheckio_python_client.configuration.username = 'YOUR_USERNAME'
idcheckio_python_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = idcheckio_python_client.AdministrationApi()
accept_language = 'accept_language_example' # str | Accept language header (optional)

try: 
    # HTTP GET user
    api_response = api_instance.get_user(accept_language=accept_language)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling AdministrationApi->get_user: %s\n" % e

Parameters

Name	Type	Description	Notes
accept_language	str	Accept language header	[optional]

Return type

UserResponse

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]