SecretsAPI

public class SecretsAPI

  • Declaration

    Swift

    public init(influxDB2API: InfluxDB2API)

  • Delete a secret from an organization

    Declaration

    Swift

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

    Parameters

    orgID

    (path) The organization ID.
    secretID

    (path) The secret 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

  • Delete a secret from an organization

    Declaration

    Swift

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

    Parameters

    orgID

    (path) The organization ID.
    secretID

    (path) The secret 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

  • List all secret keys for an organization

    Declaration

    Swift

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

    Parameters

    orgID

    (path) The organization 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

  • List all secret keys for an organization

    Declaration

    Swift

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

    Parameters

    orgID

    (path) The organization 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

  • Update secrets in an organization

    Declaration

    Swift

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

    Parameters

    orgID

    (path) The organization ID.
    requestBody

    (body) Secret key value pairs to update/add
    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

  • Update secrets in an organization

    Declaration

    Swift

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

    Parameters

    orgID

    (path) The organization ID.
    requestBody

    (body) Secret key value pairs to update/add
    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

  • Delete secrets from an organization

    Declaration

    Swift

    @available(*, deprecated, message: "This operation is deprecated.")
public func postOrgsIDSecrets(orgID: String, secretKeys: SecretKeys, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    orgID

    (path) The organization ID.
    secretKeys

    (body) Secret key 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

  • Delete secrets from an organization

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
@available(*, deprecated, message: "This operation is deprecated.")
public func postOrgsIDSecrets(orgID: String, secretKeys: SecretKeys, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    orgID

    (path) The organization ID.
    secretKeys

    (body) Secret key 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