InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\OrganizationsService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteOrgsID ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDWithHttpInfo ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersID ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersIDWithHttpInfo ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersID ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersIDWithHttpInfo ($user_id, $org_id, $zap_trace_span=null)
 
 getOrgs ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsWithHttpInfo ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsID ($org_id, $zap_trace_span=null)
 
 getOrgsIDWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembers ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembersWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwners ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwnersWithHttpInfo ($org_id, $zap_trace_span=null)
 
 patchOrgsID ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 patchOrgsIDWithHttpInfo ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 postOrgs ($post_organization_request, $zap_trace_span=null)
 
 postOrgsWithHttpInfo ($post_organization_request, $zap_trace_span=null)
 
 postOrgsIDMembers ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDMembersWithHttpInfo ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwners ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwnersWithHttpInfo ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 

Protected Member Functions

 deleteOrgsIDRequest ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersIDRequest ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersIDRequest ($user_id, $org_id, $zap_trace_span=null)
 
 getOrgsRequest ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsIDRequest ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembersRequest ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwnersRequest ($org_id, $zap_trace_span=null)
 
 patchOrgsIDRequest ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 postOrgsRequest ($post_organization_request, $zap_trace_span=null)
 
 postOrgsIDMembersRequest ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwnersRequest ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\OrganizationsService::__construct ( DefaultApi  $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ deleteOrgsID()

InfluxDB2\Service\OrganizationsService::deleteOrgsID (   $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsID

Delete an organization

Parameters
string$org_idThe ID of the organization to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteOrgsIDMembersID()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersID (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDMembersID

Remove a member from an organization

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteOrgsIDMembersIDRequest()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersIDRequest (   $user_id,
  $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteOrgsIDMembersID'

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteOrgsIDMembersIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersIDWithHttpInfo (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDMembersIDWithHttpInfo

Remove a member from an organization

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteOrgsIDOwnersID()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersID (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDOwnersID

Remove an owner from an organization

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteOrgsIDOwnersIDRequest()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersIDRequest (   $user_id,
  $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteOrgsIDOwnersID'

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteOrgsIDOwnersIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersIDWithHttpInfo (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDOwnersIDWithHttpInfo

Remove an owner from an organization

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteOrgsIDRequest()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteOrgsID'

Parameters
string$org_idThe ID of the organization to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteOrgsIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDWithHttpInfo

Delete an organization

Parameters
string$org_idThe ID of the organization to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ getOrgs()

InfluxDB2\Service\OrganizationsService::getOrgs (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)

Operation getOrgs

List organizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetThe offset for pagination. The number of records to skip. (optional)
int$limitLimits the number of records returned. Default is `20`. (optional, default to 20)
bool$descendingdescending (optional, default to false)
string$orgAn organization name. Only returns organizations with this name. (optional)
string$org_idAn organization ID. Only returns the organization with this ID. (optional)
string$user_idA user ID. Only returns organizations where this user is a member or owner. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organizations|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getOrgsID()

InfluxDB2\Service\OrganizationsService::getOrgsID (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsID

Retrieve an organization

Parameters
string$org_idThe ID of the organization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organization|\InfluxDB2\Model\Error

◆ getOrgsIDMembers()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembers (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDMembers

List all members of an organization

Parameters
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getOrgsIDMembersRequest()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembersRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsIDMembers'

Parameters
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getOrgsIDMembersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembersWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDMembersWithHttpInfo

List all members of an organization

Parameters
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getOrgsIDOwners()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwners (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDOwners

List all owners of an organization

Parameters
string$org_idThe ID of the organization to list owners for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getOrgsIDOwnersRequest()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwnersRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsIDOwners'

Parameters
string$org_idThe ID of the organization to list owners for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getOrgsIDOwnersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwnersWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDOwnersWithHttpInfo

List all owners of an organization

Parameters
string$org_idThe ID of the organization to list owners for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getOrgsIDRequest()

InfluxDB2\Service\OrganizationsService::getOrgsIDRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsID'

Parameters
string$org_idThe ID of the organization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getOrgsIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDWithHttpInfo

Retrieve an organization

Parameters
string$org_idThe ID of the organization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Organization|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getOrgsRequest()

InfluxDB2\Service\OrganizationsService::getOrgsRequest (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)
protected

Create request for operation 'getOrgs'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetThe offset for pagination. The number of records to skip. (optional)
int$limitLimits the number of records returned. Default is `20`. (optional, default to 20)
bool$descending(optional, default to false)
string$orgAn organization name. Only returns organizations with this name. (optional)
string$org_idAn organization ID. Only returns the organization with this ID. (optional)
string$user_idA user ID. Only returns organizations where this user is a member or owner. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getOrgsWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsWithHttpInfo (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)

Operation getOrgsWithHttpInfo

List organizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetThe offset for pagination. The number of records to skip. (optional)
int$limitLimits the number of records returned. Default is `20`. (optional, default to 20)
bool$descending(optional, default to false)
string$orgAn organization name. Only returns organizations with this name. (optional)
string$org_idAn organization ID. Only returns the organization with this ID. (optional)
string$user_idA user ID. Only returns organizations where this user is a member or owner. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Organizations|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ patchOrgsID()

InfluxDB2\Service\OrganizationsService::patchOrgsID (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)

Operation patchOrgsID

Update an organization

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organization|\InfluxDB2\Model\Error

◆ patchOrgsIDRequest()

InfluxDB2\Service\OrganizationsService::patchOrgsIDRequest (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchOrgsID'

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchOrgsIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::patchOrgsIDWithHttpInfo (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)

Operation patchOrgsIDWithHttpInfo

Update an organization

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Organization|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postOrgs()

InfluxDB2\Service\OrganizationsService::postOrgs (   $post_organization_request,
  $zap_trace_span = null 
)

Operation postOrgs

Create an organization

Parameters
\InfluxDB2\Model\PostOrganizationRequest$post_organization_requestThe organization to create. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organization|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ postOrgsIDMembers()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembers (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDMembers

Add a member to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error

◆ postOrgsIDMembersRequest()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembersRequest (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgsIDMembers'

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postOrgsIDMembersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembersWithHttpInfo (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDMembersWithHttpInfo

Add a member to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postOrgsIDOwners()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwners (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDOwners

Add an owner to an organization

Parameters
string$org_idThe ID of the organization that you want to add an owner for. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyThe user to add as an owner of the organization. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error

◆ postOrgsIDOwnersRequest()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwnersRequest (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgsIDOwners'

Parameters
string$org_idThe ID of the organization that you want to add an owner for. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyThe user to add as an owner of the organization. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postOrgsIDOwnersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwnersWithHttpInfo (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDOwnersWithHttpInfo

Add an owner to an organization

Parameters
string$org_idThe ID of the organization that you want to add an owner for. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyThe user to add as an owner of the organization. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postOrgsRequest()

InfluxDB2\Service\OrganizationsService::postOrgsRequest (   $post_organization_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgs'

Parameters
\InfluxDB2\Model\PostOrganizationRequest$post_organization_requestThe organization to create. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postOrgsWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsWithHttpInfo (   $post_organization_request,
  $zap_trace_span = null 
)

Operation postOrgsWithHttpInfo

Create an organization

Parameters
\InfluxDB2\Model\PostOrganizationRequest$post_organization_requestThe organization to create. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Organization|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

The documentation for this class was generated from the following file: