DELETE /api/securitydomains/{domainid}

Deletes the security domain profile.

Authorization Roles/Permissions: Must be logged in. Must have the permission for the resource. Business Admin.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

DELETE

URL

https://{hostname}/api/securitydomains/{domainid}

Sample Request

The following example shows a request to delete the specified security domain profile.

Sample Request URL

https://{hostname}/api/securitydomains/acmepaymentscorp_4hrNPFUYS

Sample request headers

Accept:application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
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
DomainID	Path	string	Required	The unique ID for a specific domain.

Response

If successful, this operation returns HTTP status code 200. There is no response content.

Sample Response

The following sample response shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Date: Thu, 18 Sep 2024 21:09:44 GMT

Sample response body

None.

Response Headers

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

Header	Description
Content-Type	application/json

Response Body