Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.28 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.28 KB

Authentication

(authentication)

Overview

The authentication endpoints.

Available Operations

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

authenticate

Authenticate with the API by providing a username and password.

Example Usage

from speakeasy_bar_py import BarPython

with BarPython() as s:
    res = s.authentication.authenticate(request={})

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

Parameters

Parameter Type Required Description
request operations.AuthenticateRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] Configuration to override the default retry behavior of the client.

Response

operations.AuthenticateResponse

Errors

Error Type Status Code Content Type
errors.APIError 5XX application/json
errors.SDKError 4XX */*