Overview

Namespaces

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

Classes

  • Invites
  • Members
  • Organizations
  • Railguns
  • Roles
  • Virtual_Dns
  • Overview
  • Namespace
  • Class

Class Invites

CloudFlare API wrapper

Organization Invites

Cloudflare\Api
Extended by Cloudflare\Organizations\Invites
Namespace: Cloudflare\Organizations
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Organizations/Invites.php
Methods summary
public
# create( string $organization_identifier, string $invited_member_email, array $roles )

Create invitation (permission needed: #organization:read) Invite a User to become a Member of an Organization

Create invitation (permission needed: #organization:read) Invite a User to become a Member of an Organization

Parameters

$organization_identifier
$invited_member_email
Email address of the user to be added to the Organization
$roles
Array of Roles associated with the invited user
public
# invitations( string $organization_identifier )

List invitations (permission needed: #organization:read) List all invitations associated with an organization

List invitations (permission needed: #organization:read) List all invitations associated with an organization

Parameters

$organization_identifier
public
# details( string $organization_identifier, string $identifier )

Invitation details (permission needed: #organization:read) Get the details of an invitation

Invitation details (permission needed: #organization:read) Get the details of an invitation

Parameters

$organization_identifier
$identifier
public
# update( string $organization_identifier, string $identifier, array $roles = null )

Update invitation roles (permission needed: #organization:edit) Change the Roles of a Pending Invite

Update invitation roles (permission needed: #organization:edit) Change the Roles of a Pending Invite

Parameters

$organization_identifier
$identifier
$roles
Array of Roles associated with the invited user
public
# delete_invitation( string $organization_identifier, string $identifier )

Cancel Invitation (permission needed: #organization:edit) Cancel an existing invitation

Cancel Invitation (permission needed: #organization:edit) Cancel an existing invitation

Parameters

$organization_identifier
$identifier
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' => '#organization:read', 'edit' => '#organization:edit']
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen