Skip to contents

tiledbcloud.User

Format

An R6Class generator object

Methods

AddAWSAccessCredentials Add aws keys @param namespace character @param aws.access.credentials AWSAccessCredentials status code : 204 | AWS keys added successfully response headers :
status code : 0 | error response return type : Error response headers :
AddUserToOrganization add a user to an organization @param organization character @param user OrganizationUser status code : 204 | user added to organization successfully response headers :
status code : 0 | error response return type : Error response headers :
CheckAWSAccessCredentials Check if aws keys are set @param namespace character @returnType list( AWSAccessCredentials )
status code : 200 | AWS keys are set return type : array[AWSAccessCredentials] response headers :
status code : 0 | error response return type : Error response headers :
CheckAWSAccessCredentialsByName Check if aws keys are set by name @param namespace character @param name character @returnType AWSAccessCredentials
status code : 200 | AWS keys are set return type : AWSAccessCredentials response headers :
status code : 0 | error response return type : Error response headers :
ConfirmEmail confirm user email status code : 204 | User email confirmed successfully response headers :
status code : 0 | error response return type : Error response headers :
CreateUser create a user @param user User status code : 204 | user created successfully response headers :
status code : 0 | error response return type : Error response headers :
DeleteAWSAccessCredentials delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable @param namespace character @param name character status code : 204 | AWS credentials deleted response headers :
status code : 0 | error response return type : Error response headers :
DeleteUser delete a user @param username character status code : 204 | user deleted response headers :
status code : 0 | error response return type : Error response headers :
DeleteUserFromOrganization delete a user from an organization @param organization character @param username character status code : 204 | user delete from organization successfully response headers :
status code : 0 | error response return type : Error response headers :
GetOrganizationUser get a user from an organization @param organization character @param username character @returnType OrganizationUser
status code : 200 | user from organization return type : OrganizationUser response headers :
status code : 404 | User is not in organization response headers :
status code : 0 | error response return type : Error response headers :
GetSession Get session token for user @param remember.me character @returnType Token
status code : 200 | Session token return type : Token response headers :
status code : 0 | error response return type : Error response headers :
GetTokenScopes retrieves available token scopes for a user @returnType list( TokenScope )
status code : 200 | available token scopes return type : array[TokenScope] response headers :
status code : 0 | error response return type : Error response headers :
GetUser get a user @returnType User
status code : 200 | user details return type : User response headers :
status code : 0 | error response return type : Error response headers :
GetUserWithUsername get a user @param username character @returnType User
status code : 200 | user details return type : User response headers :
status code : 404 | User does not exist response headers :
status code : 0 | error response return type : Error response headers :
RequestToken Request an authorization token, optionally taken a TokenRequest object to set parameters on the token @param token.request TokenRequest @returnType Token
status code : 200 | token return type : Token response headers :
status code : 0 | error response return type : Error response headers :
ResetUserPassword reset user password @param user InlineObject status code : 204 | User password updated successfully response headers :
status code : 404 | User not found response headers :
status code : 0 | error response return type : Error response headers :
RevokeToken revoke an authorization token @param token character status code : 204 | revokation successfully response headers :
status code : 0 | error response return type : Error response headers :
TokensGet Fetch a list of user tokens @returnType list( Token )
status code : 200 | Array of user created non-session tokens return type : array[Token] response headers :
status code : 0 | error response return type : Error response headers :
TokensSessionGet Fetch a list of user session tokens @returnType list( Token )
status code : 200 | Array of user created session tokens return type : array[Token] response headers :
status code : 0 | error response return type : Error response headers :
UpdateAWSAccessCredentials Update aws keys or associated buckets. This will update the key associations for each array in the namespace @param namespace character @param name character @param aws.access.credentials AWSAccessCredentials status code : 204 | AWS keys updated successfully response headers :
status code : 0 | error response return type : Error response headers :
UpdateUser update a user @param username character @param user User status code : 204 | user updated successfully response headers :
status code : 0 | error response return type : Error response headers :
UpdateUserInOrganization update a user in an organization @param organization character @param username character @param user OrganizationUser status code : 204 | user update in organization successfully response headers :
status code : 0 | error response return type : Error response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage

UserApi$new(apiClient)


Method AddAWSAccessCredentials()

Usage

UserApi$AddAWSAccessCredentials(namespace, aws.access.credentials, ...)


Method AddAWSAccessCredentialsWithHttpInfo()

Usage

UserApi$AddAWSAccessCredentialsWithHttpInfo(
  namespace,
  aws.access.credentials,
  ...
)


Method AddUserToOrganization()

Usage

UserApi$AddUserToOrganization(organization, user, ...)


Method AddUserToOrganizationWithHttpInfo()

Usage

UserApi$AddUserToOrganizationWithHttpInfo(organization, user, ...)


Method CheckAWSAccessCredentials()

Usage

UserApi$CheckAWSAccessCredentials(namespace, ...)


Method CheckAWSAccessCredentialsWithHttpInfo()

Usage

UserApi$CheckAWSAccessCredentialsWithHttpInfo(namespace, ...)


Method CheckAWSAccessCredentialsByName()

Usage

UserApi$CheckAWSAccessCredentialsByName(namespace, name, ...)


Method CheckAWSAccessCredentialsByNameWithHttpInfo()

Usage

UserApi$CheckAWSAccessCredentialsByNameWithHttpInfo(namespace, name, ...)


Method ConfirmEmail()

Usage

UserApi$ConfirmEmail(...)


Method ConfirmEmailWithHttpInfo()

Usage

UserApi$ConfirmEmailWithHttpInfo(...)


Method CreateUser()

Usage

UserApi$CreateUser(user, ...)


Method CreateUserWithHttpInfo()

Usage

UserApi$CreateUserWithHttpInfo(user, ...)


Method DeleteAWSAccessCredentials()

Usage

UserApi$DeleteAWSAccessCredentials(namespace, name, ...)


Method DeleteAWSAccessCredentialsWithHttpInfo()

Usage

UserApi$DeleteAWSAccessCredentialsWithHttpInfo(namespace, name, ...)


Method DeleteUser()

Usage

UserApi$DeleteUser(username, ...)


Method DeleteUserWithHttpInfo()

Usage

UserApi$DeleteUserWithHttpInfo(username, ...)


Method DeleteUserFromOrganization()

Usage

UserApi$DeleteUserFromOrganization(organization, username, ...)


Method DeleteUserFromOrganizationWithHttpInfo()

Usage

UserApi$DeleteUserFromOrganizationWithHttpInfo(organization, username, ...)


Method GetOrganizationUser()

Usage

UserApi$GetOrganizationUser(organization, username, ...)


Method GetOrganizationUserWithHttpInfo()

Usage

UserApi$GetOrganizationUserWithHttpInfo(organization, username, ...)


Method GetSession()

Usage

UserApi$GetSession(remember.me = NULL, ...)


Method GetSessionWithHttpInfo()

Usage

UserApi$GetSessionWithHttpInfo(remember.me = NULL, ...)


Method GetTokenScopes()

Usage

UserApi$GetTokenScopes(...)


Method GetTokenScopesWithHttpInfo()

Usage

UserApi$GetTokenScopesWithHttpInfo(...)


Method GetUser()

Usage

UserApi$GetUser(...)


Method GetUserWithHttpInfo()

Usage

UserApi$GetUserWithHttpInfo(...)


Method GetUserWithUsername()

Usage

UserApi$GetUserWithUsername(username, ...)


Method GetUserWithUsernameWithHttpInfo()

Usage

UserApi$GetUserWithUsernameWithHttpInfo(username, ...)


Method RequestToken()

Usage

UserApi$RequestToken(token.request = NULL, ...)


Method RequestTokenWithHttpInfo()

Usage

UserApi$RequestTokenWithHttpInfo(token.request = NULL, ...)


Method ResetUserPassword()

Usage

UserApi$ResetUserPassword(user, ...)


