Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.19 KB

README.md

File metadata and controls

55 lines (36 loc) · 2.19 KB
Raw

Authentication

(authentication)

Overview

The authentication endpoints.

Available Operations

  • login - Authenticate with the API by providing a username and password.

login

Authenticate with the API by providing a username and password.

Example Usage

import speakeasybar
from speakeasybar.models import operations

s = speakeasybar.Speakeasybar()

req = operations.LoginRequestBody(
    type=operations.Type.API_KEY,
)

res = s.authentication.login(req, operations.LoginSecurity(
    password="<PASSWORD>",
    username="<USERNAME>",
))

if res.object is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.LoginRequestBody ✔️ The request object to use for the request.
security operations.LoginSecurity ✔️ The security requirements to use for the request.

Response

operations.LoginResponse

Errors

Error Object Status Code Content Type
errors.APIError 5XX application/json
errors.SDKError 4xx-5xx /