PasswordResetTokensApi.md

equinix_metal.PasswordResetTokensApi

All URIs are relative to https://api.equinix.com/metal/v1

Method	HTTP request	Description
create_password_reset_token	POST /reset-password	Create a password reset token
reset_password	DELETE /reset-password	Reset current user password

create_password_reset_token

create_password_reset_token(email)

Create a password reset token

Creates a password reset token

Example

• Api Key Authentication (x_auth_token):

import equinix_metal
from equinix_metal.rest import ApiException
from pprint import pprint

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

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

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

# Enter a context with an instance of the API client
with equinix_metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = equinix_metal.PasswordResetTokensApi(api_client)
    email = 'email_example' # str | Email of user to create password reset token

    try:
        # Create a password reset token
        api_instance.create_password_reset_token(email)
    except Exception as e:
        print("Exception when calling PasswordResetTokensApi->create_password_reset_token: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Email of user to create password reset token

Return type

void (empty response body)

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	created	-
401	unauthorized	-
422	unprocessable entity	-

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

reset_password

NewPassword reset_password()

Reset current user password

Resets current user password.

Example

• Api Key Authentication (x_auth_token):

import equinix_metal
from equinix_metal.models.new_password import NewPassword
from equinix_metal.rest import ApiException
from pprint import pprint

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

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

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

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

    try:
        # Reset current user password
        api_response = api_instance.reset_password()
        print("The response of PasswordResetTokensApi->reset_password:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PasswordResetTokensApi->reset_password: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

NewPassword

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	ok	-
401	unauthorized	-
422	unprocessable entity	-

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