Description | Retrieve details of a tenant. Based on the response it will be possible to decide whether a certain domain name is available or not. |
Resource Path | /tenants/{tenantDomain} |
HTTP Method | GET |
Request/Response Format | application/json |
> GET /api/tenants/franky.com HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Mar 2015 08:47:03 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"active":true,"admin":"admin2","createdDate":1426576793551,"email":"foow@bar.com","firstname":"Franky","lastname":"Myers","tenantDomain":"franky.com","tenantId":2,"usagePlan":""}
The createdDate
is given in the Epoch time format.
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/tenants/{tenantDomain}
HTTP status code | 200, 404, 500 See the descriptions of the HTTP status codes here. |
Sample JSON response
{ "active": true, "admin": "admin2", "createdDate": 1426576793551, "email": "foow@bar.com", "firstname": "Franky", "lastname": "Myers", "tenantDomain": "franky.com", "tenantId": 2, "usagePlan": "" }
For information on the property definitions, see Tenant Resource Definition.