Skip to content

AuthenticationV1Api.md

Latest commit

 

History

History
260 lines (178 loc) · 8.18 KB

AuthenticationV1Api.md

File metadata and controls

260 lines (178 loc) · 8.18 KB
Raw

corellium.AuthenticationV1Api

Request timeouts

Every API method accepts _request_timeout in seconds: a positive float for the urllib3 total timeout, or a pair of positive floats (connect, read). This controls HTTP transport waiting, not how long the server operation may run. It is not a wall-clock deadline for the operation or for all retries combined.

Transport timeouts raise urllib3.exceptions.TimeoutError subclasses such as ReadTimeoutError and ConnectTimeoutError. When retries are exhausted, urllib3 can instead raise urllib3.exceptions.MaxRetryError; inspect its reason to distinguish a timeout from other connection failures. Retry behavior depends on the HTTP method and Configuration.retries. These are client-side exceptions, not HTTP response statuses or SDK ApiException responses.

A timeout does not guarantee cancellation or rollback of an operation accepted by the server. For example, after a start request times out, the instance may still be starting or may already be running; the timeout alone does not establish its state or mean it was stopped or destroyed. The request might not have reached the server at all, leaving the instance off. Treat the outcome as unknown and fetch the instance's current state before deciding whether to retry. If it has since been destroyed, that lookup may return not found; the timeout itself does not prove destruction. Do not blindly repeat a state-changing request.

Catch urllib3.exceptions.TimeoutError and urllib3.exceptions.MaxRetryError separately from the SDK ApiException. MaxRetryError is not a subclass of TimeoutError. With _with_http_info the same rules apply. With _without_preload_content, a read timeout may also occur later when reading the returned response body.

All URIs are relative to https://app.corellium.com/api

Method HTTP request Description
v1_auth_login POST /v1/auth/login Log In
v1_delete_api_token DELETE /v1/auth/apitoken Delete API token
v1_generate_api_token POST /v1/auth/apitoken Generate API token

v1_auth_login

TokenV1 v1_auth_login(body)

Log In

Authenticate with username/password or a persistent apiToken. On success returns a freshly-regenerated session token (JWT).

Example

import corellium
from corellium.models.token_v1 import TokenV1
from corellium.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with corellium.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = corellium.AuthenticationV1Api(api_client)
    body = {
  "username": "admin",
  "password": "password"
} # object | Authorization data ( Credentials|ApiToken )

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

Parameters

Name Type Description Notes
body object Authorization data ( Credentials ApiToken )

Return type

TokenV1

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 User Authorization -
403 Forbidden -

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

v1_delete_api_token

v1_delete_api_token()

Delete API token

Delete the authenticated user's currently saved API token.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): BearerAuth
configuration = corellium.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Delete API token
        api_instance.v1_delete_api_token()
    except Exception as e:
        print("Exception when calling AuthenticationV1Api->v1_delete_api_token: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 The API token was deleted -
403 Forbidden -

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

v1_generate_api_token

ApiToken v1_generate_api_token()

Generate API token

Generate a new API token for the authenticated user. The token is returned once and replaces any previously issued token.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.api_token import ApiToken
from corellium.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): BearerAuth
configuration = corellium.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Generate API token
        api_response = api_instance.v1_generate_api_token()
        print("The response of AuthenticationV1Api->v1_generate_api_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationV1Api->v1_generate_api_token: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiToken

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A freshly generated API token -
403 Forbidden -

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