Package nl.bimbase.bimworks.client.apis
Class AuthApi
java.lang.Object
nl.bimbase.bimworks.client.apis.SubApi
nl.bimbase.bimworks.client.apis.AuthApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Login anonymouslyvoid
loginWithApiToken
(String apiToken) Login with an API Token.com.fasterxml.jackson.databind.node.ObjectNode
loginWithUsernamePassword
(String username, String password) Login with a username/password.void
Register a new userMethods inherited from class nl.bimbase.bimworks.client.apis.SubApi
getBimWorksClient
-
Constructor Details
-
AuthApi
-
-
Method Details
-
loginWithUsernamePassword
public com.fasterxml.jackson.databind.node.ObjectNode loginWithUsernamePassword(String username, String password) throws BimWorksException Login with a username/password. Only use this for testing purposes, in most cases using an API Token is safer.- Parameters:
username
-password
-- Returns:
- Throws:
BimWorksException
-
loginWithApiToken
Login with an API Token. Generally you should not call this method manually, it is called already when creating a newBimWorksClient
usingBimWorksClientFactory.createClientWithApiToken(String)
- Parameters:
apiToken
- The API Token- Throws:
BimWorksException
-
loginAnonymous
-
register
Register a new user- Parameters:
username
- The requested username, should always be in the form of a valid email address- Throws:
BimWorksException
-