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

# Collibra REST API authentication

In this tutorial you install Postman, an API Development Environment, and learn how to use basic authentication.

{% hint style="info" %}
Almost all of the Collibra API calls require authentication.
{% endhint %}

## Postman

{% hint style="info" %}
If you prefer using another application, you can skip this step.
{% endhint %}

{% hint style="info" %}
Some references might be specific to the Postman application.
{% endhint %}

Although REST API calls do not necessarily require one specific program, and you can try them out directly from the Collibra API documentation, Postman can act as an HTTP client to send a request and receive a response.

To try API calls from the Collibra API documentation, go to https\://\<your\_collibra\_url>/docs/index.html.

To install Postman:

1. [Download Postman](https://www.getpostman.com/downloads/) corresponding to your operating system.
2. Install the Postman application:
   * Windows:
     * Run the installer.
   * MacOS:
     * Unzip the application.
     * Move the application to the **Applications** folder.
   * Linux:
     * Unzip the application into your preferred folder.

For additional installation instructions, see the [Postman documentation](https://learning.getpostman.com/docs/postman/launching_postman/installation_and_updates/).

You can use Postman without an account. To do so, click the **Skip signing in and take me straight to the app** link at the bottom of the start-up screen.

{% hint style="success" %}
Creating an account allows you to access your call history and saved data across devices and in the web client.
{% endhint %}

For simple API operations there are a few areas that we will focus on:

![](/files/tP5ZVcLkTRRpMMxGe5lF)

| Element | Name   | Description                         |
| ------- | ------ | ----------------------------------- |
| 1       | Method | A drop-down of API methods.         |
| 2       | URL    | The API call URL.                   |
| 3       | Params | The path parameters of the request. |
| 4       | Body   | The body parameters of the request. |
| 5       | Code   | A code generator for the request.   |

### Calls in Postman

To make a call in Postman:

{% stepper %}
{% step %}
Select the method
{% endstep %}

{% step %}
Enter the URL
{% endstep %}

{% step %}
Enter the required parameters
{% endstep %}

{% step %}
Click **Send**.
{% endstep %}
{% endstepper %}

```bash
GET https://<your_collibra_url>/rest/2.0/application/info
```

<i class="fa-chevrons-right">:chevrons-right:</i> You see the response and the status code in the Response area, in the bottom half of the screen.

<img src="/files/Q9ffqzo2qmzf9obep9yi" alt="" width="75%">

{% hint style="success" %}
To learn more about status codes, hover the pointer over the status.
{% endhint %}

## Basic authentication

You can use basic authentication to perform API calls.

In Postman:

{% stepper %}
{% step %}
Go to the **Authorization** tab.
{% endstep %}

{% step %}
From the **Type** drop-down menu, select **Basic Auth**.
{% endstep %}

{% step %}
Enter the **Username** and **Password**.
{% endstep %}
{% endstepper %}

<img src="/files/Af0l5xiAEQ8PiueRRnHM" alt="" width="75%">

<i class="fa-chevrons-right">:chevrons-right:</i> Postman will automatically encode the values and create a header to include an **Authorization** key.

<img src="/files/aPNdLrxk15LeS4fQmCme" alt="" width="75%">

To pass this information inside your code include a header key `Authorization` with the value `Basic <Base64_encoded_values>`. The encoded values are `<username>:<password>`.

```bash
curl -H 'Authorization: Basic QWRtaW46YWRtaW4='
```

## Next steps

Now that you can authenticate, follow the [next tutorial](https://developer.collibra.com/tutorials/create-data-with-rest-api) to learn how to create communities, domains, assets and how to add definitions via the Collibra REST API.

## Additional resources

* Consult the REST API documentation provided with your version of Collibra Platform at https\://\<your\_collibra\_url>/docs/index.html.
* Read the [Collibra JSON Web Token authentication guide](https://developer.collibra.com/tutorials/rest-api-json-web-token/).
* Read the [Collibra REST API authentication with JSON Web Token](https://developer.collibra.com/tutorials/rest-api-authentication-jwt/) tutorial.
* Read the [Collibra Platform Configuration](https://productresources.collibra.com/docs/collibra/latest/Content/Console/co_console.htm) section of the documentation.


---

# 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:

```
GET https://developer.collibra.com/tutorials/collibra-rest-api-authentication.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.