Accessing RapidIdentity APIs

Swagger API Documentation

RapidIdentity Connect and other programs will occasionally need to access direct API points for RapidIdentity. Accessing these is fairly simple.

1. Open a browser tab and navigate to https://<RapidIdentity Host name or IP Address>/api/rest/api-docs.

   Note

   For RapidIdentity Cloud you MUST be a member in the API Developer Group to view this documentation. This URL can be bookmarked for convenience.

   
   

2. You can search for the specific API you are looking for in the Filter by tag field. Once you find it, click the title to expand and see the different commands that can be used with that API RESTpoint.
   

3. Use these commands on the API RESTpoints to finalize a Connect Action Set in RapidIdentity or provide one to a third party vendor as needed.