Overview

Namespaces

  • Cloudflare
    • Organizations
      • Firewall
        • AccessRules
    • User
      • Billing
        • Subscriptions
      • Firewall
    • Zone
      • Firewall
      • SSL
      • WAF
        • Packages

Classes

  • Api
  • Certificates
  • IPs
  • Railguns
  • User
  • Zone
  • Overview
  • Namespace
  • Class

Class User

CloudFlare API wrapper

User The currently logged in/authenticated User

Cloudflare\Api
Extended by Cloudflare\User
Namespace: Cloudflare
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/User.php
Methods summary
public
# user( )

User details

User details

public
# update( string|null $first_name = null, string|null $last_name = null, string|null $telephone = null, string|null $country = null, string|null $zipcode = null )

Update user Update part of your user details

Update user Update part of your user details

Parameters

$first_name
User's first name
$last_name
User's last name
$telephone
User's telephone number
$country
The country in which the user lives. (Full list is here: http://en.wikipedia.org/wiki/List_of_country_calling_codes)
$zipcode
The zipcode or postal code where the user lives.
public
# change_email( string $email, string $email_confirm, string $password )

Change your email address. Note: You must provide your current password.

Change your email address. Note: You must provide your current password.

Parameters

$email
Your contact email address
$email_confirm
Your contact email address, repeated
$password
Your current password
public
# change_password( string $old_password, string $new_password, string $new_password_confirm )

Change your password

Change your password

Parameters

$old_password
Your current password
$new_password
Your new password
$new_password_confirm
Your new password, repeated
public
# change_username( string $username, string $password )

Change your username. Note: You must provide your current password.

Change your username. Note: You must provide your current password.

Parameters

$username
A username used to access other cloudflare services, like support
$password
Your current password
public
# initialize_two_factor_authentication( integer $country_code, string $mobile_phone_number, string $current_password )

Begin setting up CloudFlare two-factor authentication with a given telephone number

Begin setting up CloudFlare two-factor authentication with a given telephone number

Parameters

$country_code
The country code of your mobile phone number
$mobile_phone_number
Your mobile phone number
$current_password
Your current CloudFlare password
public
# finalize_two_factor_authentication( integer $auth_token )

Finish setting up CloudFlare two-factor authentication with a given telephone number

Finish setting up CloudFlare two-factor authentication with a given telephone number

Parameters

$auth_token
The token provided by the two-factor authenticator
public
# disable_two_factor_authentication( integer $auth_token )

Disable two-factor authentication for your CloudFlare user account

Disable two-factor authentication for your CloudFlare user account

Parameters

$auth_token
token provided by the two-factor authenticator
Methods inherited from Cloudflare\Api
__construct(), delete(), get(), patch(), permissions(), post(), put(), request(), setAuthKey(), setCurlOption(), setEmail()
Properties summary
protected array $permission_level

Default permissions level

Default permissions level

# ['read' => null, 'edit' => null]
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen