Skip to content

AuthenticationApi.md

Latest commit

 

History

History
930 lines (697 loc) · 28.7 KB

AuthenticationApi.md

File metadata and controls

930 lines (697 loc) · 28.7 KB

phrasetms_client.AuthenticationApi

All URIs are relative to https://cloud.memsource.com/web

Method HTTP request Description
login POST /api2/v1/auth/login Login
login1 POST /api2/v3/auth/login Login
login_by_apple_with_code POST /api2/v1/auth/loginWithApple/code Login with Apple with code
login_by_apple_with_refresh_token POST /api2/v1/auth/loginWithApple/refreshToken Login with Apple refresh token
login_by_google POST /api2/v1/auth/loginWithGoogle Login with Google
login_other POST /api2/v1/auth/loginOther Login as another user
login_other1 POST /api2/v3/auth/loginOther Login as another user
login_to_session POST /api2/v1/auth/loginToSession Login to session
login_to_session2 POST /api2/v3/auth/loginToSession Login to session
logout POST /api2/v1/auth/logout Logout
refresh_apple_token GET /api2/v1/auth/refreshAppleToken refresh apple token
who_am_i GET /api2/v1/auth/whoAmI Who am I

login

LoginResponseDto login(body=body)

Login

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_dto import LoginDto
from phrasetms_client.models.login_response_dto import LoginResponseDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginDto() # LoginDto |  (optional)

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

Parameters

Name Type Description Notes
body LoginDto [optional]

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login1

LoginResponseV3Dto login1(body=body)

Login

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_response_v3_dto import LoginResponseV3Dto
from phrasetms_client.models.login_v3_dto import LoginV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginV3Dto() # LoginV3Dto |  (optional)

    try:
        # Login
        api_response = api_instance.login1(body=body)
        print("The response of AuthenticationApi->login1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login1: %s\n" % e)

Parameters

Name Type Description Notes
body LoginV3Dto [optional]

Return type

LoginResponseV3Dto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_by_apple_with_code

LoginResponseDto login_by_apple_with_code(native=native, body=body)

Login with Apple with code

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_response_dto import LoginResponseDto
from phrasetms_client.models.login_with_apple_dto import LoginWithAppleDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    native = True # bool | For sign in with code from native device (optional)
    body = phrasetms_client.LoginWithAppleDto() # LoginWithAppleDto |  (optional)

    try:
        # Login with Apple with code
        api_response = api_instance.login_by_apple_with_code(native=native, body=body)
        print("The response of AuthenticationApi->login_by_apple_with_code:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_by_apple_with_code: %s\n" % e)

Parameters

Name Type Description Notes
native bool For sign in with code from native device [optional]
body LoginWithAppleDto [optional]

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_by_apple_with_refresh_token

LoginResponseDto login_by_apple_with_refresh_token(body=body)

Login with Apple refresh token

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_response_dto import LoginResponseDto
from phrasetms_client.models.login_with_apple_dto import LoginWithAppleDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginWithAppleDto() # LoginWithAppleDto |  (optional)

    try:
        # Login with Apple refresh token
        api_response = api_instance.login_by_apple_with_refresh_token(body=body)
        print("The response of AuthenticationApi->login_by_apple_with_refresh_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_by_apple_with_refresh_token: %s\n" % e)

Parameters

Name Type Description Notes
body LoginWithAppleDto [optional]

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_by_google

LoginResponseDto login_by_google(body=body)

Login with Google

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_response_dto import LoginResponseDto
from phrasetms_client.models.login_with_google_dto import LoginWithGoogleDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginWithGoogleDto() # LoginWithGoogleDto |  (optional)

    try:
        # Login with Google
        api_response = api_instance.login_by_google(body=body)
        print("The response of AuthenticationApi->login_by_google:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_by_google: %s\n" % e)

Parameters

Name Type Description Notes
body LoginWithGoogleDto [optional]

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_other

LoginResponseDto login_other(body=body)

Login as another user

Available only for admin

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_other_dto import LoginOtherDto
from phrasetms_client.models.login_response_dto import LoginResponseDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginOtherDto() # LoginOtherDto |  (optional)

    try:
        # Login as another user
        api_response = api_instance.login_other(body=body)
        print("The response of AuthenticationApi->login_other:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_other: %s\n" % e)

Parameters

Name Type Description Notes
body LoginOtherDto [optional]

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_other1

LoginResponseV3Dto login_other1(body=body)

Login as another user

Available only for admin

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_other_v3_dto import LoginOtherV3Dto
from phrasetms_client.models.login_response_v3_dto import LoginResponseV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginOtherV3Dto() # LoginOtherV3Dto |  (optional)

    try:
        # Login as another user
        api_response = api_instance.login_other1(body=body)
        print("The response of AuthenticationApi->login_other1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_other1: %s\n" % e)

Parameters

Name Type Description Notes
body LoginOtherV3Dto [optional]

Return type

LoginResponseV3Dto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_to_session

LoginToSessionResponseDto login_to_session(body=body)

Login to session

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_to_session_dto import LoginToSessionDto
from phrasetms_client.models.login_to_session_response_dto import LoginToSessionResponseDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginToSessionDto() # LoginToSessionDto |  (optional)

    try:
        # Login to session
        api_response = api_instance.login_to_session(body=body)
        print("The response of AuthenticationApi->login_to_session:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_to_session: %s\n" % e)

Parameters

Name Type Description Notes
body LoginToSessionDto [optional]

Return type

LoginToSessionResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

login_to_session2

LoginToSessionResponseV3Dto login_to_session2(body=body)

Login to session

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_to_session_response_v3_dto import LoginToSessionResponseV3Dto
from phrasetms_client.models.login_to_session_v3_dto import LoginToSessionV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    body = phrasetms_client.LoginToSessionV3Dto() # LoginToSessionV3Dto |  (optional)

    try:
        # Login to session
        api_response = api_instance.login_to_session2(body=body)
        print("The response of AuthenticationApi->login_to_session2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->login_to_session2: %s\n" % e)

Parameters

Name Type Description Notes
body LoginToSessionV3Dto [optional]

Return type

LoginToSessionResponseV3Dto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

logout

logout(token=token, authorization=authorization)

Logout

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    token = 'token_example' # str |  (optional)
    authorization = 'authorization_example' # str |  (optional)

    try:
        # Logout
        api_instance.logout(token=token, authorization=authorization)
    except Exception as e:
        print("Exception when calling AuthenticationApi->logout: %s\n" % e)

Parameters

Name Type Description Notes
token str [optional]
authorization str [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

refresh_apple_token

AppleTokenResponseDto refresh_apple_token(token=token)

refresh apple token

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.apple_token_response_dto import AppleTokenResponseDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)
    token = 'token_example' # str |  (optional)

    try:
        # refresh apple token
        api_response = api_instance.refresh_apple_token(token=token)
        print("The response of AuthenticationApi->refresh_apple_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->refresh_apple_token: %s\n" % e)

Parameters

Name Type Description Notes
token str [optional]

Return type

AppleTokenResponseDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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

who_am_i

LoginUserDto who_am_i()

Who am I

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.login_user_dto import LoginUserDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.AuthenticationApi(api_client)

    try:
        # Who am I
        api_response = api_instance.who_am_i()
        print("The response of AuthenticationApi->who_am_i:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->who_am_i: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

LoginUserDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

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