All URIs are relative to http://localhost/v1
Method | HTTP request | Description ------------- | ------------- | ------------- AddAWSAccessCredentials | POST /credentials/{namespace}/aws | AddUserToOrganization | POST /organizations/{organization}/user | CheckAWSAccessCredentials | GET /credentials/{namespace}/aws | CheckAWSAccessCredentialsByName | GET /credentials/{namespace}/aws/{name} | ConfirmEmail | POST /user/confirm_email | CreateUser | POST /user | DeleteAWSAccessCredentials | DELETE /credentials/{namespace}/aws/{name} | DeleteUser | DELETE /users/{username} | DeleteUserFromOrganization | DELETE /organizations/{organization}/{username} | GetOrganizationUser | GET /organizations/{organization}/{username} | GetSession | GET /session | GetUser | GET /user | GetUserWithUsername | GET /users/{username} | RequestToken | POST /token | ResetUserPassword | POST /user/password_reset | RevokeToken | DELETE /tokens/{token} | TokensGet | GET /tokens | UpdateAWSAccessCredentials | PATCH /credentials/{namespace}/aws/{name} | UpdateUser | PATCH /users/{username} | UpdateUserInOrganization | PATCH /organizations/{organization}/{username} |
AddAWSAccessCredentials(namespace, aws.access.credentials)
Add aws keys
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.aws.access.credentials <- AWSAccessCredentials$new("secret_access_key_example", "access_key_id_example", "service_role_arn_example", "name_example", "default_example", list("buckets_example"), "created_at_example", "updated_at_example") # AWSAccessCredentials | aws access credentials to store for a namespace
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$AddAWSAccessCredentials(var.namespace, var.aws.access.credentials)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | aws.access.credentials | AWSAccessCredentials| aws access credentials to store for a namespace |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | AWS keys added successfully | - | | 0 | error response | - |
AddUserToOrganization(organization, user)
add a user to an organization
library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.user <- OrganizationUser$new("user_id_example", "organization_id_example", "username_example", "organization_name_example", OrganizationRoles$new(), list(NamespaceActions$new())) # OrganizationUser | user to add
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$AddUserToOrganization(var.organization, var.user)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | user | OrganizationUser| user to add |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user added to organization successfully | - | | 0 | error response | - |
array[AWSAccessCredentials] CheckAWSAccessCredentials(namespace)
Check if aws keys are set
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$CheckAWSAccessCredentials(var.namespace)
dput(result)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace |
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | AWS keys are set | - | | 0 | error response | - |
AWSAccessCredentials CheckAWSAccessCredentialsByName(namespace, name)
Check if aws keys are set by name
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.name <- 'name_example' # character | name
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$CheckAWSAccessCredentialsByName(var.namespace, var.name)
dput(result)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | name | character| name |
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | AWS keys are set | - | | 0 | error response | - |
ConfirmEmail()
confirm user email
library(tiledbcloud)
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$ConfirmEmail()
This endpoint does not need any parameter.
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | User email confirmed successfully | - | | 0 | error response | - |
CreateUser(user)
create a user
library(tiledbcloud)
var.user <- User$new("id_example", "username_example", "password_example", "name_example", "email_example", "is_valid_email_example", "stripe_connect_example", "company_example", "logo_example", "last_activity_date_example", "timezone_example", list(OrganizationUser$new("user_id_example", "organization_id_example", "username_example", "organization_name_example", OrganizationRoles$new(), list(NamespaceActions$new()))), list(NamespaceActions$new()), list("enabled_features_example"), "unpaid_subscription_example", "default_s3_path_example", "default_s3_path_credentials_name_example", "default_namespace_charged_example") # User | user to create
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$CreateUser(var.user)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- user | User| user to create |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user created successfully | - | | 0 | error response | - |
DeleteAWSAccessCredentials(namespace, name)
delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.name <- 'name_example' # character | name
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$DeleteAWSAccessCredentials(var.namespace, var.name)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | name | character| name |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | AWS credentials deleted | - | | 0 | error response | - |
DeleteUser(username)
delete a user
library(tiledbcloud)
var.username <- 'username_example' # character | username or id
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$DeleteUser(var.username)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- username | character| username or id |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user deleted | - | | 0 | error response | - |
DeleteUserFromOrganization(organization, username)
delete a user from an organization
library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.username <- 'username_example' # character | username to manipulate
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$DeleteUserFromOrganization(var.organization, var.username)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | username | character| username to manipulate |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user delete from organization successfully | - | | 0 | error response | - |
OrganizationUser GetOrganizationUser(organization, username)
get a user from an organization
library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.username <- 'username_example' # character | username to manipulate
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetOrganizationUser(var.organization, var.username)
dput(result)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | username | character| username to manipulate |
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | user from organization | - | | 404 | User is not in organization | - | | 0 | error response | - |
Token GetSession(remember.me=var.remember.me)
Get session token for user
library(tiledbcloud)
var.remember.me <- 'remember.me_example' # character | flag to create a token with expiration of 30 days, default is false
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetSession(remember.me=var.remember.me)
dput(result)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- remember.me | character| flag to create a token with expiration of 30 days, default is false | [optional]
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Session token | - | | 0 | error response | - |
User GetUser()
get a user
library(tiledbcloud)
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetUser()
dput(result)
This endpoint does not need any parameter.
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | user details | - | | 0 | error response | - |
User GetUserWithUsername(username)
get a user
library(tiledbcloud)
var.username <- 'username_example' # character | username or id
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetUserWithUsername(var.username)
dput(result)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- username | character| username or id |
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | user details | - | | 404 | User does not exist | - | | 0 | error response | - |
Token RequestToken(token.request=var.token.request)
Request an authorization token, optionally taken a TokenRequest object to set parameters on the token
library(tiledbcloud)
var.token.request <- TokenRequest$new("expires_example", "name_example", "scope_example") # TokenRequest | token request object
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$RequestToken(token.request=var.token.request)
dput(result)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- token.request | TokenRequest| token request object | [optional]
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | token | - | | 0 | error response | - |
ResetUserPassword(user)
reset user password
library(tiledbcloud)
var.user <- inline_object$new("password_example") # InlineObject |
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$ResetUserPassword(var.user)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- user | InlineObject| |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | User password updated successfully | - | | 404 | User not found | - | | 0 | error response | - |
RevokeToken(token)
revoke an authorization token
library(tiledbcloud)
var.token <- 'token_example' # character | token name or token itself
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$RevokeToken(var.token)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- token | character| token name or token itself |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | revokation successfully | - | | 0 | error response | - |
array[Token] TokensGet()
Fetch a list of user tokens
library(tiledbcloud)
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$TokensGet()
dput(result)
This endpoint does not need any parameter.
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Array of all user created tokens | - | | 0 | error response | - |
UpdateAWSAccessCredentials(namespace, name, aws.access.credentials)
Update aws keys or associated buckets. This will update the key associations for each array in the namespace
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.name <- 'name_example' # character | name
var.aws.access.credentials <- AWSAccessCredentials$new("secret_access_key_example", "access_key_id_example", "service_role_arn_example", "name_example", "default_example", list("buckets_example"), "created_at_example", "updated_at_example") # AWSAccessCredentials | aws credentials to update
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$UpdateAWSAccessCredentials(var.namespace, var.name, var.aws.access.credentials)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | name | character| name | aws.access.credentials | AWSAccessCredentials| aws credentials to update |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | AWS keys updated successfully | - | | 0 | error response | - |
UpdateUser(username, user)
update a user
library(tiledbcloud)
var.username <- 'username_example' # character | username or id
var.user <- User$new("id_example", "username_example", "password_example", "name_example", "email_example", "is_valid_email_example", "stripe_connect_example", "company_example", "logo_example", "last_activity_date_example", "timezone_example", list(OrganizationUser$new("user_id_example", "organization_id_example", "username_example", "organization_name_example", OrganizationRoles$new(), list(NamespaceActions$new()))), list(NamespaceActions$new()), list("enabled_features_example"), "unpaid_subscription_example", "default_s3_path_example", "default_s3_path_credentials_name_example", "default_namespace_charged_example") # User | user details to update
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$UpdateUser(var.username, var.user)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- username | character| username or id | user | User| user details to update |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user updated successfully | - | | 0 | error response | - |
UpdateUserInOrganization(organization, username, user)
update a user in an organization
library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.username <- 'username_example' # character | username to manipulate
var.user <- OrganizationUser$new("user_id_example", "organization_id_example", "username_example", "organization_name_example", OrganizationRoles$new(), list(NamespaceActions$new())) # OrganizationUser | user details to update
api.instance <- UserApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$UpdateUserInOrganization(var.organization, var.username, var.user)
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | username | character| username to manipulate | user | OrganizationUser| user details to update |
void (empty response body)
| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user update in organization successfully | - | | 0 | error response | - |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.