md-docs/UserApi.md

UserApi

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

AddAWSAccessCredentials(namespace, aws.access.credentials)

Add aws keys

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | aws.access.credentials | AWSAccessCredentials| aws access credentials to store for a namespace |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | AWS keys added successfully | - | | 0 | error response | - |

AddUserToOrganization

AddUserToOrganization(organization, user)

add a user to an organization

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | user | OrganizationUser| user to add |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user added to organization successfully | - | | 0 | error response | - |

CheckAWSAccessCredentials

array[AWSAccessCredentials] CheckAWSAccessCredentials(namespace)

Check if aws keys are set

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace |

Return type

array[AWSAccessCredentials]

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | AWS keys are set | - | | 0 | error response | - |

CheckAWSAccessCredentialsByName

AWSAccessCredentials CheckAWSAccessCredentialsByName(namespace, name)

Check if aws keys are set by name

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | name | character| name |

Return type

AWSAccessCredentials

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | AWS keys are set | - | | 0 | error response | - |

ConfirmEmail

ConfirmEmail()

confirm user email

Example

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()

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | User email confirmed successfully | - | | 0 | error response | - |

CreateUser

CreateUser(user)

create a user

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- user | User| user to create |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user created successfully | - | | 0 | error response | - |

DeleteAWSAccessCredentials

DeleteAWSAccessCredentials(namespace, name)

delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | name | character| name |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | AWS credentials deleted | - | | 0 | error response | - |

DeleteUser

DeleteUser(username)

delete a user

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- username | character| username or id |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user deleted | - | | 0 | error response | - |

DeleteUserFromOrganization

DeleteUserFromOrganization(organization, username)

delete a user from an organization

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | username | character| username to manipulate |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user delete from organization successfully | - | | 0 | error response | - |

GetOrganizationUser

OrganizationUser GetOrganizationUser(organization, username)

get a user from an organization

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | username | character| username to manipulate |

Return type

OrganizationUser

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | user from organization | - | | 404 | User is not in organization | - | | 0 | error response | - |

GetSession

Token GetSession(remember.me=var.remember.me)

Get session token for user

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- remember.me | character| flag to create a token with expiration of 30 days, default is false | [optional]

Return type

Token

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Session token | - | | 0 | error response | - |

GetUser

User GetUser()

get a user

Example

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)

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | user details | - | | 0 | error response | - |

GetUserWithUsername

User GetUserWithUsername(username)

get a user

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- username | character| username or id |

Return type

User

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | user details | - | | 404 | User does not exist | - | | 0 | error response | - |

RequestToken

Token RequestToken(token.request=var.token.request)

Request an authorization token, optionally taken a TokenRequest object to set parameters on the token

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- token.request | TokenRequest| token request object | [optional]

Return type

Token

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | token | - | | 0 | error response | - |

ResetUserPassword

ResetUserPassword(user)

reset user password

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- user | InlineObject| |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | User password updated successfully | - | | 404 | User not found | - | | 0 | error response | - |

RevokeToken

RevokeToken(token)

revoke an authorization token

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- token | character| token name or token itself |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | revokation successfully | - | | 0 | error response | - |

TokensGet

array[Token] TokensGet()

Fetch a list of user tokens

Example

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)

Parameters

This endpoint does not need any parameter.

Return type

array[Token]

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Array of all user created tokens | - | | 0 | error response | - |

UpdateAWSAccessCredentials

UpdateAWSAccessCredentials(namespace, name, aws.access.credentials)

Update aws keys or associated buckets. This will update the key associations for each array in the namespace

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace | name | character| name | aws.access.credentials | AWSAccessCredentials| aws credentials to update |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | AWS keys updated successfully | - | | 0 | error response | - |

UpdateUser

UpdateUser(username, user)

update a user

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- username | character| username or id | user | User| user details to update |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user updated successfully | - | | 0 | error response | - |

UpdateUserInOrganization

UpdateUserInOrganization(organization, username, user)

update a user in an organization

Example

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)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- organization | character| organization name | username | character| username to manipulate | user | OrganizationUser| user details to update |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | user update in organization successfully | - | | 0 | error response | - |



TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.