Login
Login to the commcell using this request and save the token before calling any other API
- application/json
Request Body required
- Login-SaaS
- Login-CustomerManaged
- username string required
User email ID
- password string required
A Base64 UTF-8 encoded password for the user.
- commserver string
The option to log in to a remote CommServe. If this parameter is not used, the user is logged in to the CommServe associated with the Web Server. Use the following values for the commserver parameter: commserve_host_namecommserve_name .The CommServe host name and the CommServe name must be separated by an asterisk (). Example: commserver="client.mydomain.com*testcs"
- domain string
If the user logging in is a domain user, the domain parameter must be set to the domain associated with the user.
- password string required
A Base64 UTF-8 encoded password for the user.
- username string required
Username of the user
- deviceId string
Add a device ID which can used to renew token after expiry
- timeout integer
Default value:
30Timeout of the token in minutes
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
- Example 2
Schema
- LoginResponse-SaaS
- LoginResponse-CustomerManaged
data object
authToken stringThe Authentication Token that should be added to the bearer token for all requests
- aliasName string
The alias name.
- userGUID string
The globally unique identifier for the user
- loginAttempts integer
Number of login attempts
- remainingLockTime integer
Number of attempts remaining
- smtpAddress string
User email ad
- userName string
Username of the user
- providerType integer
Internal field
- ccn integer
An internal reference number.
- token string
The authentication token that must be inserted into the Authtoken header for all requests
- capability integer
An internal field
- forcePasswordChange boolean
- isAccountLocked boolean
True if the account is locked
ownerOrganization object
Reseller company info
GUID stringGlobal Unique ID for the reseller company
providerId integerReseller Company ID
providerDomainName stringReseller Company Name
additionalResp object
An Internal field
nameValues object[]
Name value pairs
name stringvalue stringproviderOrganization object
Company Info
GUID stringGlobal Unique ID for the company
providerId integerCompany ID
providerDomainName stringCompany Name
- errList object[]
company object
Company Info
providerId integerId of the company
providerDomainName stringName of the company
{
"data": {
"authToken": "string"
}
}
{
"aliasName": "1",
"userGUID": "AC3E5333-4585-4EFD-B566-4654C5C88C27",
"loginAttempts": 0,
"remainingLockTime": 0,
"smtpAddress": "email@domain.com",
"userName": "testadmin",
"providerType": 1,
"ccn": 0,
"token": "QSDK ",
"capability": 4328650366975,
"forcePasswordChange": false,
"isAccountLocked": false,
"ownerOrganization": {
"providerId": 0,
"providerDomainName": "Qinetix Commcell"
},
"providerOrganization": {
"providerId": 0,
"providerDomainName": "Qinetix Commcell"
},
"errList": []
}
{
"aliasName": "1",
"userGUID": "80ECA8AB-E88E-4B71-A5BE-233932068CC2",
"loginAttempts": 0,
"remainingLockTime": 0,
"smtpAddress": "test@test.com",
"userName": "admin",
"providerType": 1,
"ccn": 0,
"token": "QSDK ",
"capability": 4328650366975,
"forcePasswordChange": false,
"isAccountLocked": false,
"ownerOrganization": {
"GUID": "95189d4e-4a7f-4cb3-969f-80d5871ac13f",
"providerId": 0,
"providerDomainName": "Commcell"
},
"additionalResp": {
"nameValues": [
{
"name": "USERNAME",
"value": "admin"
},
{
"name": "autoLoginType"
},
{
"name": "fullName",
"value": "Administrator"
}
]
},
"providerOrganization": {
"GUID": "95189d4e-4a7f-4cb3-969f-80d5871ac13f",
"providerId": 0,
"providerDomainName": "Commcell"
},
"errList": [],
"company": {
"providerId": 0,
"providerDomainName": "Commcell"
}
}