corellium.DomainAuthProvidersApi

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
v3_create_domain_auth_provider	POST /v3/domain/{domainId}/auth	Create a new auth provider for a domain
v3_delete_domain_auth_provider	DELETE /v3/domain/{domainId}/auth/{providerId}	Delete an auth provider from a domain
v3_list_domain_auth_providers	GET /v3/domain/{domainId}/auth	Return all configured auth providers for a domain (including globally configured providers)
v3_patch_domain_auth_provider	PATCH /v3/domain/{domainId}/auth/{providerId}	Partially update an auth provider for a domain
v3_update_domain_auth_provider	PUT /v3/domain/{domainId}/auth/{providerId}	Update an auth provider for a domain

v3_create_domain_auth_provider

CreateDomainAuthProviderResponse v3_create_domain_auth_provider(domain_id, create_domain_auth_provider_body)

Create a new auth provider for a domain

Required role: Domain administrator.

Create a new auth provider for a domain.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.create_domain_auth_provider_body import CreateDomainAuthProviderBody
from corellium.models.create_domain_auth_provider_response import CreateDomainAuthProviderResponse
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.DomainAuthProvidersApi(api_client)
    domain_id = 'c29762d1-45d7-489d-a3a2-9dadc43978ba' # str | Domain identifier.
    create_domain_auth_provider_body = corellium.CreateDomainAuthProviderBody() # CreateDomainAuthProviderBody | 

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

Parameters

Name	Type	Description	Notes
domain_id	str	Domain identifier.
create_domain_auth_provider_body	CreateDomainAuthProviderBody

Return type

CreateDomainAuthProviderResponse

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Auth provider created.	-
400	Invalid request body.	-
403	Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.	-

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

v3_delete_domain_auth_provider

v3_delete_domain_auth_provider(domain_id, provider_id)

Delete an auth provider from a domain

Required role: Domain administrator.

Delete an auth provider from a domain.

Deletes are idempotent: a providerId that is not attached to the domain, or an unknown domainId, is a successful no-op that still returns 204, and repeated calls return 204 as well. A 404 means the request path did not match a delete route, not that the target was missing. The underlying provider record is only removed when no other domain still references it, and default providers are never removed.

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.DomainAuthProvidersApi(api_client)
    domain_id = 'c29762d1-45d7-489d-a3a2-9dadc43978ba' # str | Domain identifier.
    provider_id = 'sso.example.com' # str | Provider identifier.

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

Parameters

Name	Type	Description	Notes
domain_id	str	Domain identifier.
provider_id	str	Provider identifier.

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	Successfully deleted auth provider.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-
403	Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.	-

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

v3_list_domain_auth_providers

DomainAuthProvidersList v3_list_domain_auth_providers(domain_id, limit=limit, offset=offset)

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

Required role: Domain administrator.

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

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.domain_auth_providers_list import DomainAuthProvidersList
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.DomainAuthProvidersApi(api_client)
    domain_id = 'c29762d1-45d7-489d-a3a2-9dadc43978ba' # str | Domain identifier.
    limit = 100 # float | Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400. (optional) (default to 100)
    offset = 0 # float | How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`. (optional) (default to 0)

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

Parameters

Name	Type	Description	Notes
domain_id	str	Domain identifier.
limit	float	Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.	[optional] [default to 100]
offset	float	How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.	[optional] [default to 0]

Return type

DomainAuthProvidersList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of auth providers.	-
403	Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.	-

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

v3_patch_domain_auth_provider

DomainAuthProviderResponse v3_patch_domain_auth_provider(domain_id, provider_id, patch_domain_auth_provider_body=patch_domain_auth_provider_body)

Partially update an auth provider for a domain

Required role: Domain administrator.

Partially update an auth provider for a domain.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.domain_auth_provider_response import DomainAuthProviderResponse
from corellium.models.patch_domain_auth_provider_body import PatchDomainAuthProviderBody
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.DomainAuthProvidersApi(api_client)
    domain_id = 'c29762d1-45d7-489d-a3a2-9dadc43978ba' # str | Domain identifier.
    provider_id = 'sso.example.com' # str | Provider identifier.
    patch_domain_auth_provider_body = corellium.PatchDomainAuthProviderBody() # PatchDomainAuthProviderBody |  (optional)

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

Parameters

Name	Type	Description	Notes
domain_id	str	Domain identifier.
provider_id	str	Provider identifier.
patch_domain_auth_provider_body	PatchDomainAuthProviderBody		[optional]

Return type

DomainAuthProviderResponse

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated auth provider.	-
400	Invalid request body.	-
403	Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.	-

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

v3_update_domain_auth_provider

DomainAuthProviderResponse v3_update_domain_auth_provider(domain_id, provider_id, create_domain_auth_provider_body)

Update an auth provider for a domain

Required role: Domain administrator.

Update an auth provider for a domain.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.create_domain_auth_provider_body import CreateDomainAuthProviderBody
from corellium.models.domain_auth_provider_response import DomainAuthProviderResponse
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.DomainAuthProvidersApi(api_client)
    domain_id = 'c29762d1-45d7-489d-a3a2-9dadc43978ba' # str | Domain identifier.
    provider_id = 'sso.example.com' # str | Provider identifier.
    create_domain_auth_provider_body = corellium.CreateDomainAuthProviderBody() # CreateDomainAuthProviderBody | 

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

Parameters

Name	Type	Description
domain_id	str	Domain identifier.
provider_id	str	Provider identifier.
create_domain_auth_provider_body	CreateDomainAuthProviderBody

Return type

DomainAuthProviderResponse

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated auth provider.	-
400	Invalid request body.	-
403	Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.	-

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

FilesExpand file tree

DomainAuthProvidersApi.md

Latest commit

History

DomainAuthProvidersApi.md

File metadata and controls

corellium.DomainAuthProvidersApi

Request timeouts

v3_create_domain_auth_provider

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_delete_domain_auth_provider

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_domain_auth_providers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_patch_domain_auth_provider

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_update_domain_auth_provider

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details