PUT /platform/subscriptions/{SubscriptionID}/state

Changes the state of a tenant on the API Platform.

Authorization Roles/Permissions: Must be logged in. Must have the Tenant Manager role at the root organization for 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

PUT

URL

https://{hostname}/platform/subscriptions/{SubscriptionID}/state

Sample Request

The examples below show requests to change the tenant state.

Sample Request URL

https://{hostname}/platform/subscriptions/acmepaymentscorp/state

Sample request headers

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

Sample request body: suspend

{
  "TargetState":"com.akana.tenant.state.suspended"
}

Sample request body: resume

{
  "TargetState":"com.akana.tenant.state.active"
}

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
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
SubscriptionID	Path	SubscriptionID	Required	The unique ID assigned to a tenant that has a subscription to the platform.
TenantStateChangeRequest	Body	TenantStateChangeRequest	Required	Contains information about a request to change the state of a tenant on the platform.

Response

If successful, this operation returns HTTP status code 200, with the updated tenant state.

Sample Response

The sample responses below shows successful completion of this operation.

Sample response headers

Content-Type: application/vnd.soa.v80+json

Sample response body: suspended

{
  "FedMemberID":"acmepaymentscorp",
  "State":"com.akana.tenant.state.suspended"
}

Sample response body: resumed

{
  "FedMemberID":"acmepaymentscorp",
  "State":"com.akana.tenant.state.active"
}

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

Response Body

Name	Type	Description
Tenant	Tenant	Contains information about a tenant on the API Platform. The following fields are returned: FedMemberID State

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.

Related Topics