Organizations

Defined in dfx/api/OrganizationAPI.hpp

Used to manage the DeepAffex Organization endpoint.

Create

virtual CloudStatus dfx::api::OrganizationAPI::create(const CloudConfig &config, const std::string &name, const std::string &identifier, const std::string &public_key, const OrganizationStatus &status, const std::string &logo, std::string &organizationID)

create Organization

Parameters

  • config – provides all the cloud configuration settings

  • name – a descriptive name to associate with the organization

  • identifier – a UUID identifier for the organization

  • public_key – the Organization License is required

  • status – the Organization status

  • logo – the Organization logo @organizationID the newly created organization identifier returned on CLOUD_OK

Returns

status of operation, CLOUD_OK on SUCCESS

Retrieve

virtual CloudStatus dfx::api::OrganizationAPI::list(const CloudConfig &config, const std::unordered_map<OrganizationFilter, std::string> &filters, uint16_t offset, std::vector<Organization> &organizations, int16_t &totalCount)

Retrieves a list of existing organization.

Parameters

  • config – provides all the cloud configuration settings

  • offset – to start the retrieval of records up to config.listLimit

  • organizations – list of organization being returned

  • totalCount – the total number of records on the server

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::OrganizationAPI::retrieve(const CloudConfig &config, const std::string &organizationID, Organization &organization)

Retrieves a existing organization.

Parameters

  • config – provides all the cloud configuration settings

  • organizationID – the organization ID to retrieve

  • organization – the retrieved organization information

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::OrganizationAPI::retrieveMultiple(const CloudConfig &config, const std::vector<std::string> &organizationIDs, std::vector<Organization> &organizations)

Retrieve full organization details for a organizations vector.

Parameters

  • config – provides all the cloud configuration settings

  • organizationIDs – list of organization IDs to obtain details for

  • organizations – list of organizations being returned

Returns

status of operation, CLOUD_OK on SUCCESS

Update

virtual CloudStatus dfx::api::OrganizationAPI::update(const CloudConfig &config, Organization &organization)

@breif Update an existing organization based on the provided organizationID.

Parameters

  • config – provides all the cloud configuration settings

  • organization – details to update for the organization

Returns

status of operation, CLOUD_OK on SUCCESS

Delete

virtual CloudStatus dfx::api::OrganizationAPI::remove(const CloudConfig &config, const std::string &organizationID)

Remove an existing organization based on the provided organizationID.

Parameters

  • config – provides all the cloud configuration settings

  • organizationID – the organization identifier to remove

Returns

status of operation, CLOUD_OK on SUCCESS