> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyberwave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ProfileApi

# cyberwave.rest.ProfileApi

All URIs are relative to *[http://localhost](http://localhost)*

| Method                                                                                           | HTTP request                                    | Description         |
| ------------------------------------------------------------------------------------------------ | ----------------------------------------------- | ------------------- |
| [**src\_users\_api\_profile\_change\_password**](#src_users_api_profile_change_password)         | **PUT** /api/v1/users/@me/password/             | Change Password     |
| [**src\_users\_api\_profile\_complete\_onboarding**](#src_users_api_profile_complete_onboarding) | **POST** /api/v1/users/@me/onboarding/complete/ | Complete Onboarding |
| [**src\_users\_api\_profile\_update\_profile**](#src_users_api_profile_update_profile)           | **PATCH** /api/v1/users/@me/profile/            | Update Profile      |

# **src\_users\_api\_profile\_change\_password**

> src\_users\_api\_profile\_change\_password(password\_change\_schema)

Change Password

Change the current user's password.

### Example

* Api Key Authentication (CustomTokenAuthentication):

```python theme={null}
import cyberwave.rest
from cyberwave.rest.models.password_change_schema import PasswordChangeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.ProfileApi(api_client)
    password_change_schema = cyberwave.rest.PasswordChangeSchema() # PasswordChangeSchema | 

    try:
        # Change Password
        api_instance.src_users_api_profile_change_password(password_change_schema)
    except Exception as e:
        print("Exception when calling ProfileApi->src_users_api_profile_change_password: %s\n" % e)
```

### Parameters

| Name                         | Type                                                                 | Description | Notes |
| ---------------------------- | -------------------------------------------------------------------- | ----------- | ----- |
| **password\_change\_schema** | [**PasswordChangeSchema**](/api-reference/rest/PasswordChangeSchema) |             |       |

### Return type

void (empty response body)

### Authorization

CustomTokenAuthentication

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ----------- | ---------------- |
| **200**     | OK          | -                |

# **src\_users\_api\_profile\_complete\_onboarding**

> OnboardingCompletionSchema src\_users\_api\_profile\_complete\_onboarding()

Complete Onboarding

Mark the current user onboarding flow as completed.

### Example

* Api Key Authentication (CustomTokenAuthentication):

```python theme={null}
import cyberwave.rest
from cyberwave.rest.models.onboarding_completion_schema import OnboardingCompletionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

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

    try:
        # Complete Onboarding
        api_response = api_instance.src_users_api_profile_complete_onboarding()
        print("The response of ProfileApi->src_users_api_profile_complete_onboarding:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProfileApi->src_users_api_profile_complete_onboarding: %s\n" % e)
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**OnboardingCompletionSchema**](/api-reference/rest/OnboardingCompletionSchema)

### Authorization

CustomTokenAuthentication

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ----------- | ---------------- |
| **200**     | OK          | -                |

# **src\_users\_api\_profile\_update\_profile**

> ProfileResponseSchema src\_users\_api\_profile\_update\_profile(profile\_update\_schema)

Update Profile

Update the current user's profile (first\_name, last\_name, timezone).

### Example

* Api Key Authentication (CustomTokenAuthentication):

```python theme={null}
import cyberwave.rest
from cyberwave.rest.models.profile_response_schema import ProfileResponseSchema
from cyberwave.rest.models.profile_update_schema import ProfileUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.ProfileApi(api_client)
    profile_update_schema = cyberwave.rest.ProfileUpdateSchema() # ProfileUpdateSchema | 

    try:
        # Update Profile
        api_response = api_instance.src_users_api_profile_update_profile(profile_update_schema)
        print("The response of ProfileApi->src_users_api_profile_update_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProfileApi->src_users_api_profile_update_profile: %s\n" % e)
```

### Parameters

| Name                        | Type                                                               | Description | Notes |
| --------------------------- | ------------------------------------------------------------------ | ----------- | ----- |
| **profile\_update\_schema** | [**ProfileUpdateSchema**](/api-reference/rest/ProfileUpdateSchema) |             |       |

### Return type

[**ProfileResponseSchema**](/api-reference/rest/ProfileResponseSchema)

### Authorization

CustomTokenAuthentication

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ----------- | ---------------- |
| **200**     | OK          | -                |