RDM Integration

URLs


URL
REF
ABN
PROD
API endpoint https://services.portal-r.
eiam.admin.ch/portal/rdm-api/v2/
https://services.portal-a.
eiam.admin.ch/portal/rdm-api/v2/
https://services.portal.
eiam.admin.ch/portal/rdm-api/v2/
API swagger UI (to try the API in the browser) https://services.portal-r
.eiam.admin.ch/portal/rdm-api/swagger-ui/index.html
https://services.portal-a
.eiam.admin.ch/portal/rdm-api/swagger-ui/index.html
https://services.portal.
eiam.admin.ch/portal/rdm-api/swagger-ui/index.html
Onboarding landing page (needed when your application sends onboarding eMails/letters)
https://www.myaccount-r.
eiam.admin.ch/portal/
selfadminservice/app
/onboarding
https://www.myaccount-a.
eiam.admin.ch/portal/
selfadminservice/app
/onboarding
https://www.myaccount.
eiam.admin.ch/portal/
selfadminservice/app
/onboarding

Authorization

Access will be with a client certificate bound to a technical user account. You need to order this technical account by Remedy. For RDM 2.0 the following roles are needed:
  • DelegatedManager_User
  • DelegatedManager_Permission

Technical description

For a detailed technical description, please look at the swagger definition. You either can use the API swagger UI link listed above or you could load the swagger file into the public available editor Swagger file editor. In this case you cannot try the methods, but only read the description.

With the swagger editor (both ways) you also can create your html documentation, client stubs to start client side development or server side stubs to create mocks.

Here you can find the current yaml file which can be downloaded and opened in the Swagger Editor: Swagger File.

When you add user using nevisIDM SOAP

When you don't add user RDM, but eg using nevisIDM SOAP API then you need to set the Onboarding ready state explicitely:

nevisIDM SOAP API


Access Swagger UI – a quick look at the RDM API

The RDM API makes its OpenAPI specification available via Swagger UI, secured by the same 2-way TLS (client certificate) as the SOAP/REST endpoints.
These steps are intended solely to provide a quick overview of the API.

Prerequisites

A TechUser account (applied for via OPS) with the corresponding client certificate (.p12) for the desired environment (DEV/TEST/REF/ABN/PROD).

Procedure

  • Import the certificate into the browser
    - Firefox (recommended): Settings → Privacy & Security → Certificates → Manage Certificates → My Certificates → Import → Select .p12 → Enter password.
    - Chrome / Edge: Use the Windows certificate store (double-click on .p12 or certmgr.msc).
  • Open the environment’s Swagger UI URL
  • See the ‘URLs’ table at the top of this page (Swagger UI / REST FQDN column).
  • Select the TechUser certificate in the browser pop-up.
  • The Swagger UI loads; endpoints can be tested straight away (e.g. POST /v2/clients/{clientExtId}/onboarding).

    Note: Never use test certificates in production environments. For automated use (scripts, CI/CD), use the certificate programmatically – not via the browser.