AuthorizationsAPI Class Reference


                    
                    
                    init(influxDB2API:)

Declaration

Swift

public init(influxDB2API: InfluxDB2API)


                    
                    
                    deleteAuthorizationsID(authID:zapTraceSpan:apiResponseQueue:completion:)

Delete an authorization

Declaration

Swift

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

Parameters

`authID`	(path) The ID of the authorization 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


                    
                    
                    deleteAuthorizationsID(authID:zapTraceSpan:apiResponseQueue:)

Asynchronous

Delete an authorization

Declaration

Swift

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

Parameters

`authID`	(path) The ID of the authorization 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


                    
                    
                    getAuthorizations(zapTraceSpan:userID:user:orgID:org:apiResponseQueue:completion:)

List all authorizations

Declaration

Swift

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

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`userID`	(query) Only show authorizations that belong to a user ID. (optional)
`user`	(query) Only show authorizations that belong to a user name. (optional)
`orgID`	(query) Only show authorizations that belong to an organization ID. (optional)
`org`	(query) Only show authorizations that belong to a organization name. (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getAuthorizations(zapTraceSpan:userID:user:orgID:org:apiResponseQueue:)

Asynchronous

List all authorizations

Declaration

Swift

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

Parameters

`zapTraceSpan`	(header) OpenTracing span context (optional)
`userID`	(query) Only show authorizations that belong to a user ID. (optional)
`user`	(query) Only show authorizations that belong to a user name. (optional)
`orgID`	(query) Only show authorizations that belong to an organization ID. (optional)
`org`	(query) Only show authorizations that belong to a organization name. (optional)
`apiResponseQueue`	The queue on which api response is dispatched.
`completion`	completion handler to receive the data and the error objects


                    
                    
                    getAuthorizationsID(authID:zapTraceSpan:apiResponseQueue:completion:)

Retrieve an authorization

Declaration

Swift

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

Parameters

`authID`	(path) The ID of the authorization to get.
`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


                    
                    
                    getAuthorizationsID(authID:zapTraceSpan:apiResponseQueue:)

Asynchronous

Retrieve an authorization

Declaration

Swift

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

Parameters

`authID`	(path) The ID of the authorization to get.
`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


                    
                    
                    patchAuthorizationsID(authID:authorizationUpdateRequest:zapTraceSpan:apiResponseQueue:completion:)

Update an authorization to be active or inactive

Declaration

Swift

public func patchAuthorizationsID(authID: String, authorizationUpdateRequest: AuthorizationUpdateRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Authorization?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

Parameters

`authID`	(path) The ID of the authorization to update.
`authorizationUpdateRequest`	(body) Authorization to update
`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


                    
                    
                    patchAuthorizationsID(authID:authorizationUpdateRequest:zapTraceSpan:apiResponseQueue:)

Asynchronous

Update an authorization to be active or inactive

Declaration

Swift

@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func patchAuthorizationsID(authID: String, authorizationUpdateRequest: AuthorizationUpdateRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Authorization?

Parameters

`authID`	(path) The ID of the authorization to update.
`authorizationUpdateRequest`	(body) Authorization to update
`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


                    
                    
                    postAuthorizations(authorizationPostRequest:zapTraceSpan:apiResponseQueue:completion:)

Create an authorization

Declaration

Swift

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

Parameters

`authorizationPostRequest`	(body) Authorization 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


                    
                    
                    postAuthorizations(authorizationPostRequest:zapTraceSpan:apiResponseQueue:)

Asynchronous

Create an authorization

Declaration

Swift

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

Parameters

`authorizationPostRequest`	(body) Authorization 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