board-mate/api-customer/api-resources/auth-components/docs/AuthApi.md

board_mate.auth.AuthApi

All URIs are relative to https://boardmate_api

Method	HTTP request	Description
login	POST /authenticate	POST authenticate

login

ResponseBodyAuthResponseDto login(auth_request_dto)

POST authenticate

Example

import time
import os
import board_mate.auth
from board_mate.auth.models.auth_request_dto import AuthRequestDto
from board_mate.auth.models.response_body_auth_response_dto import ResponseBodyAuthResponseDto
from board_mate.auth.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://boardmate_api
# See configuration.py for a list of all supported configuration parameters.
configuration = board_mate.auth.Configuration(
    host = "https://boardmate_api"
)


# Enter a context with an instance of the API client
with board_mate.auth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = board_mate.auth.AuthApi(api_client)
    auth_request_dto = board_mate.auth.AuthRequestDto() # AuthRequestDto | 

    try:
        # POST authenticate
        api_response = api_instance.login(auth_request_dto)
        print("The response of AuthApi->login:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->login: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_request_dto	AuthRequestDto

Return type

ResponseBodyAuthResponseDto

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

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