API references
The OneWelcome Identity Platform offers several APIs to integrate its processes with your existing systems:
-
User journey orchestration APIs:
API clients
Access to the APIs is managed with API clients.
For every API client, you need to configure the client ID and authentication method. The OneWelcome Identity Platform supports only client secret basic and private key JWT.
The API clients can be configured in the admin console: Configuration → System → API clients.
For each API client, you can specify which APIs it can access. This enables you to provide external systems using the OneWelcome Identity Platform APIs access to only specific functions.
API clients are required to use their credentials to authorize access to the OneWelcome Identity Platform APIs. These credentials, as well as the APIs that clients can access, can be configured with the following fields:
| Field | Required | Description |
|---|---|---|
| Name | yes | Name of the API configuration. It's used only in the admin interface. |
| Client ID | yes | The identifier of the client during requests |
| Client secret | yes | The secret of the client used during requests |
| Valid for APIs | yes | APIs to which the client has access |
Deprecation
Some existing features within the OneWelcome Identity Platform might become deprecated at some point for various reasons. We won't remove deprecated features immediately. This makes it possible to upgrade the OneWelcome Identity Platform while using the existing versions of the external systems that depend on it. Keep in mind that the deprecated features might be removed in the future. Therefore, it is a good practice to use the latest endpoints after previous versions are deprecated.
