Die BPC Version 4.1 wird nicht mehr gewartet.

Sollten Sie diese BPC Version nutzen, empfehlen wir Ihnen eine Migration auf eine aktuelle Version. Die Dokumentation zur neusten BPC Version finden Sie hier. Sollten Sie Fragen haben, wenden Sie sich bitte an unseren Support.

Method Endpoint

GET

/cxf/bpc-core/authentication

Description

Check if the user session is valid. This function checks for the presence of an ssoToken. If a token is found, it is verified with the identity provider. If no token is found or the verification fails, a 401 "UNAUTHORIZED" response will be returned. If the token is confirmed by the provider, a 200 OK response will be sent.

Returns

The user session as JSON.

HTTP Status Code

  • 200: OK

  • 401: Unauthorized

Content-Type

  • application/json

Required Access Rights

Can be used without a user session.

DELETE

/cxf/bpc-core/authentication

Description

Terminates the current user session.

Returns

HTTP Status Code

  • 200: OK when no user flow identity provider is in use

  • 205: OK when a user flow identity provider is in use

Required Access Rights

Can be used without a user session.

DELETE

/cxf/bpc-core/authentication/sessions/all

Description

Destroy all user sessions.

Returns

HTTP Status Code

  • 200: OK

Required Access Rights

The logged-in user or API key must have either the following role or permission.

  • Role: USER_ADMIN

  • Right: USER_DELETE_SESSIONS

DELETE

/cxf/bpc-core/authentication/sessions/{sessionId}

Description

Destroys a specific user session.

Path Parameter

sessionId

the non-hijackable ID of the user session to destroy

Returns

HTTP status code

  • 200: OK

Required Access Rights

The logged-in user or API key must have either the following role or permission.

  • Role: USER_ADMIN

  • Right: USER_DELETE_SESSIONS

POST

/cxf/bpc-core/authentication

Description

Form-based login. Credentials are forwarded to the identity provider. If the login is successful, the ssoToken is set as a cookie in the response, and the information from provider is returned as JSON.

Consumes

  • application/x-www-form-urlencoded

Returns

The user session as JSON.

HTTP Status Code

  • 200: OK

Content-Type

  • application/json

Required Access Rights

Can be used without a user session.

PUT

/cxf/bpc-core/authentication

Description

Form-based update of an existing session with the given tenant name.

Consumes

  • application/x-www-form-urlencoded

Form Parameter

tenantname

the name of the tenant

Returns

The user session as JSON.

HTTP status code

  • 200: OK

Content-Type

  • application/json

Required Access Rights

A logged-in user or API key is required.

PUT

/cxf/bpc-core/authentication/language/{lang}

Description

Set the provided language in the user session. When Keycloak is used as an IdP, the language is set in the Keycloak user profile (locale).

Path Parameter

lang

the language to set

Returns

HTTP Status Code

  • 200: OK

Content-Type

  • application/json

Required Access Rights

Can be used without a user session.

POST

/cxf/bpc-core/authentication/reset

Description

Forwards the provided body to the user self-service portal of the currently used identity provider.

Consumes

  • application/x-www-form-urlencoded

Returns

The response from the user self-service

HTTP Status Code

  • 200: OK

  • 500: Something is wrong with the identity provider settings

Content-Type

  • application/json

Required Access Rights

Can be used without a user session.

POST

/cxf/bpc-core/authentication/changepassword

Description

Form-based update of the user’s password. If the IdP does not support updating user passwords, the user self-service is used.

Form parameters to provide:

  • username - the name of the user whose password is to be changed

  • oldPassword - the old password

  • newPassword - the new password

Consumes

  • application/x-www-form-urlencoded

Returns

HTTP Status Code

  • 200: OK

Content-Type

  • application/json

Required Access Rights

A logged-in user or API key is required.

POST

/cxf/bpc-core/authentication/{userName}/impersonate

Description

Impersonate a user. Works only when Keycloak is used as the identity provider.

Path Parameter

userName

the name of the user to impersonate

Returns

The user session as JSON.

HTTP Status Code

  • 200: OK

  • 500: No username given

  • 500: No user session provided

  • 500: Current identity provider does not support impersonation

Content-Type

  • application/json

Required Access Rights

The logged-in user or API key must have either the following role or permission.

  • Role: IDENTITY_MANAGER_ADMIN

  • Right: IDENTITY_MANAGER_USER_IMPERSONATE

POST

/cxf/bpc-core/authentication/user/info/{accessTokenType}/token

Description

Get user info using an access token. Can only be used with an OpenID Connect provider.

CURL example using 'bearer' as the access token type
curl -X POST \
    --header 'X-ApiKey: <YourApiKey>' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'accessToken=<ValueOfTheAccessToken>'  \
    'http://localhost:8181/cxf/bpc-core/authentication/user/info/bearer/token'

Consumes

  • application/x-www-form-urlencoded

Path Parameter

accessTokenType

the type of the given access token. Can be bearer, dpop, or mac. Keycloak appears to use 'bearer'.

Form Parameter

accessToken

the user’s access token to retrieve the user’s information

Returns

The requested user info as JSON.

HTTP Status Code

  • 200: OK

  • 500: Access token type missing or not supported

  • 500: Access token missing

  • 500: Current identity provider does not support token exchange

Content-Type

  • application/json

Required Access Rights

The logged-in user or API key must have either the following role or permission.

  • Role: USER_ADMIN

  • Right: GET_USER_INFO_BY_TOKEN
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen