api

Authentication and identity management API for SendAuth platform

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://sendauth.com

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/sendauth/sa-sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/sendauth/sa-sdk-python.git)

Then import the package:

import api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import api
from api.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: basic
configuration = api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = api.ApprovalGroupsApi(api_client)
    id = 'id_example' # str | Approval group ID
    user_id = 'user_id_example' # str | User ID

    try:
        # Add user to approval group
        api_instance.add_user_to_auth_group(id, user_id)
    except ApiException as e:
        print("Exception when calling ApprovalGroupsApi->add_user_to_auth_group: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://app.sendauth.com

Class	Method	HTTP request	Description
ApprovalGroupsApi	add_user_to_auth_group	POST /api/v1/approval-groups/{id}/users/{userID}	Add user to approval group
ApprovalGroupsApi	create_auth_group	POST /api/v1/approval-groups	Create approval group
ApprovalGroupsApi	delete_auth_group	DELETE /api/v1/approval-groups/{id}	Delete approval group
ApprovalGroupsApi	get_auth_group	GET /api/v1/approval-groups/{id}	Get approval group
ApprovalGroupsApi	list_auth_groups	GET /api/v1/approval-groups	List approval groups
ApprovalGroupsApi	remove_user_from_auth_group	DELETE /api/v1/approval-groups/{id}/users/{userID}	Remove user from approval group
ApprovalGroupsApi	set_auth_group_tags	PUT /api/v1/approval-groups/{id}/tags	Set approval group tags
ApprovalGroupsApi	update_auth_group	PUT /api/v1/approval-groups/{id}	Update approval group
AuditsApi	list_audits	GET /api/v1/audits	List audits
CompaniesApi	create_company	POST /api/v1/companies	Create company
CompaniesApi	delete_company	DELETE /api/v1/companies/{id}	Delete company
CompaniesApi	list_companies	GET /api/v1/companies	List companies
CompaniesApi	update_company	PUT /api/v1/companies/{id}	Update company
PermissionGroupsApi	create_permission_group	POST /api/v1/permission-groups	Create permission group
PermissionGroupsApi	delete_permission_group	DELETE /api/v1/permission-groups/{id}	Delete permission group
PermissionGroupsApi	list_permission_groups	GET /api/v1/permission-groups	List permission groups
PermissionGroupsApi	rename_permission_group	PUT /api/v1/permission-groups/{id}	Rename permission group
PermissionGroupsApi	set_permission_group_permissions	PUT /api/v1/permission-groups/{id}/permissions	Set permission group permissions
PermissionsApi	create_permission	POST /api/v1/permissions	Create permission
PermissionsApi	delete_permission	DELETE /api/v1/permissions/{name}	Delete permission
PermissionsApi	list_permissions	GET /api/v1/permissions	List permissions
PermissionsApi	rename_permission	PUT /api/v1/permissions/{name}	Rename permission
RoutingRulesApi	authorize	POST /api/v1/authorize	Authorize a request
RoutingRulesApi	create_routing_rule	POST /api/v1/tag-routing-rules	Create routing rule
RoutingRulesApi	delete_routing_rule	DELETE /api/v1/tag-routing-rules/{id}	Delete routing rule
RoutingRulesApi	get_routing_rule	GET /api/v1/tag-routing-rules/{id}	Get routing rules
RoutingRulesApi	list_routing_rules	GET /api/v1/tag-routing-rules	Get routing rules
RoutingRulesApi	update_routing_rule	PUT /api/v1/tag-routing-rules/{id}	Update routing rule
SettingsApi	get_settings	GET /api/v1/settings	Get organization settings
SettingsApi	update_settings	PUT /api/v1/settings	Update organization settings
TagsApi	create_tag	POST /api/v1/tags	Create tag
TagsApi	delete_tag	DELETE /api/v1/tags/{tagName}	Delete tag
TagsApi	list_tags	GET /api/v1/tags	List tags
TagsApi	update_tag	PUT /api/v1/tags/{tagName}	Update tag
TagsApi	update_tag_value	PUT /api/v1/tags/{tagName}/values/{tagValue}	Update tag value
TransactionsApi	cancel_transaction	DELETE /api/v1/transactions/{txID}/cancel	Cancel transaction
TransactionsApi	check_transaction_status	GET /api/v1/transactions/{txID}/check	Check transaction status
TransactionsApi	get_transaction_history	GET /api/v1/transactions/{txID}/history	Get transaction history
TransactionsApi	list_transactions	GET /api/v1/transactions	List transactions
TransactionsApi	set_transaction_tags	PUT /api/v1/transactions/{txID}/tags	Set transaction tags
UsersApi	authenticate_user	POST /api/v1/users/{userID}/authenticate	Authenticate user
UsersApi	create_user	POST /api/v1/users	Create user
UsersApi	delete_user	DELETE /api/v1/users/{userID}	Delete user
UsersApi	destroy_user	DELETE /api/v1/users/deleted/{userID}	Permanently delete user
UsersApi	get_user	GET /api/v1/users/{userID}	Get user
UsersApi	get_user_audits	GET /api/v1/users/{userID}/audits	Get user audits
UsersApi	get_user_transactions	GET /api/v1/users/{userID}/transactions	Get user transactions
UsersApi	list_deleted_users	GET /api/v1/users/deleted	List deleted users
UsersApi	list_users	GET /api/v1/users	List users
UsersApi	register_user	POST /api/v1/users/{userID}/register	Register user
UsersApi	remove_user_passkey	DELETE /api/v1/users/{userID}/passkey	Remove user passkey
UsersApi	restore_user	PUT /api/v1/users/deleted/{userID}	Restore deleted user
UsersApi	set_user_tags	PUT /api/v1/users/{userID}/tags	Set user tags
UsersApi	update_user	PUT /api/v1/users/{userID}	Update user
WebhooksApi	create_webhook	POST /api/v1/webhooks	Create a new webhook
WebhooksApi	delete_webhook	DELETE /api/v1/webhooks/{id}	Delete a webhook
WebhooksApi	list_webhooks	GET /api/v1/webhooks	List all webhooks
WebhooksApi	update_webhook	PUT /api/v1/webhooks/{id}	Update a webhook

Documentation For Models

• Audit
• AuthGroup
• AuthGroupMember
• AuthorizeReply
• AuthorizeReplyOneOf
• AuthorizeReplyOneOf1
• AuthorizeRequest
• CheckTransactionStatus200Response
• Company
• ConnectWise
• CreateTagRequest
• Error
• IDReply
• OpenID
• PaginatedAudits
• PaginatedTransactions
• PaginatedUsers
• Permission
• PermissionGroup
• PermissionGroupsReply
• PermissionsReply
• Query
• RoutingRule
• SetPermissionGroupPermissionsRequest
• SetTransactionTagsRequest
• Settings
• TX
• Tag
• TagListReply
• TagUpdateRequest
• TagsRequest
• Transaction
• UpdateTagValueRequest
• User
• ValidationError
• WebTX
• Webhook
• WebhookEvents
• WebhookInput

Documentation For Authorization

Authentication schemes defined for the API:

basic

• Type: HTTP basic authentication

Author