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:

JSON schema:
1
{
2
    "type": "object", 
3
    "properties": {
4
       "IsSuccess": { 
5
          "type": "boolean", 
6
          "required": true
7
       }, 
8
       "Token": {
9
         "type": [ "string", "null" ], 
10
         "required": true
11
       }, 
12
       "ErrorMessage": {
13
         "type": [ "string", "null" ],
14
         "required": true 
15
       },
16
       "Reason": {
17
         "type": [ "string", "null" ], 
18
         "required": true
19
       } 
20
    },
21
   "additionalProperties": false 
22
}

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:

json
1
{
2
    "type": "object", 
3
    "properties": {
4
       "IsSuccess": { 
5
          "type": "boolean", 
6
          "required": true
7
       }, 
8
       "EncryptedString": {
9
         "type": [ "string", "null" ], 
10
         "required": true
11
       }, 
12
       "ErrorMessage": {
13
         "type": [ "string", "null" ],
14
         "required": true 
15
       },
16
       "Reason": {
17
         "type": [ "string", "null" ], 
18
         "required": true
19
       } 
20
    },
21
   "additionalProperties": false 
22
}