MetriBeacon
Menu

POST Create SCIM groups

/api/v1/scim/v2/{directory}/Groups

Create SCIM groups. Directory tokens are restricted to one directory. Deactivation revokes company access without deleting the personal account. Group mappings grant only Viewer or Editor.

On this page

Access and permissions

Create SCIM groups. Directory tokens are restricted to one directory. Deactivation revokes company access without deleting the personal account. Group mappings grant only Viewer or Editor.

scimProvisioning

Parameters and headers

FieldLocationType and limitsRequiredMeaning
directoryPathstring; {"format":"uuid"}YesSCIM directory identifier.

Request body

FieldType and limitsRequiredMeaning
$EnterpriseSCIMResourceYes—
$.schemasarray<string>No—
$.schemas[]stringYes—
$.idstringNo—
$.externalIdstringNo—
$.userNamestringNo—
$.displayNamestringNo—
$.activebooleanNo—
$.emailsarray<object>No—
$.emails[]objectYes—
$.emails[].valuestringNo—
$.emails[].primarybooleanNo—
$.nameobjectNo—
$.membersarray<object>No—
$.members[]objectYes—
$.members[].valuestring; {"format":"uuid"}No—
$.metaobjectNo—

Responses

application/scim+json

FieldType and limitsRequiredMeaning
$EnterpriseSCIMResource | objectYes—
$ (oneOf 1)EnterpriseSCIMResourceNo—
$ (oneOf 1).schemasarray<string>No—
$ (oneOf 1).schemas[]stringYes—
$ (oneOf 1).idstringNo—
$ (oneOf 1).externalIdstringNo—
$ (oneOf 1).userNamestringNo—
$ (oneOf 1).displayNamestringNo—
$ (oneOf 1).activebooleanNo—
$ (oneOf 1).emailsarray<object>No—
$ (oneOf 1).emails[]objectYes—
$ (oneOf 1).emails[].valuestringNo—
$ (oneOf 1).emails[].primarybooleanNo—
$ (oneOf 1).nameobjectNo—
$ (oneOf 1).membersarray<object>No—
$ (oneOf 1).members[]objectYes—
$ (oneOf 1).members[].valuestring; {"format":"uuid"}No—
$ (oneOf 1).metaobjectNo—
$ (oneOf 2)objectNo—
$ (oneOf 2).schemasarray<string>No—
$ (oneOf 2).schemas[]stringYes—
$ (oneOf 2).Resourcesarray<EnterpriseSCIMResource>No—
$ (oneOf 2).Resources[]EnterpriseSCIMResourceYes—
$ (oneOf 2).Resources[].schemasarray<string>No—
$ (oneOf 2).Resources[].schemas[]stringYes—
$ (oneOf 2).Resources[].idstringNo—
$ (oneOf 2).Resources[].externalIdstringNo—
$ (oneOf 2).Resources[].userNamestringNo—
$ (oneOf 2).Resources[].displayNamestringNo—
$ (oneOf 2).Resources[].activebooleanNo—
$ (oneOf 2).Resources[].emailsarray<object>No—
$ (oneOf 2).Resources[].emails[]objectYes—
$ (oneOf 2).Resources[].emails[].valuestringNo—
$ (oneOf 2).Resources[].emails[].primarybooleanNo—
$ (oneOf 2).Resources[].nameobjectNo—
$ (oneOf 2).Resources[].membersarray<object>No—
$ (oneOf 2).Resources[].members[]objectYes—
$ (oneOf 2).Resources[].members[].valuestring; {"format":"uuid"}No—
$ (oneOf 2).Resources[].metaobjectNo—
$ (oneOf 2).totalResultsintegerNo—
$ (oneOf 2).startIndexintegerNo—
$ (oneOf 2).itemsPerPageintegerNo—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

application/scim+json

FieldType and limitsRequiredMeaning
$objectYes—

Retries and asynchronous work

This change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

shell
curl --proto "=https" --tlsv1.2 --silent --show-error --max-time 10 --output /dev/null --write-out "%{http_code}\n" \
  --request POST \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  --data-binary @"$HOME/.config/metribeacon/request-body" \
  "https://metribeacon.com/api/v1/scim/v2/{directory}/Groups"
python
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError

config = Path.home() / ".config/metribeacon"
headers = json.loads((config / "headers.json").read_text())
body = (config / "request-body").read_bytes()
request = Request("https://metribeacon.com/api/v1/scim/v2/{directory}/Groups", data=body, headers=headers, method="POST")
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, request, fp, code, message, headers, target):
        return None

try:
    with build_opener(NoRedirect()).open(request, timeout=10) as response:
        print(response.status)
except HTTPError as error:
    print(error.code)
    error.close()
javascript
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";

const config = join(homedir(), ".config/metribeacon");
const headers = JSON.parse(await readFile(join(config, "headers.json"), "utf8"));
const body = await readFile(join(config, "request-body"));
const response = await fetch("https://metribeacon.com/api/v1/scim/v2/{directory}/Groups", {
  method: "POST", headers, redirect: "manual",
  body,
  signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
go
package main

import (
 "encoding/json"
 "fmt"
 "net/http"
 "os"
 "path/filepath"
 "time"
 "bytes"
)

func main() {
 home, err := os.UserHomeDir(); if err != nil { panic("local configuration unavailable") }
 config := filepath.Join(home, ".config/metribeacon")
 raw, err := os.ReadFile(filepath.Join(config,"headers.json")); if err != nil { panic("local headers unavailable") }
 var headers map[string]string
 if json.Unmarshal(raw,&headers) != nil { panic("invalid local headers") }
 body, err := os.ReadFile(filepath.Join(config,"request-body")); if err != nil { panic("local request unavailable") }
 request, err := http.NewRequest("POST","https://metribeacon.com/api/v1/scim/v2/{directory}/Groups",bytes.NewReader(body))
 if err != nil { panic("request unavailable") }
 for key,value := range headers { request.Header.Set(key,value) }
 client := &http.Client{Timeout:10*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}}
 response, err := client.Do(request); if err != nil { panic("request failed; credentials and response omitted") }
 defer response.Body.Close()
 fmt.Println(response.StatusCode)
}
  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • GET List SCIM groups

    List SCIM groups. Directory tokens are restricted to one directory. Deactivation revokes company access without deleting the personal account. Group mappings grant only Viewer or Editor.

  • GET Read a SCIM group

    Read a SCIM group. Directory tokens are restricted to one directory. Deactivation revokes company access without deleting the personal account. Group mappings grant only Viewer or Editor.

  • PUT Replace a SCIM group

    Replace a SCIM group. Directory tokens are restricted to one directory. Deactivation revokes company access without deleting the personal account. Group mappings grant only Viewer or Editor.