Tenants:Get Tenant

Search (SHIFT+S)



Get Tenant

GET /tenants/{id}

Get info for tenant or subtenant

idthe URN of a ViPR Tenant/Subtenant

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN
  • SECURITY_ADMIN

Response Body

Tenant details

Field Description Type Notes
<tenant>
<description> Optional Detailed Description of the Tenant String
<parent_tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</parent_tenant>      
<user_mappings> User mappings define how a user is mapped to a tenant. The user can be mapped to a tenant using parameters such as domains, LDAP attributes, and AD group membership.
<user_mapping>     0-* Elements
<domain> A single-valued attribute indicating the user's IDP domain String Valid Values:
  •  Examples: "emc.com" or "netapp.com"
<attributes>
<attribute>     0-* Elements
<key> Lookup string for this key-value pair String
<value> Lookup result for this key-value pair String 0-* Elements
</attribute>      
</attributes>
<groups>
<group> String 0-* Elements
</groups>
</user_mapping>      
</user_mappings>
<namespace> Namespace mapped to the Tenant String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</tenant>

Examples

Request
GET https://192.168.0.0:4443/tenants/urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <tenant>
       <creation_time>1379168259060</creation_time>
       <id>urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b:</id>
       <inactive>false</inactive>
       <link href="/tenants/urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b:" rel="self"/>
       <name>Provider Tenant</name>
       <tags/>
       <description>Root Provider Tenant</description>
       <user_mappings>
            <user_mapping>
                 <attributes>
                      <attribute>
                           <key>ou</key>
                           <value>sanity</value>
                      </attribute>
                 </attributes>
                 <domain>sanity.local</domain>
                 <groups/>
            </user_mapping>
            <user_mapping>
                 <attributes/>
                 <domain>sanity.local</domain>
                 <groups>
                      <group>test Group</group>
                 </groups>
            </user_mapping>
       </user_mappings>
  </tenant>
Notes: