Identity Management - REST Interface
Independent from the used identity provider there are some REST like endpoints to read & manage users, organisations, roles and rights. Please note, that not all functions are supported by all identity providers. In case a function is not supported, a UnsupportedOperationException gets thrown. All calls are logged in the audit log.
API
To use the API endpoints, a valid session or better an API-Key is necessary. Since BPC 3, the requesting user must have appropriate roles and rights.
Method | Endpoint | Role | Right | Description |
---|---|---|---|---|
|
/cxf/bpc-core/im/users |
|
|
Returns a JSON-list with all users. JSON response
|
|
/cxf/bpc-core/im/users |
|
|
Creates a new user. JSON body
|
|
/cxf/bpc-core/im/users/{userId} |
|
|
Get user info. JSON body
|
|
/cxf/bpc-core/im/users/{userId} |
|
|
Updates a user. JSON body
|
|
/cxf/bpc-core/im/users/{userId} |
|
|
Updates the password of a user. Form parameter
|
|
/cxf/bpc-core/im/users/{userId} |
|
|
Deletes a user. |
|
/cxf/bpc-core/im/organisations |
|
|
Returns a JSON-list with all organisations. JSON response
|
|
/cxf/bpc-core/im/roles |
|
|
Returns a JSON-list with all roles. JSON response
|
|
/cxf/bpc-core/im/rights |
|
|
Returns a JSON-list with all rights. JSON response
|
|
/cxf/bpc-core/im/users/{userId}/organisations |
|
|
Returns a JSON-list with the organisations the user belongs to. JSON response
|
|
/cxf/bpc-core/im/users/{userId}/organisations |
|
|
Adds a user to an organisation. JSON body
|
|
/cxf/bpc-core/im/users/{userId}/organisations/{organisationName} |
|
|
Removed the user from an organisation. |
|
/cxf/bpc-core/im/users/{userId}/roles |
|
|
Returns a JSON-list with the roles of a user. JSON response
|
|
/cxf/bpc-core/im/users/{userId}/roles |
|
|
Adds a role to a user. JSON body
|
|
/cxf/bpc-core/im/users/{userId}/roles/{roleName} |
|
|
Removes a role from a user. |
|
/cxf/bpc-core/im/users/{userId}/rights |
|
|
Returns a JSON-list with the rights of a user. JSON response
|
|
/cxf/bpc-core/im/users/{userId}/rights |
|
|
Adds a right to a user. JSON body
|
|
/cxf/bpc-core/im/users/{userId}/rights/{rightName} |
|
|
Removes a right from a user. |
Special case Bosch IM3
When accessing the Bosch IM3 it is necessary to use/set a user with the mandatory rights to access the data. By default, it is the 'Admin'-user with the password 'Admin' and the tenant 'DEFAULT'. This can be done by using the Karaf-console (exactly that user gets set in the example below):
virtimo@virtimo()> config:edit de.virtimo.bpc.core virtimo@virtimo()> config:property-set de.virtimo.bpc.core.im3.admin.tenant DEFAULT virtimo@virtimo()> config:property-set de.virtimo.bpc.core.im3.admin.username Admin virtimo@virtimo()> config:property-set de.virtimo.bpc.core.im3.admin.password Admin virtimo@virtimo()> config:update