PHP Class Cloudflare\Organizations\Invites

Organization Invites
Author: James Bell ([email protected])
Inheritance: extends CloudFlare\Organizations
Show file Open project: jamesryanbell/cloudflare

Public Methods

Method Description
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
delete_invitation ( string $organization_identifier, string $identifier ) Cancel Invitation (permission needed: #organization:edit) Cancel an existing invitation
details ( string $organization_identifier, string $identifier ) Invitation details (permission needed: #organization:read) Get the details of an invitation
invitations ( string $organization_identifier ) List invitations (permission needed: #organization:read) List all invitations associated with an organization
update ( string $organization_identifier, string $identifier, array $roles = null ) Update invitation roles (permission needed: #organization:edit) Change the Roles of a Pending Invite

Method Details

create() public method

Create invitation (permission needed: #organization:read) Invite a User to become a Member of an Organization
public create ( string $organization_identifier, string $invited_member_email, array $roles )
$organization_identifier string
$invited_member_email string Email address of the user to be added to the Organization
$roles array Array of Roles associated with the invited user

delete_invitation() public method

Cancel Invitation (permission needed: #organization:edit) Cancel an existing invitation
public delete_invitation ( string $organization_identifier, string $identifier )
$organization_identifier string
$identifier string

details() public method

Invitation details (permission needed: #organization:read) Get the details of an invitation
public details ( string $organization_identifier, string $identifier )
$organization_identifier string
$identifier string

invitations() public method

List invitations (permission needed: #organization:read) List all invitations associated with an organization
public invitations ( string $organization_identifier )
$organization_identifier string

update() public method

Update invitation roles (permission needed: #organization:edit) Change the Roles of a Pending Invite
public update ( string $organization_identifier, string $identifier, array $roles = null )
$organization_identifier string
$identifier string
$roles array Array of Roles associated with the invited user