Skip to content

DomainAuthProviderApi.md

Latest commit

 

History

History
377 lines (271 loc) · 13.5 KB

DomainAuthProviderApi.md

File metadata and controls

377 lines (271 loc) · 13.5 KB
Raw

corellium.DomainAuthProviderApi

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_create_domain_auth_provider POST /v1/domain/{domainId}/auth Create a new auth provider for a domain
v1_delete_domain_auth_provider DELETE /v1/domain/{domainId}/auth/{providerId} Delete an auth provider from a domain
v1_get_domain_auth_providers GET /v1/domain/{domainId}/auth Return all configured auth providers for a domain (including globally configured providers)
v1_update_domain_auth_provider PUT /v1/domain/{domainId}/auth/{providerId} Update an auth provider for a domain

v1_create_domain_auth_provider

DomainAuthProviderResponseV1 v1_create_domain_auth_provider(domain_id, domain_auth_provider_request)

Create a new auth provider for a domain

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.domain_auth_provider_request import DomainAuthProviderRequest
from corellium.models.domain_auth_provider_response_v1 import DomainAuthProviderResponseV1
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.DomainAuthProviderApi(api_client)
    domain_id = 'domain_id_example' # str | Domain ID - uuid
    domain_auth_provider_request = {
  "enabled": true,
  "providerType": "open-id-connect",
  "label": "Login with Custom Auth0",
  "config": {
    "discoveryUrl": "http://localhost:8080/realms/Corellium/.well-known/openid-configuration",
    "clientId": "B5GhRzrVn19adO1a1vJ6aZRYdNY9jSP4",
    "clientSecret": "itsasecret",
    "invitedOnly": false
  }
} # DomainAuthProviderRequest | Request Data

    try:
        # Create a new auth provider for a domain
        api_response = api_instance.v1_create_domain_auth_provider(domain_id, domain_auth_provider_request)
        print("The response of DomainAuthProviderApi->v1_create_domain_auth_provider:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainAuthProviderApi->v1_create_domain_auth_provider: %s\n" % e)

Parameters

Name Type Description Notes
domain_id str Domain ID - uuid
domain_auth_provider_request DomainAuthProviderRequest Request Data

Return type

DomainAuthProviderResponseV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -

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

v1_delete_domain_auth_provider

v1_delete_domain_auth_provider(domain_id, provider_id)

Delete an auth provider from a domain

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.DomainAuthProviderApi(api_client)
    domain_id = 'domain_id_example' # str | Domain ID - uuid
    provider_id = 'provider_id_example' # str | Provider ID - uuid

    try:
        # Delete an auth provider from a domain
        api_instance.v1_delete_domain_auth_provider(domain_id, provider_id)
    except Exception as e:
        print("Exception when calling DomainAuthProviderApi->v1_delete_domain_auth_provider: %s\n" % e)

Parameters

Name Type Description Notes
domain_id str Domain ID - uuid
provider_id str Provider ID - uuid

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
200 OK -
403 Forbidden -

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

v1_get_domain_auth_providers

List[DomainAuthProviderResponseV1] v1_get_domain_auth_providers(domain_id)

Return all configured auth providers for a domain (including globally configured providers)

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.domain_auth_provider_response_v1 import DomainAuthProviderResponseV1
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.DomainAuthProviderApi(api_client)
    domain_id = 'domain_id_example' # str | Domain ID - uuid

    try:
        # Return all configured auth providers for a domain (including globally configured providers)
        api_response = api_instance.v1_get_domain_auth_providers(domain_id)
        print("The response of DomainAuthProviderApi->v1_get_domain_auth_providers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainAuthProviderApi->v1_get_domain_auth_providers: %s\n" % e)

Parameters

Name Type Description Notes
domain_id str Domain ID - uuid

Return type

List[DomainAuthProviderResponseV1]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -

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

v1_update_domain_auth_provider

DomainAuthProviderResponseV1 v1_update_domain_auth_provider(domain_id, provider_id, domain_auth_provider_request)

Update an auth provider for a domain

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.domain_auth_provider_request import DomainAuthProviderRequest
from corellium.models.domain_auth_provider_response_v1 import DomainAuthProviderResponseV1
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.DomainAuthProviderApi(api_client)
    domain_id = 'domain_id_example' # str | Domain ID - uuid
    provider_id = 'provider_id_example' # str | Provider ID - uuid
    domain_auth_provider_request = {
  "enabled": false,
  "providerType": "open-id-connect",
  "label": "Login with Custom Auth0",
  "config": {
    "discoveryUrl": "http://localhost:8080/realms/Corellium/.well-known/openid-configuration",
    "clientId": "B5GhRzrVn19adO1a1vJ6aZRYdNY9jSP4",
    "clientSecret": "itsasecret",
    "invitedOnly": true
  }
} # DomainAuthProviderRequest | Request Data

    try:
        # Update an auth provider for a domain
        api_response = api_instance.v1_update_domain_auth_provider(domain_id, provider_id, domain_auth_provider_request)
        print("The response of DomainAuthProviderApi->v1_update_domain_auth_provider:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainAuthProviderApi->v1_update_domain_auth_provider: %s\n" % e)

Parameters

Name Type Description Notes
domain_id str Domain ID - uuid
provider_id str Provider ID - uuid
domain_auth_provider_request DomainAuthProviderRequest Request Data

Return type

DomainAuthProviderResponseV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -

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