> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/getting-started/authentication.md).

# Authentication

To start using our API, please perform the following steps to complete the Authorization and Authentication process.

* The customer must raise a ticket for on-boarding a tenant
* Once the tenant on-boarding is done, the following credentials are provided
* Using the above credentials, the tenant can perform HTTP requests. A sample screenshot is shown below\
  \
  `url --location --request POST 'https://auth.rightrev.cloud/auth/realms/<tenant_id>/protocol/openid-connect/token'`\
  `--header 'Content-Type: application/x-www-form-urlencoded'`\
  `--data-urlencode 'client_id='`\
  `--data-urlencode 'client_secret=<client_secret>`\
  `--data-urlencode 'grant_type=password'`\
  `--data-urlencode 'username=’`\
  `--data-urlencode 'password=<user_password>'`
* Once the authorization is successful, the tenant will get an access token as a response. A sample screenshot is shown below\
  \
  `"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJETUtHSkpR VlVpQm00Nnlyc29haWE1dllIUHVlZVd5Wk5vdkV2LU92TTcwIn0.eyJleHAiO jE2MDgyODk1OTQsImlhdCI6MTYwODI4OTI5NCwianRpIjoiZTA5MWFiZjgtOW Y4Zi00MDEwLWE3OWUtNTI0NmM4N2YzZjhkIiwiaXNzIjoiaHR0cDovL2F1dGg ucmlnaHRyZXYuY2xvdWQvYXV0aC9yZWFsbXMvY2hlY2tpbmciLCJhdWQiOlsi YmFja2VuZCIsIjBhNGUyOWFjMDhiZDQ5Nzc4OGFjNTI0ZCIsImFjY291bnQiX Swic3ViIjoiNWU3ODM1N2MtMjczNS00ZmQ0LThiOWUtOGU2NTg1NmU3MTRkIi widHlwIjoiQmVhcmVyIiwiYXpwIjoiMGE0ZTI5YWMwOGJkNDk3Nzg4YWM1MjR kIiwic2Vzc2lvbl9zdGF0ZSI6IjIxMGEwNzRlLWMyNzgtNGMxMC05MWRhLTdi YzA4ZDBhM2ZjYxN7BM4KD2O2a-mYE07pujUWR9XhkqZyJ2X7jnbNYnfcqHmo0 u4x7P_KChhci1bE1jSXdzDFKJDeIrb-pC2pgTtjMB502ZC0E3vhWq_wrnpMze xoeoFuqHNJIXRwNa08zx0dzTTp6HxWUw8rjKlQA5HGuxyCrnN9mlqdnprunl7 Us2eN6NZosWyOQLfnMhKEzNV796zcFG73u_zQ", "expires_in": 300, "refresh_expires_in": 1800, "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmZDA2YzUy ZC0wZGFhLTRmMWEtYjUyYS1mNGZjY2Y5MTkzM2QifQ.eyJleHAiOjE2MDgyOT OTc3ODhhYzUyNGQiLCJzZXNzaW9uX3N0YXRlIjoiMjEwYTA3NGUtYzI3OC00Y zEwLTkxZGEtN2JjMDhkMGEzZmNhIiwic2NvcGUiOiJwcm9maWxlIGVtYWlsIn 0.9fTMUAkgcS9UmeNcoTHztsgd7enbexX9AwM03MOonDA", "token_type": "bearer", "not-before-policy": 0, "session_state": "210a074e-c278-4c10-91da-7bc08d0a3fca", "scope": "profile email" }`
* Use this Token, while trying to access the RightRev API specifications in Swagger/PostMan Utility.

  Once the above mentioned steps are completed we are ready to access the API specifications

<table><thead><tr><th width="180">Credentials</th><th>Description</th></tr></thead><tbody><tr><td>Token URL</td><td>An URL to access a token</td></tr><tr><td>Username</td><td>Name of the resource owner</td></tr><tr><td>Password</td><td>Password of the resource owner</td></tr><tr><td>Client ID</td><td>Recognized as an Application ID in the registered app</td></tr><tr><td>Client Secret</td><td>Is a secret known to an authorization server that protects the resources by providing tokens only to the authorized user</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apis.rightrev.com/getting-started/authentication.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.