Public Member Functions
	__construct (DefaultApi $defaultApi)

	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)

	deleteOrgsIDSecretsID ($org_id, $secret_id, $zap_trace_span=null)

	deleteOrgsIDSecretsIDWithHttpInfo ($org_id, $secret_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)

	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)

	getOrgsIDSecrets ($org_id, $zap_trace_span=null)

	getOrgsIDSecretsWithHttpInfo ($org_id, $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)

	postOrgsIDSecrets ($org_id, $secret_keys, $zap_trace_span=null)

	postOrgsIDSecretsWithHttpInfo ($org_id, $secret_keys, $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)

Protected Member Functions
	deleteOrgsIDMembersIDRequest ($user_id, $org_id, $zap_trace_span=null)

	deleteOrgsIDOwnersIDRequest ($user_id, $org_id, $zap_trace_span=null)

	deleteOrgsIDSecretsIDRequest ($org_id, $secret_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)

	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)

	getOrgsIDSecretsRequest ($org_id, $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)

	postOrgsIDSecretsRequest ($org_id, $secret_keys, $zap_trace_span=null)

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

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ deleteOrgsIDMembersID()

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

Operation deleteOrgsIDMembersID

Remove a member from an organization

Parameters

string	$user_id	The ID of the member to remove. (required)
string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteOrgsIDMembersIDRequest()

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

protected

Create request for operation 'deleteOrgsIDMembersID'

Parameters

string	$user_id	The ID of the member to remove. (required)
string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteOrgsIDMembersIDWithHttpInfo()

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

Operation deleteOrgsIDMembersIDWithHttpInfo

Remove a member from an organization

Parameters

string	$user_id	The ID of the member to remove. (required)
string	$org_id	The organization ID. (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)

◆ deleteOrgsIDOwnersID()

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

Operation deleteOrgsIDOwnersID

Remove an owner from an organization

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteOrgsIDOwnersIDRequest()

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

protected

Create request for operation 'deleteOrgsIDOwnersID'

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteOrgsIDOwnersIDWithHttpInfo()

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

Operation deleteOrgsIDOwnersIDWithHttpInfo

Remove an owner from an organization

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$org_id	The organization ID. (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)

◆ deleteOrgsIDSecretsID()

InfluxDB2\Service\SecurityAndAccessEndpointsService::deleteOrgsIDSecretsID	(	$org_id,
		$secret_id,
		$zap_trace_span = null )

Operation deleteOrgsIDSecretsID

Delete a secret from an organization

Parameters

string	$org_id	The organization ID. (required)
string	$secret_id	The secret ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteOrgsIDSecretsIDRequest()

InfluxDB2\Service\SecurityAndAccessEndpointsService::deleteOrgsIDSecretsIDRequest	(	$org_id,
		$secret_id,
		$zap_trace_span = null )

protected

Create request for operation 'deleteOrgsIDSecretsID'

Parameters

string	$org_id	The organization ID. (required)
string	$secret_id	The secret ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteOrgsIDSecretsIDWithHttpInfo()

InfluxDB2\Service\SecurityAndAccessEndpointsService::deleteOrgsIDSecretsIDWithHttpInfo	(	$org_id,
		$secret_id,
		$zap_trace_span = null )

Operation deleteOrgsIDSecretsIDWithHttpInfo

Delete a secret from an organization

Parameters

string	$org_id	The organization ID. (required)
string	$secret_id	The secret ID. (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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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)

◆ getOrgs()

InfluxDB2\Service\SecurityAndAccessEndpointsService::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_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)
bool	$descending	descending (optional, default to false)
string	$org	An organization name. Only returns organizations with this name. (optional)
string	$org_id	An organization ID. Only returns the organization with this ID. (optional)
string	$user_id	A 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\SecurityAndAccessEndpointsService::getOrgsID	(		$org_id,
			$zap_trace_span = null )

Operation getOrgsID

Retrieve an organization

Parameters

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

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getOrgsIDMembers()

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

Operation getOrgsIDMembers

List all members of an organization

Parameters

string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing 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\SecurityAndAccessEndpointsService::getOrgsIDMembersRequest	(		$org_id,
			$zap_trace_span = null )

protected

Create request for operation 'getOrgsIDMembers'

Parameters

string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getOrgsIDMembersWithHttpInfo()

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

Operation getOrgsIDMembersWithHttpInfo

List all members of an organization

Parameters

string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing 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\SecurityAndAccessEndpointsService::getOrgsIDOwners	(		$org_id,
			$zap_trace_span = null )

Operation getOrgsIDOwners

List all owners of an organization

Parameters

string	$org_id	The ID of the organization to list owners for. (required)
string	$zap_trace_span	OpenTracing 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\SecurityAndAccessEndpointsService::getOrgsIDOwnersRequest	(		$org_id,
			$zap_trace_span = null )

protected

Create request for operation 'getOrgsIDOwners'

Parameters

string	$org_id	The ID of the organization to list owners for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getOrgsIDOwnersWithHttpInfo()

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

Operation getOrgsIDOwnersWithHttpInfo

List all owners of an organization

Parameters

string	$org_id	The ID of the organization to list owners for. (required)
string	$zap_trace_span	OpenTracing 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\SecurityAndAccessEndpointsService::getOrgsIDRequest	(		$org_id,
			$zap_trace_span = null )

protected

Create request for operation 'getOrgsID'

