InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\UsersService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteUsersID ($user_id, $zap_trace_span=null)
 
 deleteUsersIDWithHttpInfo ($user_id, $zap_trace_span=null)
 
 deleteUsersIDAsync ($user_id, $zap_trace_span=null)
 
 deleteUsersIDAsyncWithHttpInfo ($user_id, $zap_trace_span=null)
 
 getFlags ($zap_trace_span=null)
 
 getFlagsWithHttpInfo ($zap_trace_span=null)
 
 getFlagsAsync ($zap_trace_span=null)
 
 getFlagsAsyncWithHttpInfo ($zap_trace_span=null)
 
 getMe ($zap_trace_span=null)
 
 getMeWithHttpInfo ($zap_trace_span=null)
 
 getMeAsync ($zap_trace_span=null)
 
 getMeAsyncWithHttpInfo ($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)
 
 getUsersAsync ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $name=null, $id=null)
 
 getUsersAsyncWithHttpInfo ($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)
 
 getUsersIDAsync ($user_id, $zap_trace_span=null)
 
 getUsersIDAsyncWithHttpInfo ($user_id, $zap_trace_span=null)
 
 patchUsersID ($user_id, $post_user, $zap_trace_span=null)
 
 patchUsersIDWithHttpInfo ($user_id, $post_user, $zap_trace_span=null)
 
 patchUsersIDAsync ($user_id, $post_user, $zap_trace_span=null)
 
 patchUsersIDAsyncWithHttpInfo ($user_id, $post_user, $zap_trace_span=null)
 
 postUsers ($post_user, $zap_trace_span=null)
 
 postUsersWithHttpInfo ($post_user, $zap_trace_span=null)
 
 postUsersAsync ($post_user, $zap_trace_span=null)
 
 postUsersAsyncWithHttpInfo ($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)
 
 postUsersIDPasswordAsync ($user_id, $password_reset_body, $zap_trace_span=null, $authorization=null)
 
 postUsersIDPasswordAsyncWithHttpInfo ($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)
 
 putMePasswordAsync ($password_reset_body, $zap_trace_span=null, $authorization=null)
 
 putMePasswordAsyncWithHttpInfo ($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)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\UsersService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\UsersService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteUsersID()

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

Operation deleteUsersID

Delete a user

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteUsersIDAsync()

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

Operation deleteUsersIDAsync

Delete a user

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteUsersIDAsyncWithHttpInfo()

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

Operation deleteUsersIDAsyncWithHttpInfo

Delete a user

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteUsersIDRequest()

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

Create request for operation 'deleteUsersID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteUsersIDWithHttpInfo()

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

Operation deleteUsersIDWithHttpInfo

Delete a user

Parameters
string$user_idThe ID of the user 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)

◆ getConfig()

InfluxDB2\Service\UsersService::getConfig ( )
Returns
Configuration

◆ getFlags()

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

Operation getFlags

Return the feature flags for the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getFlagsAsync()

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

Operation getFlagsAsync

Return the feature flags for the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getFlagsAsyncWithHttpInfo()

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

Operation getFlagsAsyncWithHttpInfo

Return the feature flags for the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getFlagsRequest()

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

Create request for operation 'getFlags'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getFlagsWithHttpInfo()

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

Operation getFlagsWithHttpInfo

Return the feature flags for the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing 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_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\User|\InfluxDB2\Model\Error

◆ getMeAsync()

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

Operation getMeAsync

Retrieve the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getMeAsyncWithHttpInfo()

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

Operation getMeAsyncWithHttpInfo

Retrieve the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getMeRequest()

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

Create request for operation 'getMe'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getMeWithHttpInfo()

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

Operation getMeWithHttpInfo

