REST API Consumer from Catalog
  • 15 Jun 2022
  • 3 Minutes to read
  • Dark

REST API Consumer from Catalog

  • Dark

Article Summary

Setting up a REST API Consumer from the Catalog

  1. First, you'll need to go to RapidIdentity Studio > Applications tab. Click Add Application, and from there, Select From App Library.
    New Consumer From App Library.png

  2. It is simpler to choose a Consumer from the Catalog if you Filter by Application type. Choose Consumer from the drop-down menu.
    Filter by App Type.png

  3. Choose a Consumer that fits your needs. For this example, we'll set up a OneRoster REST Consumer, as these are very common. Click the tile to open up the installation sidebar and click Install.
    OneRoster REST Consumer Template.png

  4. Another sidebar will appear to determine the prefix for this Consumer. Accept the default or edit to represent something different, and this will be your prefixes for job and mapping purposes. Once again, click Install.
    Consumer Prefix.png

  5. Once the template has been installed from the catalog, you will be brought to a Connection Settings Screen. Most templates will have the Connection Type already populated and some recommended settings selected for Credential Type and Signature Method. All that needs to be done now is to enter the Consumer Secret, and provide a Callback URL if needed. Access Tokens and Token Secrets are preprogrammed for future development and are not recommended for use at this time.
    REST Consumer Credentials - Empty.png

    1. Generate a Consumer Key by clicking the button. This key/secret pair will be given to the Consumers for access to the records processed for this particular vendor. A sidebar will pop up, showing you the consumer key and asking if you want this key to be applied to this Consumer. Click Yes for the system to populate the field. Copy this key and keep it in a safe location until it has been given to the vendor. Generate Consumer Key.pngPopulated Consumer Key.png

    2. Now create and use a Consumer Secret.
      NOTE: The Consumer Secret will NOT be visible after it has been generated, so remember to copy the secret before saving and store it in a safe location until it can be given to the vendor.Generate Consumer Secret.pngPopulated but Hidden.png

    3. Access Tokens are reserved for an upcoming REST authentication method, so it s best to leave these blank for now.

    4. Callback URL is optional, but allows you to set a Callback URL for your application.
      Callback URL.png

    5. Don't forget to Save!

  6. If desired, configure Access Groups for this Consumer.

  7. To link an SSO Application to this Consumer, choose those in the Linked Apps tab. Only existing SSO Applications that are not linked to another Consumer will be available.Linked Apps for REST Consumer.png

  8. In the Advanced tab, note that the Record Definitions and Record Mappings have already been configured with the basics expected by a OneRoster REST Consumer. More can be added if needed, and existing mappings can be altered or disabled to better represent the data being sent.

  9. In Jobs, run all of the Consumer Mapping jobs associated with this consumer. NOTE: Make sure the Mapping Jobs have been run recently to ensure the Consumer receives the most updated data. These can be set to run one at a time, or all at once. The larger the job, the longer it will take to run. This will pull the data from the Identity Hub and set it up for the Consumer to access.
    oneRoster Consumer Mapping Jobs.png

  10. Give the Consumer Key and Consumer Secret to the vendor. There are no Consumer Jobs that need to be run, as for REST API Consumers, the responsibility for getting the data belongs to the vendor. However, you will need to schedule the Mapping jobs to run early enough or frequently enough that the vendor can always get the most accurate data whenever they access the records.

That is how you configure a Web Service REST API Consumer in RapidIdentity Studio!

Was this article helpful?