Authentication Operations

/AppSpiderEnterprise/rest/v1/Authentication/Login

Description

Retrieves the token for current credentials

Parameters

NameTypeRequiredDescription
namestringYUser’s username
passwordstringYUser’s password
clientIdstringNUser’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 CodeReasonDescription
200Authentication successful
400InvalidJsonSchemaRequired parameters not provided
401InvalidCredentialsProvided 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

NameTypeRequiredDescription
stringToEncryptstringYString to encrypt

Response Messages

Response Status CodeReasonDescription
200Encryption 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 }