Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The authentication request for accessing the BimPlus resource should be sent in the JSON format using the Keycloak Authorization service. The registered user name and password in the

Newwindowlink
titleBimplus portal
urlhttps://portal-stage.bimplus.net
should be provided here.

Received token should be directly used to access BimPlus resources after receiving it from Keycloak. Refreshing and revoking of the tokens are also managed by Keycloack, not BimPlus. Old authentication service in BimPlus remains only for backward compatibility and will be removed in 2026.

Please, use the client_id from the request and regenerate the token (using the same API call with client_id as the additional parameter) for having the possibility to login multiple times at the same time. For more information, see here

 
Composition Setup


Deck of Cards
idrequestToken


Card
labelHTTP Method
 POST


Card
labelURL / Resource / Parameters
 Resource: authorize 

URLhttps://api-stage.bimplus.net/v2/authorize

JSON Structure

Name

Mandatory / Optional

Type

Description

user_id

mandatory

string

The email address of the user

password

mandatory

string

The user's password

client_id

optional

string

The identifier of the used client (browser, Apps etc)

application_id

mandatory

string

The id of the application



Card
labelDescription
Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.


Card
defaulttrue
labelRequest


Code Block
borderColorGreen
titleHeaders
Content-Type: application/json


Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
}



Card
labelResponse


Code Block
borderColorGreen
titleStatus
Status: 200 OK


Code Block
borderColorRed
titleJSON
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
}



3. Receive the authentication token 

Obsolete. The token is received in the request.

...