Authentication
Each call against our API must be authenticated as a registered user in the system to enable the proper permission management.
The authenticated user must:
• Be part of a User Group having Rest / Remote API - Access permission.
• have at least read permission to the requested resource in the requested state.
There are three types of authentications supported.
Basic authentication
This option uses the HTTP basic authentication
method, where the provided username and password are encoded into the Authorization header.
method, where the provided username and password are encoded into the Authorization header.
Bearer authentication
The Bearer authentication is used where OpenID is configured as an authentication layer in Codebeamer.
is configured as an authentication layer in Codebeamer.It's the responsibility of the client to acquire the access token from the OpenId provider. Once the token is acquired it can be provided in the Authorization header.
Api Key authentication
This is for internal use only.
As our internal processes are relying on our API so this method is used to authenticate between our components.