Parameters

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

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getOrgsIDSecrets()

InfluxDB2\Service\SecurityAndAccessEndpointsService::getOrgsIDSecrets	(		$org_id,
			$zap_trace_span = null )

Operation getOrgsIDSecrets

List all secret keys for an organization

Parameters

string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\SecretKeysResponse|\InfluxDB2\Model\Error

◆ getOrgsIDSecretsRequest()

InfluxDB2\Service\SecurityAndAccessEndpointsService::getOrgsIDSecretsRequest	(		$org_id,
			$zap_trace_span = null )

protected

Create request for operation 'getOrgsIDSecrets'

Parameters

string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getOrgsIDSecretsWithHttpInfo()

InfluxDB2\Service\SecurityAndAccessEndpointsService::getOrgsIDSecretsWithHttpInfo	(		$org_id,
			$zap_trace_span = null )

Operation getOrgsIDSecretsWithHttpInfo

List all secret keys for an organization

Parameters

string	$org_id	The organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getOrgsIDWithHttpInfo()

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

Operation getOrgsIDWithHttpInfo

Retrieve an organization

Parameters

string	$org_id	The ID of the organization 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\Organization|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getOrgsRequest()

InfluxDB2\Service\SecurityAndAccessEndpointsService::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_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)
bool	$descending	(optional, default to false)
string	$org	An organization name. Only returns organizations with this name. (optional)
string	$org_id	An organization ID. Only returns the organization with this ID. (optional)
string	$user_id	A user ID. Only returns organizations where this user is a member or owner. (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getOrgsWithHttpInfo()

InfluxDB2\Service\SecurityAndAccessEndpointsService::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_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)
bool	$descending	(optional, default to false)
string	$org	An organization name. Only returns organizations with this name. (optional)
string	$org_id	An organization ID. Only returns the organization with this ID. (optional)
string	$user_id	A 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)

◆ getUsers()

InfluxDB2\Service\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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)

◆ postOrgsIDSecrets()

InfluxDB2\Service\SecurityAndAccessEndpointsService::postOrgsIDSecrets	(	$org_id,
		$secret_keys,
		$zap_trace_span = null )

Operation postOrgsIDSecrets

Delete secrets from an organization

Parameters

string	$org_id	The organization ID. (required)
\InfluxDB2\Model\SecretKeys	$secret_keys	Secret key to delete (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ postOrgsIDSecretsRequest()

InfluxDB2\Service\SecurityAndAccessEndpointsService::postOrgsIDSecretsRequest	(	$org_id,
		$secret_keys,
		$zap_trace_span = null )

protected

Create request for operation 'postOrgsIDSecrets'

Parameters

string	$org_id	The organization ID. (required)
\InfluxDB2\Model\SecretKeys	$secret_keys	Secret key to delete (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postOrgsIDSecretsWithHttpInfo()

InfluxDB2\Service\SecurityAndAccessEndpointsService::postOrgsIDSecretsWithHttpInfo	(	$org_id,
		$secret_keys,
		$zap_trace_span = null )

Operation postOrgsIDSecretsWithHttpInfo

Delete secrets from an organization

Parameters

string	$org_id	The organization ID. (required)
\InfluxDB2\Model\SecretKeys	$secret_keys	Secret key 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)

◆ postUsersIDPassword()

InfluxDB2\Service\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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\SecurityAndAccessEndpointsService::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)

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

src/InfluxDB2/Service/SecurityAndAccessEndpointsService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteOrgsIDMembersID()

◆ deleteOrgsIDMembersIDRequest()

◆ deleteOrgsIDMembersIDWithHttpInfo()

◆ deleteOrgsIDOwnersID()

◆ deleteOrgsIDOwnersIDRequest()

◆ deleteOrgsIDOwnersIDWithHttpInfo()

◆ deleteOrgsIDSecretsID()

◆ deleteOrgsIDSecretsIDRequest()

◆ deleteOrgsIDSecretsIDWithHttpInfo()

◆ getAuthorizations()

◆ getAuthorizationsID()

◆ getAuthorizationsIDRequest()

◆ getAuthorizationsIDWithHttpInfo()

◆ getAuthorizationsRequest()

◆ getAuthorizationsWithHttpInfo()

◆ getOrgs()

◆ getOrgsID()

◆ getOrgsIDMembers()

◆ getOrgsIDMembersRequest()

◆ getOrgsIDMembersWithHttpInfo()

◆ getOrgsIDOwners()

◆ getOrgsIDOwnersRequest()

◆ getOrgsIDOwnersWithHttpInfo()

◆ getOrgsIDRequest()

◆ getOrgsIDSecrets()

◆ getOrgsIDSecretsRequest()

◆ getOrgsIDSecretsWithHttpInfo()

◆ getOrgsIDWithHttpInfo()

◆ getOrgsRequest()

◆ getOrgsWithHttpInfo()

◆ getUsers()

◆ getUsersID()

◆ getUsersIDRequest()

◆ getUsersIDWithHttpInfo()

◆ getUsersRequest()

◆ getUsersWithHttpInfo()

◆ postOrgsIDSecrets()

◆ postOrgsIDSecretsRequest()

◆ postOrgsIDSecretsWithHttpInfo()

◆ postUsersIDPassword()

◆ postUsersIDPasswordRequest()

◆ postUsersIDPasswordWithHttpInfo()