Skip to content

Latest commit

 

History

History
169 lines (115 loc) · 6.17 KB

UserVerificationTokensApi.md

File metadata and controls

169 lines (115 loc) · 6.17 KB
Raw

equinix_metal.UserVerificationTokensApi

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

Method HTTP request Description
consume_verification_request PUT /verify-email Verify a user using an email verification token
create_validation_request POST /verify-email Create an email verification request

consume_verification_request

consume_verification_request(verify_email, include=include)

Verify a user using an email verification token

Consumes an email verification token and verifies the user associated with it.

Example

  • Api Key Authentication (x_auth_token):
import equinix_metal
from equinix_metal.models.verify_email import VerifyEmail
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.UserVerificationTokensApi(api_client)
    verify_email = equinix_metal.VerifyEmail() # VerifyEmail | Email to create
    include = ['include_example'] # List[str] | Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. (optional)

    try:
        # Verify a user using an email verification token
        api_instance.consume_verification_request(verify_email, include=include)
    except Exception as e:
        print("Exception when calling UserVerificationTokensApi->consume_verification_request: %s\n" % e)

Parameters

Name Type Description Notes
verify_email VerifyEmail Email to create
include List[str] Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. [optional]

Return type

void (empty response body)

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

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

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

create_validation_request

create_validation_request(login, include=include)

Create an email verification request

Creates an email verification request

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.UserVerificationTokensApi(api_client)
    login = 'login_example' # str | Email for verification request
    include = ['include_example'] # List[str] | Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. (optional)

    try:
        # Create an email verification request
        api_instance.create_validation_request(login, include=include)
    except Exception as e:
        print("Exception when calling UserVerificationTokensApi->create_validation_request: %s\n" % e)

Parameters

Name Type Description Notes
login str Email for verification request
include List[str] Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. [optional]

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]