Modifier and Type | Field and Description |
---|---|
static String |
CLIENT_PROGRAM_NAME |
static String |
CLIENT_PROGRAM_TOKEN |
Modifier and Type | Method and Description |
---|---|
APISession |
login(long tenantId,
Map<String,Serializable> credentials)
Connects the user in order to use API methods of a tenant.
|
APISession |
login(long tenantId,
String userName,
String password)
Connects the user in order to use API methods of a tenant.
|
static final String CLIENT_PROGRAM_NAME
static final String CLIENT_PROGRAM_TOKEN
APISession login(long tenantId, String userName, String password) throws LoginException, TenantIsPausedException
tenantId
- the tenant identifieruserName
- the user namepassword
- the passwordLoginException
- occurs when an exception is thrown during the login (userName does not exist, or couple (userName, password) is incorrect)TenantIsPausedException
- if the tenant is paused. No login is allowed for users other than the technical user.APISession login(long tenantId, Map<String,Serializable> credentials) throws LoginException, TenantIsPausedException
tenantId
- the tenant identifiercredentials
- the credentials to login with. Can be username / password, SSO ticket, ... depending on the implementation.LoginException
- occurs when an exception is thrown during the login (userName does not exist, or couple (userName, password) is incorrect)TenantIsPausedException
- if the tenant is paused. No login is allowed for users other than the technical user.Copyright © 2018 Bonitasoft S.A.. All rights reserved.