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

# Authentication

Authenticate to the RealmJoin backend API with application credentials in a Base64-encoded HTTP Basic Authorization header.

## Overview

The RealmJoin backend expects application credentials (username and secret).

Username and secret will be created for you by our RealmJoin operations team. Please feel free to reach out if you want to integrate RealmJoin into your own tools and processes!

## Example

For the sake of demonstration, let us assume the username created for you is `t-12341234`and the secret is `myS3cret!`.

To authenticate, concatenate username and password, separated by a colon (`t-12341234:myS3cret!)`and encode this into a Base64-String.

Our example username and secret will encode to `dC0xMjM0MTIzNDpteVMzY3JldCE=`

Now, on every request against the RealmJoins backend service present an http header with the resulting Authorization:

```
Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE=
```

RealmJoin will then allow you to interact with resources in your environment. It will not allow you to interact with resources foreign to your tenant. Remember that RealmJoin Portal requires SSL/TLS transport layer encryption on every request - your credentials will not be exposed to the traversing networks.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/dev-reference/realmjoin-api/authentication.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.