Retrieve the currently authenticated user

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\User|\InfluxDB2\Model\Error, 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 all users

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetoffset (optional)
int$limitlimit (optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$namename (optional)
string$idid (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Users|\InfluxDB2\Model\Error

◆ getUsersAsync()

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

Operation getUsersAsync

List all users

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$name(optional)
string$id(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getUsersAsyncWithHttpInfo()

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

Operation getUsersAsyncWithHttpInfo

List all users

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$name(optional)
string$id(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getUsersID()

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

Operation getUsersID

Retrieve a user

Parameters
string$user_idThe user ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\User|\InfluxDB2\Model\Error

◆ getUsersIDAsync()

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

Operation getUsersIDAsync

Retrieve a user

Parameters
string$user_idThe user ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getUsersIDAsyncWithHttpInfo()

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

Operation getUsersIDAsyncWithHttpInfo

Retrieve a user

Parameters
string$user_idThe user ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getUsersIDRequest()

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

Create request for operation 'getUsersID'

Parameters
string$user_idThe user ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getUsersIDWithHttpInfo()

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

Operation getUsersIDWithHttpInfo

Retrieve a user

Parameters
string$user_idThe user ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\User|\InfluxDB2\Model\Error, 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_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$name(optional)
string$id(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getUsersWithHttpInfo()

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

Operation getUsersWithHttpInfo

List all users

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used 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, 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_idThe ID of the user to update. (required)
\InfluxDB2\Model\PostUser$post_userUser update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\User|\InfluxDB2\Model\Error

◆ patchUsersIDAsync()

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

Operation patchUsersIDAsync

Update a user

Parameters
string$user_idThe ID of the user to update. (required)
\InfluxDB2\Model\PostUser$post_userUser update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchUsersIDAsyncWithHttpInfo()

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

Operation patchUsersIDAsyncWithHttpInfo

Update a user

Parameters
string$user_idThe ID of the user to update. (required)
\InfluxDB2\Model\PostUser$post_userUser update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchUsersIDRequest()

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

Create request for operation 'patchUsersID'

Parameters
string$user_idThe ID of the user to update. (required)
\InfluxDB2\Model\PostUser$post_userUser update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchUsersIDWithHttpInfo()

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

Operation patchUsersIDWithHttpInfo

Update a user

Parameters
string$user_idThe ID of the user to update. (required)
\InfluxDB2\Model\PostUser$post_userUser 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\User|\InfluxDB2\Model\Error, 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_userUser to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\User|\InfluxDB2\Model\Error

◆ postUsersAsync()

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

Operation postUsersAsync

Create a user

Parameters
\InfluxDB2\Model\PostUser$post_userUser to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postUsersAsyncWithHttpInfo()

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

Operation postUsersAsyncWithHttpInfo

Create a user

Parameters
\InfluxDB2\Model\PostUser$post_userUser to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postUsersIDPassword()

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

Operation postUsersIDPassword

Update a password

Parameters
string$user_idThe user ID. (required)
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postUsersIDPasswordAsync()

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

Operation postUsersIDPasswordAsync

Update a password

Parameters
string$user_idThe user ID. (required)
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postUsersIDPasswordAsyncWithHttpInfo()

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

Operation postUsersIDPasswordAsyncWithHttpInfo

Update a password

Parameters
string$user_idThe user ID. (required)
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_idThe user ID. (required)
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postUsersIDPasswordWithHttpInfo()

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

Operation postUsersIDPasswordWithHttpInfo

Update a password

Parameters
string$user_idThe user ID. (required)
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn 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_userUser to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postUsersWithHttpInfo()

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

Operation postUsersWithHttpInfo

Create a user

Parameters
\InfluxDB2\Model\PostUser$post_userUser to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\User|\InfluxDB2\Model\Error, 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_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ putMePasswordAsync()

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

Operation putMePasswordAsync

Update a password

Parameters
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putMePasswordAsyncWithHttpInfo()

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

Operation putMePasswordAsyncWithHttpInfo

Update a password

Parameters
\InfluxDB2\Model\PasswordResetBody$password_reset_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_bodyNew password (required)
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn 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: