POST /platform/subscriptions

Adds a new tenant to the platform.

Authorization Roles/Permissions: Must be logged in. Must have the Tenant Manager role at the root organization in the API platform. With that role, this operation works with basic authentication credentials or digest authentication credentials.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/platform/subscriptions

Back to top

Sample Request

The example below shows a request to add a tenant to the platform.

Request URL

https://{hostname}/platform/subscriptions

Sample request headers

Content-Type: application/json
Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "TenantID":"acmepaymentscorp",
  "TenantName":"Acme Payments Corp",
  "ApiAddress":"http://acmepaymentscorp.cloud.epaas.info/",
  "PortalAddress":"http://acmepaymentscorp.cloud.epaas.info/atmosphere/",
  "NotificationsSenderEmailAddress":"noreply@acmepaymentscorp.com",
  "AdditionalVirtualHosts":[
    "developer.acme.com"
  ],
  "DefaultUserAccounts":[
    {
      "Email":"adminuser@acmepaymentscorp.com",
      "Role":[
        "SiteAdmin",
        "BusinessAdmin"
      ],
      "FirstName":"testUser1",
      "LastName":"testuserLN"
    },
    {
      "Email":"support11@acmepaymentscorp.com",
      "Role":[
        "SiteAdmin",
        "BusinessAdmin"
      ],
      "FirstName":"Mary",
      "LastName":"Martinson"
    },
    {
      "Email":"support12@acmepaymentscorp.com",
      "Role":[
        "SiteAdmin",
        "BusinessAdmin"
      ],
      "FirstName":"Philip",
      "LastName":"Pirrip"
    },
    {
      "Email":"support13@acmepaymentscorp.com",
      "Role":[
        "SiteAdmin",
        "BusinessAdmin"
      ],
      "FirstName":"Jonathan",
      "LastName":"Swift"
    }
  ]
}

Back to top

Request Headers

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

Header Description
Accept

application/json, application/xml,

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

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
TenantRegistrationRequest Body TenantRegistrationRequest Required Contains information about a request to add a tenant to the API Platform.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the new tenant that was added.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Content-Type: application/json

Sample response body: application/json

{
"FedMemberID": "acmepaymentscorp",
"TenantName": "Acme Payments Corp",
"State": "com.akana.tenant.state.active"
}

Back to top

Response Headers

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

Header Description
Content-Type

application/json, application/xml,

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

Back to top

Response Body

Name Type Description
Tenant Tenant

Contains information about a tenant on the API Platform.

The response include a subset of values, as shown in the example above.

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