OrganizationApi: Organization operations

In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

Organization operations

Description

tiledbcloud.Organization

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 :

CreateOrganization create a organization, the user creating will be listed as owner

• @param organization Organization

• status code : 204 | organization 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 :

DeleteOrganization delete a organization

• @param organization character

• status code : 204 | organization 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 :

GetAllOrganizations get all organizations that the user is member of

• @returnType list( Organization )
  

• status code : 200 | array of organizations the user is member of

• return type : array[Organization]

• response headers :

• status code : 400 | Error finding organizations

• response headers :

• status code : 500 | Request user not found, or has empty context

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

GetOrganization get a organization

• @param organization character

• @returnType Organization
  

• status code : 200 | organization details

• return type : Organization

• response headers :

• status code : 404 | Organization does not exist

• 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 :

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 :

UpdateOrganization update a organization

• @param organization character

• @param organization.details Organization

• status code : 204 | organization 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

• OrganizationApi$new()

• OrganizationApi$AddAWSAccessCredentials()

• OrganizationApi$AddAWSAccessCredentialsWithHttpInfo()

• OrganizationApi$AddUserToOrganization()

• OrganizationApi$AddUserToOrganizationWithHttpInfo()

• OrganizationApi$CheckAWSAccessCredentials()

• OrganizationApi$CheckAWSAccessCredentialsWithHttpInfo()

• OrganizationApi$CheckAWSAccessCredentialsByName()

• OrganizationApi$CheckAWSAccessCredentialsByNameWithHttpInfo()

• OrganizationApi$CreateOrganization()

• OrganizationApi$CreateOrganizationWithHttpInfo()

• OrganizationApi$DeleteAWSAccessCredentials()

• OrganizationApi$DeleteAWSAccessCredentialsWithHttpInfo()

• OrganizationApi$DeleteOrganization()

• OrganizationApi$DeleteOrganizationWithHttpInfo()

• OrganizationApi$DeleteUserFromOrganization()

• OrganizationApi$DeleteUserFromOrganizationWithHttpInfo()

• OrganizationApi$GetAllOrganizations()

• OrganizationApi$GetAllOrganizationsWithHttpInfo()

• OrganizationApi$GetOrganization()

• OrganizationApi$GetOrganizationWithHttpInfo()

• OrganizationApi$GetOrganizationUser()

• OrganizationApi$GetOrganizationUserWithHttpInfo()

• OrganizationApi$UpdateAWSAccessCredentials()

• OrganizationApi$UpdateAWSAccessCredentialsWithHttpInfo()

• OrganizationApi$UpdateOrganization()

• OrganizationApi$UpdateOrganizationWithHttpInfo()

• OrganizationApi$UpdateUserInOrganization()

• OrganizationApi$UpdateUserInOrganizationWithHttpInfo()

• OrganizationApi$clone()

---

Method new()

Usage

OrganizationApi$new(apiClient)

---

Method AddAWSAccessCredentials()

Usage

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

---

Method AddAWSAccessCredentialsWithHttpInfo()

Usage

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

---

Method AddUserToOrganization()

Usage

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

---

Method AddUserToOrganizationWithHttpInfo()

Usage

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

---

Method CheckAWSAccessCredentials()

Usage

OrganizationApi$CheckAWSAccessCredentials(namespace, ...)

---

Method CheckAWSAccessCredentialsWithHttpInfo()

Usage

OrganizationApi$CheckAWSAccessCredentialsWithHttpInfo(namespace, ...)

---

Method CheckAWSAccessCredentialsByName()

Usage

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

---

Method CheckAWSAccessCredentialsByNameWithHttpInfo()

Usage

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

---

Method CreateOrganization()

Usage

OrganizationApi$CreateOrganization(organization, ...)

---

Method CreateOrganizationWithHttpInfo()

Usage

OrganizationApi$CreateOrganizationWithHttpInfo(organization, ...)

---

Method DeleteAWSAccessCredentials()

Usage

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

---

Method DeleteAWSAccessCredentialsWithHttpInfo()

Usage

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

---

Method DeleteOrganization()

Usage

OrganizationApi$DeleteOrganization(organization, ...)

---

Method DeleteOrganizationWithHttpInfo()

Usage

OrganizationApi$DeleteOrganizationWithHttpInfo(organization, ...)

---

Method DeleteUserFromOrganization()

Usage

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

---

Method DeleteUserFromOrganizationWithHttpInfo()

Usage

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

---

Method GetAllOrganizations()

Usage

OrganizationApi$GetAllOrganizations(...)

---

Method GetAllOrganizationsWithHttpInfo()

Usage

OrganizationApi$GetAllOrganizationsWithHttpInfo(...)

---

Method GetOrganization()

Usage

OrganizationApi$GetOrganization(organization, ...)

---

Method GetOrganizationWithHttpInfo()

Usage

OrganizationApi$GetOrganizationWithHttpInfo(organization, ...)

---

Method GetOrganizationUser()

Usage

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

---

Method GetOrganizationUserWithHttpInfo()

Usage

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

---

Method UpdateAWSAccessCredentials()

Usage

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

---

Method UpdateAWSAccessCredentialsWithHttpInfo()

Usage

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

---

Method UpdateOrganization()

Usage

OrganizationApi$UpdateOrganization(organization, organization.details, ...)

---

Method UpdateOrganizationWithHttpInfo()

Usage

OrganizationApi$UpdateOrganizationWithHttpInfo(
  organization,
  organization.details,
  ...
)

---

Method UpdateUserInOrganization()

Usage

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

---

Method UpdateUserInOrganizationWithHttpInfo()

Usage

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

---

Method clone()

The objects of this class are cloneable with this method.

Usage

OrganizationApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  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 <- OrganizationApi$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 <- OrganizationApi$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 <- OrganizationApi$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 <- OrganizationApi$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)


####################  CreateOrganization  ####################

library(tiledbcloud)
var.organization <- Organization$new() # Organization | organization to create

api.instance <- OrganizationApi$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$CreateOrganization(var.organization)


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

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace
var.name <- 'name_example' # character | name

api.instance <- OrganizationApi$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)


####################  DeleteOrganization  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name or ID

api.instance <- OrganizationApi$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$DeleteOrganization(var.organization)


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

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.username <- 'username_example' # character | username to manipulate

api.instance <- OrganizationApi$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)


####################  GetAllOrganizations  ####################

library(tiledbcloud)

api.instance <- OrganizationApi$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$GetAllOrganizations()


####################  GetOrganization  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name or ID

api.instance <- OrganizationApi$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$GetOrganization(var.organization)


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

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name
var.username <- 'username_example' # character | username to manipulate

api.instance <- OrganizationApi$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)


####################  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 <- OrganizationApi$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)


####################  UpdateOrganization  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | organization name or ID
var.organization.details <- Organization$new() # Organization | organization details to update

api.instance <- OrganizationApi$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$UpdateOrganization(var.organization, var.organization.details)


####################  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 <- OrganizationApi$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)



## End(Not run)

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