GET /api/tenants/{FedmemberID}

Returns information about a tenant on the API Platform.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the business information; must be an authorized Administrator for the specified tenant.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/tenants/{FedmemberID}

Back to top

Sample Request

The example below shows a request for information about the specified tenant.

Request URL

https://{hostname}/api/tenants/acmepaymentscorp

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
FedmemberID Path String Required Unique ID for a specific tenant, in a federation (multi-tenant) scenario; for example, acmepaymentscorp.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the requested information.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Fri, 28 Apr 2017 16:13:29 GMT

Sample response body: application/json

{
  "FedMemberID" : "acmepaymentscorp",
  "TenantName" : "acmepaymentscorp",
  "Description" : "acmepaymentscorp",
  "AdminGroupID" : "tenantadmin.acmepaymentscorp",
  "Business" : {
    "BusinessID" : "tenantbusiness.acmepaymentscorp",
    "BusinessKey" : "uddi:soa.com:atmosphere:tenant:acmepaymentscorp",
    "Name" : "Tenant - acmepaymentscorp",
    "Visibility" : "Limited",
    "AdminGroupID" : "bizadmin-tenantbusiness.acmepaymentscorp",
    "BusinessType" : "atmo.tenant"
  },
  "IndexTargets" : [ "elastic" ],
  "SearchSource" : "elastic",
  "ESIndexName" : "default",
  "PlatformApiContractExists" : false,
  "Themes" : [ {
    "Theme" : "default",
    "VirtualHosts" : [ "acmepaymentscorp-local.com" ],
    "ConsoleAddress" : "http://acmepaymentscorpcloud.com/atmosphere/",
    "SiteTitle" : "",
    "SiteDescription" : "",
    "TenantID" : 10001,
    "FedmemberID" : "acmepaymentscorp",
    "Alias" : ""
  }, {
    "Theme" : "simpledev",
    "VirtualHosts" : [ "acmepaymentscorpdeveloper-local.com" ],
    "ConsoleAddress" : "http://acmepaymentscorpdeveloper-local.com/atmosphere/",
    "SiteTitle" : "simpledev theme",
    "SiteDescription" : "",
    "TenantID" : 10001,
    "FedmemberID" : "acmepaymentscorp",
    "Alias" : ""
  }, {
    "Theme" : "hermosa",
    "VirtualHosts" : [ "acmepaymentscorpcloud-local.com" ],
    "ConsoleAddress" : "http://acmepaymentscorpcloud-local.com/atmosphere/",
    "SiteTitle" : "",
    "SiteDescription" : "",
    "TenantID" : 10001,
    "FedmemberID" : "acmepaymentscorp",
    "ThemeImpl" : "default",
    "Alias" : ""
  } ],
  "LaaSIntegrationSupport" : "com.soa.feature.disabled",
  "ForwardProxyAllowedHosts" : [ "*" ]
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
Tenant Tenant Contains information about a tenant on the API Platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics