Public Member Functions
	__construct (DefaultApi $defaultApi)

	deleteUsersID ($user_id, $zap_trace_span=null)

	deleteUsersIDWithHttpInfo ($user_id, $zap_trace_span=null)

	getFlags ($zap_trace_span=null)

	getFlagsWithHttpInfo ($zap_trace_span=null)

	getMe ($zap_trace_span=null)

	getMeWithHttpInfo ($zap_trace_span=null)

	getUsers ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $name=null, $id=null)

	getUsersWithHttpInfo ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $name=null, $id=null)

	getUsersID ($user_id, $zap_trace_span=null)

	getUsersIDWithHttpInfo ($user_id, $zap_trace_span=null)

	patchUsersID ($user_id, $post_user, $zap_trace_span=null)

	patchUsersIDWithHttpInfo ($user_id, $post_user, $zap_trace_span=null)

	postUsers ($post_user, $zap_trace_span=null)

	postUsersWithHttpInfo ($post_user, $zap_trace_span=null)

	postUsersIDPassword ($user_id, $password_reset_body, $zap_trace_span=null, $authorization=null)

	postUsersIDPasswordWithHttpInfo ($user_id, $password_reset_body, $zap_trace_span=null, $authorization=null)

	putMePassword ($password_reset_body, $zap_trace_span=null, $authorization=null)

	putMePasswordWithHttpInfo ($password_reset_body, $zap_trace_span=null, $authorization=null)

Protected Member Functions
	deleteUsersIDRequest ($user_id, $zap_trace_span=null)

	getFlagsRequest ($zap_trace_span=null)

	getMeRequest ($zap_trace_span=null)

	getUsersRequest ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $name=null, $id=null)

	getUsersIDRequest ($user_id, $zap_trace_span=null)

	patchUsersIDRequest ($user_id, $post_user, $zap_trace_span=null)

	postUsersRequest ($post_user, $zap_trace_span=null)

	postUsersIDPasswordRequest ($user_id, $password_reset_body, $zap_trace_span=null, $authorization=null)

	putMePasswordRequest ($password_reset_body, $zap_trace_span=null, $authorization=null)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ deleteUsersID()

InfluxDB2\Service\UsersService::deleteUsersID	(		$user_id,
			$zap_trace_span = null )

Operation deleteUsersID

Delete a user

Parameters

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

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteUsersIDRequest()

InfluxDB2\Service\UsersService::deleteUsersIDRequest	(		$user_id,
			$zap_trace_span = null )

protected

Create request for operation 'deleteUsersID'

Parameters

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

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteUsersIDWithHttpInfo()

InfluxDB2\Service\UsersService::deleteUsersIDWithHttpInfo	(		$user_id,
			$zap_trace_span = null )

Operation deleteUsersIDWithHttpInfo

Delete a user

Parameters

string	$user_id	The ID of the user 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)

◆ getFlags()

InfluxDB2\Service\UsersService::getFlags ( $zap_trace_span = null )

Operation getFlags

Return the feature flags for the currently authenticated user

Parameters

string $zap_trace_span OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: map[string,object]|\InfluxDB2\Model\Error

◆ getFlagsRequest()

InfluxDB2\Service\UsersService::getFlagsRequest ( $zap_trace_span = null )

protected

Create request for operation 'getFlags'

Parameters

string $zap_trace_span OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getFlagsWithHttpInfo()

InfluxDB2\Service\UsersService::getFlagsWithHttpInfo ( $zap_trace_span = null )

Operation getFlagsWithHttpInfo

Return the feature flags for the currently authenticated user

Parameters

string $zap_trace_span OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getMe()

InfluxDB2\Service\UsersService::getMe ( $zap_trace_span = null )

Operation getMe

Retrieve the currently authenticated user

Parameters

string $zap_trace_span OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getMeRequest()

InfluxDB2\Service\UsersService::getMeRequest ( $zap_trace_span = null )

protected

Create request for operation 'getMe'

Parameters

string $zap_trace_span OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getMeWithHttpInfo()

InfluxDB2\Service\UsersService::getMeWithHttpInfo ( $zap_trace_span = null )

Operation getMeWithHttpInfo

Retrieve the currently authenticated user

Parameters

string $zap_trace_span OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getUsers()

InfluxDB2\Service\UsersService::getUsers	(	$zap_trace_span = null,
		$offset = null,
		$limit = 20,
		$after = null,
		$name = null,
		$id = null )

Operation getUsers

