Overview

DescriptionRetrieving details of all the tenants.
Resource Path/tenants
HTTP MethodGET
Request/Response Formatapplication/json
> GET /api/tenants 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:21:47 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
[{"active":true,"createdDate":1426574104129,"email":"foo@bar.com","tenantDomain":"frank.com","tenantId":1},{"active":true,"createdDate":1426576793551,"email":"foow@bar.com","tenantDomain":"franky.com","tenantId":2}]

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

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

 
CLI command

list-tenants

DescriptionRetrieving details of all tenants.
Command format

list-tenants

REST API response

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

[
  {
    "active": true,
    "createdDate": 1426574104129,
    "email": "foo@bar.com",
    "tenantDomain": "frank.com",
    "tenantId": 1
  },
  {
    "active": true,
    "createdDate": 1426576793551,
    "email": "foow@bar.com",
    "tenantDomain": "franky.com",
    "tenantId": 2
  }
] 

For information on the property definitions, see Tenant Resource Definition.

  • No labels