Token object

First available in 2014.1

Used by:

SystemsLink for TMWSuite
Vendor SystemsLink for TMWSuite

Methods

The Return Value for all methods is Token.ReturnObject.

Method Name	Parameters	Token.ReturnObject.ReturnCode	Description
	Name	Data type (in C#)
GetToken	userName	string	0 = Successful -60001 = Invalid Credentials -60002 = Inactive Credentials -60003 = Unable to find credentials -60000 = An exception occurred	Retrieves a token using the supplied credentials
	password	string
ReleaseToken	Token Value	string	0 = Successful -70001 = Invalid Token -70000 = An exception occurred	Releases the provided token
ValidateToken	token Value	string	0 = Successful -80001 = Expired Token -80002 = Invalid Token -80000 = An exception occurred	Attempts to validate the provided token
CreateCredentials	token Value	string	0 = Successful -10001 = Token does not have create rights -10000 = An exception occurred	Attempts to create a new user with valid credentials
	userName	string
	password	string
	active	bool
	external LoginId	string
Deactivate Credentials	token Value	string	0 = Successful -50001 = User cannot deactivate their own credentials -50002 = The token is not authorized to deactivate credentials -50003 = Credentials could not be found -50000 = An exception occurred	Attempts to deactivate the indicated credentials
	userName	string
Activate Credentials	tokenValue	string	0 = Successful -40001 = User cannot activate their own credentials -40002 = The token is not authorized to activate credentials -40003 = Credentials could not be found -40000 = An exception occurred	Attempts to activate the indicated credentials
	userName	string
ChangeCredentialPassword	tokenValue	string	0 = Successful -20001 = User cannot change their own password -20002 = Supplied token is not authorized to change password -20000 = An exception occurred	Attempts to change the password for the provided user
	userName	string
	new Password	string
ChangeExternal Link	tokenValue	string	0 = Successful -30001 = Supplied token is not authorized to change external link -30000 = An exception occurred	Attempts to change the external login associated with the provided user
	userName	string
	newExternalLink	string

Method Name

Parameters

Token.ReturnObject.ReturnCode

Description

Name

Data type (in C#)

GetToken

userName

string

0 = Successful

-60001 = Invalid Credentials

-60002 = Inactive Credentials

-60003 = Unable to find credentials

-60000 = An exception occurred

Retrieves a token using the supplied credentials

password

string

ReleaseToken

Token
Value

string

0 = Successful

-70001 = Invalid Token

-70000 = An exception occurred

Releases the provided token

ValidateToken

token
Value

string

0 = Successful

-80001 = Expired Token

-80002 = Invalid Token

-80000 = An exception occurred

Attempts to validate the provided token

CreateCredentials

token
Value

string

0 = Successful

-10001 = Token does not have create rights

-10000 = An exception occurred

Attempts to create a new user with valid credentials

userName

string

password

string

active

bool

external
LoginId

string

Deactivate
Credentials

token
Value

string

0 = Successful

-50001 = User cannot deactivate their own credentials

-50002 = The token is not authorized to deactivate credentials

-50003 = Credentials could not be found

-50000 = An exception occurred

Attempts to deactivate the indicated credentials

userName

string

Activate
Credentials

tokenValue

string

0 = Successful

-40001 = User cannot activate their own credentials

-40002 = The token is not authorized to activate credentials

-40003 = Credentials could not be found

-40000 = An exception occurred

Attempts to activate the indicated credentials

userName

string

ChangeCredentialPassword

tokenValue

string

0 = Successful

-20001 = User cannot change their own password

-20002 = Supplied token is not authorized to change password

-20000 = An exception occurred

Attempts to change the password for the provided user

userName

string

new
Password

string

ChangeExternal
Link

tokenValue

string

0 = Successful

-30001 = Supplied token is not authorized to change external link

-30000 = An exception occurred

Attempts to change the external login associated with the provided user

userName

string

newExternalLink

string

Token.ReturnObject

Token.ReturnObject includes the following properties:

Property Name	C# Data Type	Comments
ErrorMessages	List<string>
ErrorObjectIndexList	List<int>
Exceptions	List<Exception>
Released	bool
ReturnCode	int
Token	Token
TraceMessages	List<string>
Valid	bool
WarningMessages	List<string>

Property Name

C# Data Type

Comments

ErrorMessages

List<string>

ErrorObjectIndexList

List<int>

Exceptions

List<Exception>

Released

bool

ReturnCode

int

Token

TraceMessages

List<string>

Valid

bool

WarningMessages

List<string>

Token properties and column mapping

To condense the information in this table, the letter w in the Database Column Name refers to the WebSystemsLinkToken database table.

Property	Database Column	Modifiable	Comments
Name	Data Type (in C#)	Name	Data Type
EncryptedKey	string	w.SymmetricKey	varchar(max)	Read Only
EncryptedIv	string	w.SymmetricIv	varchar(max)	Read Only
Expiration	DateTime	w.ExpirationDate	datetime	Read Only
Released	bool			N/A	Not mapped
TokenValue	string	w.Token	varchar(255)	Read Only
Valid	bool			N/A	Not mapped

Property

Database Column

Modifiable

Comments

Name

Data Type (in C#)

Name

Data Type

EncryptedKey

string

w.SymmetricKey

varchar(max)

Read Only

EncryptedIv

string

w.SymmetricIv

varchar(max)

Read Only

Expiration

DateTime

w.ExpirationDate

datetime

Read Only

Released

bool

N/A

Not mapped

TokenValue

string

w.Token

varchar(255)

Read Only

Valid

bool

N/A

Not mapped