wordlift_client.OAuth2AuthorizedClientsApi

All URIs are relative to https://api.wordlift.io

Method	HTTP request	Description
create_o_auth2_authorized_client	POST /oauth2/authorized-clients	Create
delete_o_auth2_authorized_client	DELETE /oauth2/authorized-clients/{id}	Delete
get_o_auth2_authorized_client	GET /oauth2/authorized-clients/{id}	Get
list_o_auth2_authorized_clients	GET /oauth2/authorized-clients	List
update_o_auth2_authorized_client	PUT /oauth2/authorized-clients/{id}	Update

create_o_auth2_authorized_client

OAuth2AuthorizedClient create_o_auth2_authorized_client(o_auth2_authorized_client_request)

Create

Create a OAuth2 Authorized Client

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.o_auth2_authorized_client import OAuth2AuthorizedClient
from wordlift_client.models.o_auth2_authorized_client_request import OAuth2AuthorizedClientRequest
from wordlift_client.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.OAuth2AuthorizedClientsApi(api_client)
    o_auth2_authorized_client_request = wordlift_client.OAuth2AuthorizedClientRequest() # OAuth2AuthorizedClientRequest | 

    try:
        # Create
        api_response = await api_instance.create_o_auth2_authorized_client(o_auth2_authorized_client_request)
        print("The response of OAuth2AuthorizedClientsApi->create_o_auth2_authorized_client:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OAuth2AuthorizedClientsApi->create_o_auth2_authorized_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
o_auth2_authorized_client_request	OAuth2AuthorizedClientRequest

Return type

OAuth2AuthorizedClient

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-

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

delete_o_auth2_authorized_client

delete_o_auth2_authorized_client(id)

Delete

Delete a OAuth2 Authorized Client given its client registration id

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.OAuth2AuthorizedClientsApi(api_client)
    id = 56 # int | The Id

    try:
        # Delete
        await api_instance.delete_o_auth2_authorized_client(id)
    except Exception as e:
        print("Exception when calling OAuth2AuthorizedClientsApi->delete_o_auth2_authorized_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The Id

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-

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

get_o_auth2_authorized_client

OAuth2AuthorizedClient get_o_auth2_authorized_client(id)

Get

Get a OAuth2 Authorized Client given its client registration id

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.o_auth2_authorized_client import OAuth2AuthorizedClient
from wordlift_client.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.OAuth2AuthorizedClientsApi(api_client)
    id = 56 # int | The Id

    try:
        # Get
        api_response = await api_instance.get_o_auth2_authorized_client(id)
        print("The response of OAuth2AuthorizedClientsApi->get_o_auth2_authorized_client:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OAuth2AuthorizedClientsApi->get_o_auth2_authorized_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The Id

Return type

OAuth2AuthorizedClient

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-

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

list_o_auth2_authorized_clients

PageOAuth2AuthorizedClient list_o_auth2_authorized_clients(cursor=cursor, limit=limit)

List

List OAuth2 Authorized Clients

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.page_o_auth2_authorized_client import PageOAuth2AuthorizedClient
from wordlift_client.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.OAuth2AuthorizedClientsApi(api_client)
    cursor = 'cursor_example' # str | The cursor (optional)
    limit = 10 # int | The maximum number of results (optional) (default to 10)

    try:
        # List
        api_response = await api_instance.list_o_auth2_authorized_clients(cursor=cursor, limit=limit)
        print("The response of OAuth2AuthorizedClientsApi->list_o_auth2_authorized_clients:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OAuth2AuthorizedClientsApi->list_o_auth2_authorized_clients: %s\n" % e)

Parameters

Name	Type	Description	Notes
cursor	str	The cursor	[optional]
limit	int	The maximum number of results	[optional] [default to 10]

Return type

PageOAuth2AuthorizedClient

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-

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

update_o_auth2_authorized_client

OAuth2AuthorizedClient update_o_auth2_authorized_client(id, o_auth2_authorized_client_request)

Update

Update a OAuth2 Authorized Client given its client registration id

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.o_auth2_authorized_client import OAuth2AuthorizedClient
from wordlift_client.models.o_auth2_authorized_client_request import OAuth2AuthorizedClientRequest
from wordlift_client.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.OAuth2AuthorizedClientsApi(api_client)
    id = 56 # int | The Id
    o_auth2_authorized_client_request = wordlift_client.OAuth2AuthorizedClientRequest() # OAuth2AuthorizedClientRequest | 

    try:
        # Update
        api_response = await api_instance.update_o_auth2_authorized_client(id, o_auth2_authorized_client_request)
        print("The response of OAuth2AuthorizedClientsApi->update_o_auth2_authorized_client:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OAuth2AuthorizedClientsApi->update_o_auth2_authorized_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The Id
o_auth2_authorized_client_request	OAuth2AuthorizedClientRequest

Return type

OAuth2AuthorizedClient

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-

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

Files

OAuth2AuthorizedClientsApi.md

Latest commit

History

OAuth2AuthorizedClientsApi.md

File metadata and controls

wordlift_client.OAuth2AuthorizedClientsApi

create_o_auth2_authorized_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_o_auth2_authorized_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_o_auth2_authorized_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_o_auth2_authorized_clients

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_o_auth2_authorized_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details