TenantsApi: Tenants operations

Description Usage Format Details Methods See Also

Description

TenantsApi Class

The Tenants API is a readonly discovery service for Agave tenants.

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Details

The Tenants API is a readonly discovery service to assist in the location, configuration, and activation of Agave tenants. The Tenants API contains the canonical source of information for tenant baseUrl and identifiers, which are both used to bootstrap the Agave tooling.

Methods

$getTenantDetails(codeOrUuid) gets detailed description for an individual tenant by either code or uuid.

Usage

1
tenants$getTenantDetails(codeOrUuid="agave.prod")

$listTenants() List all active tenants with optional pagination;

Usage

1
tenants$listTenants()

See Also

rAgave::Tenant rAgave::ClientsApi rAgave::Client


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.