Programmatic access

RITM allows programmatic access through API keys created by admin users.

API Keys allow the branded apps that you define to communicate with OneWelcome RITM, through our API, allowing custom configuration and integration.

You may choose to configure it to allow access for only a limited period of time, to work only for specific IPs or to restrict its usage to a number of times. For security reasons, an API key that you create is only displayed once, at creation time.

When generating a new API key, we require the following information:

• Validity date - for the case where you'd like to restrict access to a specific period;
• IP ranges (allows 1 or more IPs to be inserted) - for the case you'd like to restrict access from specific locations;
• Number of times each key can be used - for the case you'd like to restrict usage to a specific number of times.

We use OpenID Connect protocol for managing authentication of branded apps to the organisation's data stored with OneWelcome IAM or OneWelcome RITM.