Method ResetUserPasswordWithHttpInfo()

Usage

UserApi$ResetUserPasswordWithHttpInfo(user, ...)


Method RevokeToken()

Usage

UserApi$RevokeToken(token, ...)


Method RevokeTokenWithHttpInfo()

Usage

UserApi$RevokeTokenWithHttpInfo(token, ...)


Method TokensGet()

Usage

UserApi$TokensGet(...)


Method TokensGetWithHttpInfo()

Usage

UserApi$TokensGetWithHttpInfo(...)


Method TokensSessionGet()

Usage

UserApi$TokensSessionGet(...)


Method TokensSessionGetWithHttpInfo()

Usage

UserApi$TokensSessionGetWithHttpInfo(...)


Method UpdateAWSAccessCredentials()

Usage

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


Method UpdateAWSAccessCredentialsWithHttpInfo()

Usage

UserApi$UpdateAWSAccessCredentialsWithHttpInfo(
  namespace,
  name,
  aws.access.credentials,
  ...
)


Method UpdateUser()

Usage

UserApi$UpdateUser(username, user, ...)


Method UpdateUserWithHttpInfo()

Usage

UserApi$UpdateUserWithHttpInfo(username, user, ...)


Method UpdateUserInOrganization()

Usage

UserApi$UpdateUserInOrganization(organization, username, user, ...)


Method UpdateUserInOrganizationWithHttpInfo()

Usage

UserApi$UpdateUserInOrganizationWithHttpInfo(organization, username, user, ...)


Method clone()

The objects of this class are cloneable with this method.

Usage

UserApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
####################  AddAWSAccessCredentials  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.aws.access.credentials <- AWSAccessCredentials$new() # 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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$AddAWSAccessCredentials(var.namespace, var.aws.access.credentials)


####################  AddUserToOrganization  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.user <- OrganizationUser$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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$AddUserToOrganization(var.organization, var.user)


####################  CheckAWSAccessCredentials  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CheckAWSAccessCredentials(var.namespace)


####################  CheckAWSAccessCredentialsByName  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CheckAWSAccessCredentialsByName(var.namespace, var.name)


####################  ConfirmEmail  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ConfirmEmail()


####################  CreateUser  ####################

library(tiledbcloud)
var.user <- User$new() # 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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CreateUser(var.user)


####################  DeleteAWSAccessCredentials  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$DeleteAWSAccessCredentials(var.namespace, var.name)


####################  DeleteUser  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$DeleteUser(var.username)


####################  DeleteUserFromOrganization  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$DeleteUserFromOrganization(var.organization, var.username)


####################  GetOrganizationUser  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetOrganizationUser(var.organization, var.username)


####################  GetSession  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetSession(remember.me=var.remember.me)


####################  GetTokenScopes  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetTokenScopes()


####################  GetUser  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetUser()


####################  GetUserWithUsername  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetUserWithUsername(var.username)


####################  RequestToken  ####################

library(tiledbcloud)
var.token.request <- TokenRequest$new() # 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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$RequestToken(token.request=var.token.request)


####################  ResetUserPassword  ####################

library(tiledbcloud)
var.user <- InlineObject$new() # 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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ResetUserPassword(var.user)


####################  RevokeToken  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$RevokeToken(var.token)


####################  TokensGet  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$TokensGet()


####################  TokensSessionGet  ####################

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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$TokensSessionGet()


####################  UpdateAWSAccessCredentials  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.name <- 'name_example' # character | name
var.aws.access.credentials <- AWSAccessCredentials$new() # 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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$UpdateAWSAccessCredentials(var.namespace, var.name, var.aws.access.credentials)


####################  UpdateUser  ####################

library(tiledbcloud)
var.username <- 'username_example' # character | username or ID
var.user <- User$new() # 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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$UpdateUser(var.username, var.user)


####################  UpdateUserInOrganization  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.username <- 'username_example' # character | username to manipulate
var.user <- OrganizationUser$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
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$UpdateUserInOrganization(var.organization, var.username, var.user)


} # }