corellium.UsersV1Api

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_change_password_users	POST /v1/users/change-password	Change User Password
v1_create_user	POST /v1/users	Create User
v1_delete_user	DELETE /v1/users/{userId}	Delete User
v1_get_reset_link_info	GET /v1/users/reset-link-info	Send Password Reset Link Info
v1_reset_user_password	POST /v1/users/reset-password	Reset User Password
v1_send_user_reset_link	POST /v1/users/send-reset-link	Send Password Reset Link
v1_update_user	PATCH /v1/users/{userId}	Update User
v1_user_agree_terms	POST /v1/users/agree	Consent to the current terms and conditions
v1_users_login	POST /v1/users/login	Log In

v1_change_password_users

v1_change_password_users(password_change_body)

Change User Password

Authenticated solely by the old-password.

Example

import corellium
from corellium.models.password_change_body import PasswordChangeBody
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.UsersV1Api(api_client)
    password_change_body = {
  "user": "<userId>",
  "old-password": "Password1",
  "new-password": "Password2"
} # PasswordChangeBody | 

    try:
        # Change User Password
        api_instance.v1_change_password_users(password_change_body)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_change_password_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
password_change_body	PasswordChangeBody

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Accepted	-
403	Forbidden	-

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

v1_create_user

UserCreateReturn v1_create_user(user_create)

Create User

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.user_create import UserCreate
from corellium.models.user_create_return import UserCreateReturn
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.UsersV1Api(api_client)
    user_create = {
  "name": "test",
  "label": "Project Admin",
} # UserCreate | User data

    try:
        # Create User
        api_response = api_instance.v1_create_user(user_create)
        print("The response of UsersV1Api->v1_create_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_create	UserCreate	User data

Return type

UserCreateReturn

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User	-
403	Forbidden	-

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

v1_delete_user

v1_delete_user(user_id)

Delete User

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.UsersV1Api(api_client)
    user_id = 'user_id_example' # str | userId - uuid

    try:
        # Delete User
        api_instance.v1_delete_user(user_id)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	userId - 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_reset_link_info

ResetLinkInfoReturn v1_get_reset_link_info(token)

Send Password Reset Link Info

Example

import corellium
from corellium.models.reset_link_info_return import ResetLinkInfoReturn
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.UsersV1Api(api_client)
    token = 'token_example' # str | Reset token

    try:
        # Send Password Reset Link Info
        api_response = api_instance.v1_get_reset_link_info(token)
        print("The response of UsersV1Api->v1_get_reset_link_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_get_reset_link_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
token	str	Reset token

Return type

ResetLinkInfoReturn

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Reset Link Info	-
403	Forbidden	-

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

v1_reset_user_password

v1_reset_user_password(password_reset_body)

Reset User Password

Example

import corellium
from corellium.models.password_reset_body import PasswordResetBody
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.UsersV1Api(api_client)
    password_reset_body = {
  "token": "<token>",
  "totpToken": "<totpToken>",
  "new-password": "password"
} # PasswordResetBody | application/json

    try:
        # Reset User Password
        api_instance.v1_reset_user_password(password_reset_body)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_reset_user_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
password_reset_body	PasswordResetBody	application/json

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Accepted	-
403	Forbidden	-

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

v1_send_user_reset_link

v1_send_user_reset_link(reset_link_body)

Send Password Reset Link

Example

import corellium
from corellium.models.reset_link_body import ResetLinkBody
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.UsersV1Api(api_client)
    reset_link_body = corellium.ResetLinkBody() # ResetLinkBody | application/json

    try:
        # Send Password Reset Link
        api_instance.v1_send_user_reset_link(reset_link_body)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_send_user_reset_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
reset_link_body	ResetLinkBody	application/json

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Accepted	-
403	Forbidden	-

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

v1_update_user

v1_update_user(user_id, user_update)

Update User

Update a user. Fields such as name, label, password, and clusterAdministrator can be updated. Only users with the Cluster Administrator role can set or modify the clusterAdministrator flag.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.user_update import UserUpdate
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.UsersV1Api(api_client)
    user_id = 'user_id_example' # str | userId - uuid
    user_update = {
  "name": "test",
  "label": "Project Admin",
  "password": "new-password",
  "clusterAdministrator": true
} # UserUpdate | User data

    try:
        # Update User
        api_instance.v1_update_user(user_id, user_update)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_update_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	userId - uuid
user_update	UserUpdate	User data

Return type

void (empty response body)

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_user_agree_terms

AgreedAckV1 v1_user_agree_terms()

Consent to the current terms and conditions

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.agreed_ack_v1 import AgreedAckV1
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.UsersV1Api(api_client)

    try:
        # Consent to the current terms and conditions
        api_response = api_instance.v1_user_agree_terms()
        print("The response of UsersV1Api->v1_user_agree_terms:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->v1_user_agree_terms: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AgreedAckV1

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	application/json	-
403	Forbidden	-

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

v1_users_login

TokenV1 v1_users_login(credentials)

Example

import corellium
from corellium.models.credentials import Credentials
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.UsersV1Api(api_client)
    credentials = {
  "username": "admin",
  "password": "password"
} # Credentials | Authorization data

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

Parameters

Name	Type	Description	Notes
credentials	Credentials	Authorization data

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]

FilesExpand file tree

UsersV1Api.md

Latest commit

History

UsersV1Api.md

File metadata and controls

corellium.UsersV1Api

Request timeouts

v1_change_password_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_create_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_delete_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_get_reset_link_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_reset_user_password

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_send_user_reset_link

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_update_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_user_agree_terms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_users_login

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details