List users

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$after	Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
string	$name	name (optional)
string	$id	id (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Users|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getUsersID()

InfluxDB2\Service\UsersService::getUsersID	(		$user_id,
			$zap_trace_span = null )

Operation getUsersID

Retrieve a user

Parameters

string	$user_id	The user ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\User|string

◆ getUsersIDRequest()

InfluxDB2\Service\UsersService::getUsersIDRequest	(		$user_id,
			$zap_trace_span = null )

protected

Create request for operation 'getUsersID'

Parameters

string	$user_id	The user ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getUsersIDWithHttpInfo()

InfluxDB2\Service\UsersService::getUsersIDWithHttpInfo	(		$user_id,
			$zap_trace_span = null )

Operation getUsersIDWithHttpInfo

Retrieve a user

Parameters

string	$user_id	The user ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getUsersRequest()

InfluxDB2\Service\UsersService::getUsersRequest	(	$zap_trace_span = null,
		$offset = null,
		$limit = 20,
		$after = null,
		$name = null,
		$id = null )

protected

Create request for operation 'getUsers'

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$after	Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
string	$name	(optional)
string	$id	(optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getUsersWithHttpInfo()

InfluxDB2\Service\UsersService::getUsersWithHttpInfo	(	$zap_trace_span = null,
		$offset = null,
		$limit = 20,
		$after = null,
		$name = null,
		$id = null )

Operation getUsersWithHttpInfo

List users

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$after	Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
string	$name	(optional)
string	$id	(optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchUsersID()

InfluxDB2\Service\UsersService::patchUsersID	(	$user_id,
		$post_user,
		$zap_trace_span = null )

Operation patchUsersID

Update a user

Parameters

string	$user_id	The ID of the user to update. (required)
\InfluxDB2\Model\PostUser	$post_user	User update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\User|string

◆ patchUsersIDRequest()

InfluxDB2\Service\UsersService::patchUsersIDRequest	(	$user_id,
		$post_user,
		$zap_trace_span = null )

protected

Create request for operation 'patchUsersID'

Parameters

string	$user_id	The ID of the user to update. (required)
\InfluxDB2\Model\PostUser	$post_user	User update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ patchUsersIDWithHttpInfo()

InfluxDB2\Service\UsersService::patchUsersIDWithHttpInfo	(	$user_id,
		$post_user,
		$zap_trace_span = null )

Operation patchUsersIDWithHttpInfo

Update a user

Parameters

string	$user_id	The ID of the user to update. (required)
\InfluxDB2\Model\PostUser	$post_user	User update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postUsers()

InfluxDB2\Service\UsersService::postUsers	(		$post_user,
			$zap_trace_span = null )

Operation postUsers

Create a user

Parameters

\InfluxDB2\Model\PostUser	$post_user	The user to create. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\User|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ postUsersIDPassword()

InfluxDB2\Service\UsersService::postUsersIDPassword	(	$user_id,
		$password_reset_body,
		$zap_trace_span = null,
		$authorization = null )

Operation postUsersIDPassword

Update a password

Parameters

string	$user_id	The user ID. (required)
\InfluxDB2\Model\PasswordResetBody	$password_reset_body	New password (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$authorization	An auth credential for the Basic scheme (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ postUsersIDPasswordRequest()

InfluxDB2\Service\UsersService::postUsersIDPasswordRequest	(	$user_id,
		$password_reset_body,
		$zap_trace_span = null,
		$authorization = null )

protected

Create request for operation 'postUsersIDPassword'

Parameters

string	$user_id	The user ID. (required)
\InfluxDB2\Model\PasswordResetBody	$password_reset_body	New password (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$authorization	An auth credential for the Basic scheme (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postUsersIDPasswordWithHttpInfo()

InfluxDB2\Service\UsersService::postUsersIDPasswordWithHttpInfo	(	$user_id,
		$password_reset_body,
		$zap_trace_span = null,
		$authorization = null )

Operation postUsersIDPasswordWithHttpInfo

Update a password

Parameters

string	$user_id	The user ID. (required)
\InfluxDB2\Model\PasswordResetBody	$password_reset_body	New password (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$authorization	An auth credential for the Basic scheme (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postUsersRequest()

InfluxDB2\Service\UsersService::postUsersRequest	(		$post_user,
			$zap_trace_span = null )

protected

Create request for operation 'postUsers'

Parameters

\InfluxDB2\Model\PostUser	$post_user	The user to create. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postUsersWithHttpInfo()

InfluxDB2\Service\UsersService::postUsersWithHttpInfo	(		$post_user,
			$zap_trace_span = null )

Operation postUsersWithHttpInfo

Create a user

Parameters

\InfluxDB2\Model\PostUser	$post_user	The user 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\User|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ putMePassword()

InfluxDB2\Service\UsersService::putMePassword	(	$password_reset_body,
		$zap_trace_span = null,
		$authorization = null )

Operation putMePassword

Update a password

Parameters

\InfluxDB2\Model\PasswordResetBody	$password_reset_body	The new password. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$authorization	An auth credential for the Basic scheme (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ putMePasswordRequest()

InfluxDB2\Service\UsersService::putMePasswordRequest	(	$password_reset_body,
		$zap_trace_span = null,
		$authorization = null )

protected

Create request for operation 'putMePassword'

Parameters

\InfluxDB2\Model\PasswordResetBody	$password_reset_body	The new password. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$authorization	An auth credential for the Basic scheme (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ putMePasswordWithHttpInfo()

InfluxDB2\Service\UsersService::putMePasswordWithHttpInfo	(	$password_reset_body,
		$zap_trace_span = null,
		$authorization = null )

Operation putMePasswordWithHttpInfo

Update a password

Parameters

\InfluxDB2\Model\PasswordResetBody	$password_reset_body	The new password. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$authorization	An auth credential for the Basic scheme (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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

src/InfluxDB2/Service/UsersService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteUsersID()

◆ deleteUsersIDRequest()

◆ deleteUsersIDWithHttpInfo()

◆ getFlags()

◆ getFlagsRequest()

◆ getFlagsWithHttpInfo()

◆ getMe()

◆ getMeRequest()

◆ getMeWithHttpInfo()

◆ getUsers()

◆ getUsersID()

◆ getUsersIDRequest()

◆ getUsersIDWithHttpInfo()

◆ getUsersRequest()

◆ getUsersWithHttpInfo()

◆ patchUsersID()

◆ patchUsersIDRequest()

◆ patchUsersIDWithHttpInfo()

◆ postUsers()

◆ postUsersIDPassword()

◆ postUsersIDPasswordRequest()

◆ postUsersIDPasswordWithHttpInfo()

◆ postUsersRequest()

◆ postUsersWithHttpInfo()

◆ putMePassword()

◆ putMePasswordRequest()

◆ putMePasswordWithHttpInfo()