> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tangoanalytics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# User provisioning nonbu api

# Tango User Provisioning API (non-BU)

> Generated from `Tango User Provisioning API Integration Design Specification_non BU V1.2.docx` in SharePoint folder `01 Common Integrations`.
> OAS spec: [`user-provisioning-nonbu-api.yaml`](./user-provisioning-nonbu-api.yaml)

## Overview

Async REST API: same endpoint as the [BU User Provisioning API](./user-provisioning-bu-api.md) (`/v1/usermgmt/batch/users`) but for client environments **without** a Business Unit layer. The `brands[]` items have no `business_unit` field — access scopes by Brand / Country / Region / Role only.

**Owner:** Tango Analytics
**Spec version:** 1.2
**Status:** Draft (auto-generated — needs review)

## Differences from the BU variant

| Aspect | BU variant | non-BU variant |
| - | - | - |
| `business_unit` field | Required per Brand assignment | **Removed** |
| `default_bu` field | Optional default | **Removed** |
| Endpoint | `/v1/usermgmt/batch/users` | Same |
| Status endpoint | `/batch/status` (no `/v1`) | Same |
| All other fields and behaviour | — | Same as BU variant |

The integration logic, validations, GENERAL\_USER special case, inactivation flow, and entity-security model are otherwise identical to the BU variant — see [`user-provisioning-bu-api.md`](./user-provisioning-bu-api.md) for the full details.

## Base URLs

| Environment | URL |
| - | - |
| Production | `https://api.tangoanalytics.com` |
| Test (SIT/UAT) | `https://testapi.tangoanalytics.com` |

## Authentication

Headers `x-client` + `x-api-key`.

## Endpoints

| Method | Path | Summary |
| - | - | - |
| PUT | `/v1/usermgmt/batch/users` | Insert / update / inactivate users (async). |
| GET | `/batch/status?gu_id=...` ⚠ | Poll processing status (no `/v1` prefix in source). |

## Data model — Brand Assignment (non-BU, required ✅)

| Field | Type | Req | Notes |
| - | - | - | - |
| `brand_name` | VARCHAR | ✅ | Brand name |
| `country` | VARCHAR | ✅ | `ALL` or comma-separated ISO 3-letter codes |
| `region` | VARCHAR | ✅ | `ALL` or comma-separated region identifiers |
| `roles` | VARCHAR | ✅ | Tango Profile Name(s). Blank when `user_type = GENERAL_USER` |
| `entity_security` | array | – | Lease / Project entity-security restrictions |

## Open Questions / Assumptions

* [ ] **Same endpoint for BU and non-BU**: both specs target `/v1/usermgmt/batch/users`. Tango disambiguates based on whether `business_unit` is present in the request. Confirm there's no separate non-BU endpoint.
* [ ] **Status endpoint missing `/v1` prefix** — same anomaly as the BU variant.
* [ ] **Same caveats** apply for the GENERAL\_USER extra-fields behavior, default-resolution rules, and unfilled lookup tables in the Appendix.

## Changelog

| Ver | Date | Description | Author |
| - | - | - | - |
| 0.1–1.0 | 2022-2024 | (see source doc) | Various |
| 1.1 | 03/17/2025 | Updated User Inactivation logic | Rahma Ouedraogo |
| 1.2 | 04/23/2026 | Updated API architecture diagram | Alpna Bansal |