UserApi

All URIs are relative to **

Method	HTTP request	Description
userApiKeysGet	GET /user/api-keys	Get API keys for a user
userApiKeysKeyDelete	DELETE /user/api-keys/{key}	Revoke a User API Key.
userApiKeysPost	POST /user/api-keys	Create API keys for a user
userExportGet	GET /user/export	Export user data
userStatsGet	GET /user/stats	Create API keys for a user

userApiKeysGet

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

 userApiKeysGet

Parameters

This endpoint does not need any parameter.

Return type

array[Main.getApiKeysResp]

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userApiKeysKeyDelete

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

 userApiKeysKeyDelete key=value

Parameters

Name	Type	Description	Notes
key	string	Key

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userApiKeysPost

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

 userApiKeysPost  expiry=value  perms=value

Parameters

Name	Type	Description	Notes
expiry	string	Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h	[optional]
perms	string	Permissions -- currently unused	[optional]

Return type

Main.getApiKeysResp

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userExportGet

Export user data

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

Example

 userExportGet

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userStatsGet

Create API keys for a user

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

Example

 userStatsGet

Parameters

This endpoint does not need any parameter.

Return type

Main.userStatsResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]