Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 1.69 KB

ProjectApi.md

File metadata and controls

76 lines (52 loc) · 1.69 KB

Passbase::ProjectApi

All URIs are relative to https://api.passbase.com/verification/v2

Method HTTP request Description
get_settings GET /settings Get project settings

get_settings

get_settings

Get project settings

Get project settings

Examples

require 'time'
require 'passbase'
# setup authorization
Passbase.configure do |config|
  # Configure API key authorization: SecretApiKey
  config.api_key['SecretApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
end

api_instance = Passbase::ProjectApi.new

begin
  # Get project settings
  result = api_instance.get_settings
  p result
rescue Passbase::ApiError => e
  puts "Error when calling ProjectApi->get_settings: #{e}"
end

Using the get_settings_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_settings_with_http_info

begin
  # Get project settings
  data, status_code, headers = api_instance.get_settings_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProjectSettings>
rescue Passbase::ApiError => e
  puts "Error when calling ProjectApi->get_settings_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ProjectSettings

Authorization

SecretApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json