Public Member Functions
	__construct (DefaultApi $defaultApi)

	deleteAuthorizationsID ($auth_id, $zap_trace_span=null)

	deleteAuthorizationsIDWithHttpInfo ($auth_id, $zap_trace_span=null)

	getAuthorizations ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)

	getAuthorizationsWithHttpInfo ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)

	getAuthorizationsID ($auth_id, $zap_trace_span=null)

	getAuthorizationsIDWithHttpInfo ($auth_id, $zap_trace_span=null)

	patchAuthorizationsID ($auth_id, $authorization_update_request, $zap_trace_span=null)

	patchAuthorizationsIDWithHttpInfo ($auth_id, $authorization_update_request, $zap_trace_span=null)

	postAuthorizations ($authorization_post_request, $zap_trace_span=null)

	postAuthorizationsWithHttpInfo ($authorization_post_request, $zap_trace_span=null)

Protected Member Functions
	deleteAuthorizationsIDRequest ($auth_id, $zap_trace_span=null)

	getAuthorizationsRequest ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)

	getAuthorizationsIDRequest ($auth_id, $zap_trace_span=null)

	patchAuthorizationsIDRequest ($auth_id, $authorization_update_request, $zap_trace_span=null)

	postAuthorizationsRequest ($authorization_post_request, $zap_trace_span=null)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\AuthorizationsService::__construct ( DefaultApi $defaultApi )

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ deleteAuthorizationsID()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsID	(		$auth_id,
			$zap_trace_span = null )

Operation deleteAuthorizationsID

Delete an authorization

Parameters

string	$auth_id	The ID of the authorization to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteAuthorizationsIDRequest()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsIDRequest	(		$auth_id,
			$zap_trace_span = null )

protected

Create request for operation 'deleteAuthorizationsID'

Parameters

string	$auth_id	The ID of the authorization to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteAuthorizationsIDWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsIDWithHttpInfo	(		$auth_id,
			$zap_trace_span = null )

Operation deleteAuthorizationsIDWithHttpInfo

Delete an authorization

Parameters

string	$auth_id	The ID of the authorization to delete. (required)
string	$zap_trace_span	OpenTracing 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)

◆ getAuthorizations()

InfluxDB2\Service\AuthorizationsService::getAuthorizations	(	$zap_trace_span = null,
		$user_id = null,
		$user = null,
		$org_id = null,
		$org = null )

Operation getAuthorizations

List authorizations

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$user_id	A user ID. Only returns authorizations scoped to this user. (optional)
string	$user	A user name. Only returns authorizations scoped to this user. (optional)
string	$org_id	An organization ID. Only returns authorizations that belong to this organization. (optional)
string	$org	An organization name. Only returns authorizations that belong to this organization. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Authorizations|string|object|\InfluxDB2\Model\Error|string

◆ getAuthorizationsID()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsID	(		$auth_id,
			$zap_trace_span = null )

Operation getAuthorizationsID

Retrieve an authorization

Parameters

string	$auth_id	The ID of the authorization to get. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Authorization|string

◆ getAuthorizationsIDRequest()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsIDRequest	(		$auth_id,
			$zap_trace_span = null )

protected

Create request for operation 'getAuthorizationsID'

Parameters

string	$auth_id	The ID of the authorization to get. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getAuthorizationsIDWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsIDWithHttpInfo	(		$auth_id,
			$zap_trace_span = null )

Operation getAuthorizationsIDWithHttpInfo

Retrieve an authorization

Parameters

string	$auth_id	The ID of the authorization to get. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Authorization|string, HTTP status code, HTTP response headers (array of strings)

◆ getAuthorizationsRequest()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsRequest	(	$zap_trace_span = null,
		$user_id = null,
		$user = null,
		$org_id = null,
		$org = null )

protected

Create request for operation 'getAuthorizations'

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$user_id	A user ID. Only returns authorizations scoped to this user. (optional)
string	$user	A user name. Only returns authorizations scoped to this user. (optional)
string	$org_id	An organization ID. Only returns authorizations that belong to this organization. (optional)
string	$org	An organization name. Only returns authorizations that belong to this organization. (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getAuthorizationsWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsWithHttpInfo	(	$zap_trace_span = null,
		$user_id = null,
		$user = null,
		$org_id = null,
		$org = null )

Operation getAuthorizationsWithHttpInfo

List authorizations

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$user_id	A user ID. Only returns authorizations scoped to this user. (optional)
string	$user	A user name. Only returns authorizations scoped to this user. (optional)
string	$org_id	An organization ID. Only returns authorizations that belong to this organization. (optional)
string	$org	An organization name. Only returns authorizations that belong to this organization. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchAuthorizationsID()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsID	(	$auth_id,
		$authorization_update_request,
		$zap_trace_span = null )

Operation patchAuthorizationsID

Update an authorization to be active or inactive

Parameters

string	$auth_id	The ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest	$authorization_update_request	Authorization to update (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Authorization|string

◆ patchAuthorizationsIDRequest()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsIDRequest	(	$auth_id,
		$authorization_update_request,
		$zap_trace_span = null )

protected

Create request for operation 'patchAuthorizationsID'

Parameters

string	$auth_id	The ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest	$authorization_update_request	Authorization to update (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ patchAuthorizationsIDWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsIDWithHttpInfo	(	$auth_id,
		$authorization_update_request,
		$zap_trace_span = null )

Operation patchAuthorizationsIDWithHttpInfo

Update an authorization to be active or inactive

Parameters

string	$auth_id	The ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest	$authorization_update_request	Authorization to update (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Authorization|string, HTTP status code, HTTP response headers (array of strings)

◆ postAuthorizations()

InfluxDB2\Service\AuthorizationsService::postAuthorizations	(		$authorization_post_request,
			$zap_trace_span = null )

Operation postAuthorizations

Create an authorization

Parameters

\InfluxDB2\Model\AuthorizationPostRequest	$authorization_post_request	The authorization to create. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Authorization|string|object|\InfluxDB2\Model\Error|string

◆ postAuthorizationsRequest()

InfluxDB2\Service\AuthorizationsService::postAuthorizationsRequest	(		$authorization_post_request,
			$zap_trace_span = null )

protected

Create request for operation 'postAuthorizations'

Parameters

\InfluxDB2\Model\AuthorizationPostRequest	$authorization_post_request	The authorization to create. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postAuthorizationsWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::postAuthorizationsWithHttpInfo	(		$authorization_post_request,
			$zap_trace_span = null )

Operation postAuthorizationsWithHttpInfo

Create an authorization

Parameters

\InfluxDB2\Model\AuthorizationPostRequest	$authorization_post_request	The authorization to create. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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

src/InfluxDB2/Service/AuthorizationsService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteAuthorizationsID()

◆ deleteAuthorizationsIDRequest()

◆ deleteAuthorizationsIDWithHttpInfo()

◆ getAuthorizations()

◆ getAuthorizationsID()

◆ getAuthorizationsIDRequest()

◆ getAuthorizationsIDWithHttpInfo()

◆ getAuthorizationsRequest()

◆ getAuthorizationsWithHttpInfo()

◆ patchAuthorizationsID()

◆ patchAuthorizationsIDRequest()

◆ patchAuthorizationsIDWithHttpInfo()

◆ postAuthorizations()

◆ postAuthorizationsRequest()

◆ postAuthorizationsWithHttpInfo()