Overview

DescriptionSearch for tenants. If the exact tenantDomain is not known, part of the tenant domain or any string (with or without the period symbol) can be entered as the tenant domain.
Resource Path/tenants/search/{tenantDomain}
HTTP MethodGET
Request/Response Formatapplication/json

> GET /api/tenants/search/y.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 09:08:59 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
[{"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/search/{tenantDomain}

  • 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

Description

Search for tenants based on the partial domain value entered.

  • List out tenants whose domain names have a particular letter or punctuation. For example, the following would provide details of all the tenants that have the letter k in the domain name.
    k

  • List out tenants whose domain names have a specific sequence of letters and punctuation. For example, the following would provide details of all the tenants that have .com in the domain name.
    .com

  • List out tenants by the domain name. For example, the following would list out the tenant with the domain name frank.com.
    frank.com

 

The search for tenants via partial domain will only succeed if the characters entered when executing the command are included in a tenant domain/s at the time of the search. If there are no tenant domains to match the given search the CLI Tool will return No tenants found as the output.

Command format

list-tenants <PARTIAL_DOMAIN>

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

 {
  "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