1. Home
  2. Docs
  3. API Documentation
  4. Login
  5. DeleteLogin

DeleteLogin

This function allow you to delete existing Login Authentications\Profiles from your server.

Request Syntax

{

“apiKey”: “string”,

“loginName”: “String”

}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

loginName

Parameter Usage and Options :

The name of the login profile.

Type :

String

Is it Optional ? :

No.


Successful Response

{
“Error”: 0,
“Function”: “DeleteLogin”,
“Data”: “Deleted”
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.