> For the complete documentation index, see [llms.txt](https://documentation.immuta.com/SaaS/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.immuta.com/SaaS/configuration/people/section-contents/reference-guides/custom-external.md).

# External User Info Endpoint

Learn how Immuta can pull in user attributes from an external HTTP endpoint

Immuta can consume user attributes from an external HTTP endpoint. This feature allows you to retrieve users' groups and authorizations from an additional resource alongside the user attributes retrieved in the authentication flow. Such an external endpoint can be configured for any of the identity management protocols that Immuta supports.

## Authentication

The service can authenticate requests with both of these methods:

* Basic username and password `Authorization` header
* SSL cert validation

*Note: Immuta will expect non 200 error codes when the user info cannot be retrieved.*

## GET /user-info

The user info endpoint is called each time Immuta needs to synchronize with a remote IAM on user groups and attributes. Immuta will query the endpoint with the user ID specified in the request's query.

*Note: The endpoint's path does not have to be* `/user-info`*.*

**Query parameter**

| Name                | Description                                     | Required |
| ------------------- | ----------------------------------------------- | -------- |
| **userid** `string` | The unique user identifier (username in Immuta) | Yes      |

**Response**

| Code    | Description                                             |
| ------- | ------------------------------------------------------- |
| **200** | successful operation - user info retrieved successfully |

**Response schema**

| Attribute          | Example                                 |
| ------------------ | --------------------------------------- |
| **groups**         | `[{"name": "<group_name>"}]`            |
| **authorizations** | `{"<authorization_name>": ["<value>"]}` |

Below is a sample response that could be returned by the endpoint.

```json
{
  "groups": [{
    "name":  "Accountants",
  }, {
    "name":  "Controllers",
  }],
  "authorizations": {
    "EMEA": ["Sales", "Expenses"],
    "APAC": ["Sales"]
  }
}
```


---

# 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://documentation.immuta.com/SaaS/configuration/people/section-contents/reference-guides/custom-external.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.