Rimo3 API
      Back to home
      1. Rimo 3 Knowledge Base & Help Center
      2. Rimo3 API

      Rimo3 API - Introduction and Obtaining an Access Token

      An introduction to using the Rimo3 API and a step-by-step guide to requesting a new Access Token.

      What is the Rimo3 API? 

      The Rimo3 API is a collection of endpoints that can perform the same functions presented in the Rimo3 web portal Graphical User Interface (GUI). Whether developer or non-developer, you can use these endpoints to create customized processes or integrate into existing processes where human interaction is not required.  

      For example, you could create a Rimo3 integration into an application update process. The process would be triggered via the Rimo3 API that onboards and tests the new application update against your Windows OS.  

      Another example would be that there is a Windows OS update that you need to deploy, and you want to automate the testing of your applications against the update before deploying. 

      Leverage Your Application Automation with Rimo3

      Application Lifecycle Management (ALM) can be extremely time consuming for organizations with complex environments and a high number Windows applications. By leveraging automation, organizations can make significant savings to time and thus cost, but also reduce risk and complexity. At Rimo3 we pride ourselves on applying automation to the complexity of ALM thus enabling you to transform traditional rollout project activities to simply being a day-to-day activity.

      How To Utilize the Rimo3 API 

      For this tutorial, we’re using PowerShell to interact with the various API endpoints available at time of writing.  

      As we release more API endpoints, we’ll continue highlighting new capabilities and opportunities. Before exploring the API, here are some key prerequisites you’ll need to start your testing.  

      1. A live Rimo3 tenant that’s been deployed to an Azure subscription
      2. An AppID and Client Secret to generate Access Tokens (AT). These are provided on demand.  

      Obtain an Access Token 

      Start by assigning the AppID, Client Secret, and Server URI to variables.  

      $client_id="0o**************4x7"
      $client_secret="j9********************************uV"
      $server_uri="https://rimo3cloud.com"

      Next, build out the Body, Header, and Parameter JSONs used to invoke the AT request.  

       

      $Body = @{
          grant_type = "client_credentials"
          scope = "access_token"
          client_id = $client_id
          client_secret = $client_secret
      }

      $Header = @{
          Accept = "application/json"
          "Content-Type" = "application/x-www-form-urlencoded"
          "Cache-control" = "no-cache"
      }

      $Parameters = @{
          Method = "POST"
          Uri = "https://rimo3.okta.com/oauth2/aus44**********6/v1/token"
          Headers = $Header
          Body = $Body
      }

      Next, request an AT and assign it to a variable.

      # Obtains a valid bearer token to use with api calls, valid for 1 hour
      $TokenResponse = Invoke-RestMethod @Parameters 

      The AT request returns a JSON response containing the required Access Token.

      You can finally pull this out of the JSON and assign to a variable to use in API calls.  

      # use this command to output the access token to confirm it is valid 
      return $TokenResponse.access_token

      # assign AT to variable 
      $token = $TokenResponse.access_token

       

      Something missing from this page or want to give feedback?