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

GetLogins

Route: https://api.kayran.live/GetLogins

Use this function to fetch all existing Login Authentications\Login Profiles.

Roles Required: Admin and Users. Private Users can only View Logins they have created.

Request Syntax

{

“apiKey”: “string”,

“sort”: “String”,

“desc”: True/False

}


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 :

sort

Parameter Usage and Options :

In case you want to fetch these Logins in a specific order.

Value :

id|name|username|headers|type|url

Type :

String

Is it Optional ? :

Yes.


Parameter Name :

desc

Parameter Usage and Options :

In case you want to fetch the Targets in descending order.

Value :

True/False

Type :

Boolean

Is it Optional ? :

No – if you enable sort.


Successful Response

{
“Error”: 0,
“Function”: “DeleteLogin”,
“Data”: [
{
“id”: 1234,
“url”: “”,
“username”: “”,
“type_login”: “Header Authentication”,
“headers”: “”,
“name”: “LoginNameTest”,
“permission”: “Ok”
},

] }

Errors and their Possible Causes

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