---
title: "Create a group mapping"
method: POST
path: "/group-mappings"
tags: ["Group Mappings"]
---

# Create a group mapping

`POST /group-mappings`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/group-mappings`
- Auth: none declared

Creates a group mapping.

## Request body

- object
  - `groupMapping` IapMappingSchema: This is the schema for an IAP group mapping stored in Mongo
    - `externalGroup` string, required: name of the external group
    - `provenance` string, required: The AAA provider for the external group
    - `iapGroups` string[], required

## Response `200`

Result of group mapping creation process.

- GroupMappingsSsoGroupMappingsCreateGroupMappingResponse200
  - `status` 'OK' | 'Created': The status of the API request.
  - `message` string: Message containing either confirmation of the operation or the reason for the failure of the operation.
  - `data` IapMappingSchema: This is the schema for an IAP group mapping stored in Mongo
    - `externalGroup` string, required: name of the external group
    - `provenance` string, required: The AAA provider for the external group
    - `iapGroups` string[], required

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Group Mappings` added
  - api tag `groupMappings` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/group-mappings/post.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)