Skip to main content

SwaggerClient::UserApi

All URIs are relative to https://api.estuary.tech

MethodHTTP requestDescription
user_api_keys_getGET /user/api-keysGet API keys for a user
user_api_keys_key_deleteDELETE /user/api-keys/{key}Revoke a User API Key.
user_api_keys_postPOST /user/api-keysCreate API keys for a user
user_export_getGET /user/exportExport user data
user_stats_getGET /user/statsCreate API keys for a user

user_api_keys_get

Array<MainGetApiKeysResp> user_api_keys_get

Get API keys for a user

This endpoint is used to get API keys for a user. In estuary, each user can be given multiple API keys (tokens). This endpoint can be used to retrieve all available API keys for a given user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
#Get API keys for a user
result = api_instance.user_api_keys_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_api_keys_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<MainGetApiKeysResp>

Authorization

bearerAuth

HTTP request headers

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

user_api_keys_key_delete

user_api_keys_key_delete(key)

Revoke a User API Key.

This endpoint is used to revoke a user API key. In estuary, every user is assigned with an API key, this API key is generated and issued for each user and is primarily use to access all estuary features. This endpoint can be used to revoke the API key thats assigned to the user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

key = 'key_example' # String | Key


begin
#Revoke a User API Key.
api_instance.user_api_keys_key_delete(key)
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_api_keys_key_delete: #{e}"
end

Parameters

NameTypeDescriptionNotes
keyStringKey

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

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

user_api_keys_post

MainGetApiKeysResp user_api_keys_post(opts)

Create API keys for a user

This endpoint is used to create API keys for a user. In estuary, each user is given an API key to access all features.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

opts = {
expiry: 'expiry_example', # String | Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h
perms: 'perms_example' # String | Permissions -- currently unused
}

begin
#Create API keys for a user
result = api_instance.user_api_keys_post(opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_api_keys_post: #{e}"
end

Parameters

NameTypeDescriptionNotes
expiryStringExpiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h[optional]
permsStringPermissions -- currently unused[optional]

Return type

MainGetApiKeysResp

Authorization

bearerAuth

HTTP request headers

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

user_export_get

String user_export_get

Export user data

This endpoint is used to get API keys for a user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
#Export user data
result = api_instance.user_export_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_export_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

user_stats_get

MainUserStatsResponse user_stats_get

Create API keys for a user

This endpoint is used to create API keys for a user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
#Create API keys for a user
result = api_instance.user_stats_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_stats_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

MainUserStatsResponse

Authorization

bearerAuth

HTTP request headers

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