UsersAPI Class Reference


                    
                    
                    init(influxDB2API:)

Declaration

Swift

public init(influxDB2API: InfluxDB2API)


                    
                    
                    deleteUsersID(userID:zapTraceSpan:apiResponseQueue:completion:)

Delete a user

Declaration

Swift

public func deleteUsersID(userID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`userID`	(path) The ID of the user to delete.
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    deleteUsersID(userID:zapTraceSpan:apiResponseQueue:)

Asynchronous

Delete a user

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func deleteUsersID(userID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

Parameters

`userID`	(path) The ID of the user to delete.
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getFlags(zapTraceSpan:apiResponseQueue:completion:)

Return the feature flags for the currently authenticated user

Declaration

Swift

public func getFlags(zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: [String : Any]?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getFlags(zapTraceSpan:apiResponseQueue:)

Asynchronous

Return the feature flags for the currently authenticated user

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getFlags(zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> [String : Any]?

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getMe(zapTraceSpan:apiResponseQueue:completion:)

Retrieve the currently authenticated user

Declaration

Swift

public func getMe(zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: UserResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getMe(zapTraceSpan:apiResponseQueue:)

Asynchronous

Retrieve the currently authenticated user

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getMe(zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> UserResponse?

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getUsers(zapTraceSpan:offset:limit:after:name:id:apiResponseQueue:completion:)

List all users

Declaration

Swift

public func getUsers(zapTraceSpan: String? = nil, offset: Int? = nil, limit: Int? = nil, after: String? = nil, name: String? = nil, id: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Users?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`offset`	(query) (optional)
`limit`	(query) (optional, default to 20)
`after`	(query) Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
`name`	(query) (optional)
`id`	(query) (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getUsers(zapTraceSpan:offset:limit:after:name:id:apiResponseQueue:)

Asynchronous

List all users

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getUsers(zapTraceSpan: String? = nil, offset: Int? = nil, limit: Int? = nil, after: String? = nil, name: String? = nil, id: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Users?

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`offset`	(query) (optional)
`limit`	(query) (optional, default to 20)
`after`	(query) Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
`name`	(query) (optional)
`id`	(query) (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getUsersID(userID:zapTraceSpan:apiResponseQueue:completion:)

Retrieve a user

Declaration

Swift

public func getUsersID(userID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: UserResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`userID`	(path) The user ID.
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getUsersID(userID:zapTraceSpan:apiResponseQueue:)

Asynchronous

Retrieve a user

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getUsersID(userID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> UserResponse?

Parameters

`userID`	(path) The user ID.
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    patchUsersID(userID:user:zapTraceSpan:apiResponseQueue:completion:)

Update a user

Declaration

Swift

public func patchUsersID(userID: String, user: User, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: UserResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`userID`	(path) The ID of the user to update.
`user`	(body) User update to apply
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    patchUsersID(userID:user:zapTraceSpan:apiResponseQueue:)

Asynchronous

Update a user

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func patchUsersID(userID: String, user: User, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> UserResponse?

Parameters

`userID`	(path) The ID of the user to update.
`user`	(body) User update to apply
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    postUsers(user:zapTraceSpan:apiResponseQueue:completion:)

Create a user

Declaration

Swift

public func postUsers(user: User, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: UserResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`user`	(body) User to create
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    postUsers(user:zapTraceSpan:apiResponseQueue:)

Asynchronous

Create a user

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postUsers(user: User, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> UserResponse?

Parameters

`user`	(body) User to create
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    postUsersIDPassword(userID:passwordResetBody:zapTraceSpan:apiResponseQueue:completion:)

Update a password

Declaration

Swift

public func postUsersIDPassword(userID: String, passwordResetBody: PasswordResetBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`userID`	(path) The user ID.
`passwordResetBody`	(body) New password
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    postUsersIDPassword(userID:passwordResetBody:zapTraceSpan:apiResponseQueue:)

Asynchronous

Update a password

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postUsersIDPassword(userID: String, passwordResetBody: PasswordResetBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

Parameters

`userID`	(path) The user ID.
`passwordResetBody`	(body) New password
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    putMePassword(passwordResetBody:zapTraceSpan:apiResponseQueue:completion:)

Update a password

Declaration

Swift

public func putMePassword(passwordResetBody: PasswordResetBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`passwordResetBody`	(body) New password
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    putMePassword(passwordResetBody:zapTraceSpan:apiResponseQueue:)

Asynchronous

Update a password

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func putMePassword(passwordResetBody: PasswordResetBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

Parameters

`passwordResetBody`	(body) New password
`zapTraceSpan`	(header) OpenTracing span context (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects