Authentication Operations

post /AppSpiderEnterprise/rest/v1/Authentication/Login

Description

Retrieves the token for current credentials

Parameters

Name	Type	Required	Description
name	string	Y	User’s username
password	string	Y	User’s password
clientId	string	N	User’s client id. If the user is considered a multi-client account, this field is required to successfully authenticate. If not provided and authentication is successful, the response will have a list of clients the user may use for authentication

Response Messages

Response Status Code	Reason	Description
200		Authentication successful
400	InvalidJsonSchema	Required parameters not provided
401	InvalidCredentials	Provided credentials are invalid and/or user is not authorized to perform this action

Response example


{
    "type": "object", 
    "properties": {
       "IsSuccess": { 
          "type": "boolean", 
          "required": true
       }, 
       "Token": {
         "type": [ "string", "null" ], 
         "required": true
       }, 
       "ErrorMessage": {
         "type": [ "string", "null" ],
         "required": true 
       },
       "Reason": {
         "type": [ "string", "null" ], 
         "required": true
       } 
    },
   "additionalProperties": false 
}

Reference Guide

/Authentication/Login /AppSpiderEnterprise/rest/v1/Authentication/Encrypt

Description

Returns an encrypted string

Parameters

Name	Type	Required	Description
stringToEncrypt	string	Y	String to encrypt

Response Messages

Response Status Code	Reason	Description
200		Encryption successful

Response example


{
    "type": "object", 
    "properties": {
       "IsSuccess": { 
          "type": "boolean", 
          "required": true
       }, 
       "EncryptedString": {
         "type": [ "string", "null" ], 
         "required": true
       }, 
       "ErrorMessage": {
         "type": [ "string", "null" ],
         "required": true 
       },
       "Reason": {
         "type": [ "string", "null" ], 
         "required": true
       } 
    },
   "additionalProperties": false 
}