EQTY LabDocs

Enrich JWT claims with user context and ensure DID key

Called by IDP Actions/Hooks to provision the user, return organization/project/role custom claims for the JWT, and create a DID key when one is missing

posthttps://localhost:8080/api/v1/auth/claims-enrichment
bash
curl --request POST \
  --url 'https://localhost:8080/api/v1/auth/claims-enrichment' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"attributes":{"key":"string"},"email":"string","groups":["string"],"name":"string","picture":"string","provider":{},"user_id":"string"}'
javascript
const response = await fetch("https://localhost:8080/api/v1/auth/claims-enrichment", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "attributes": {
      "key": "string"
    },
    "email": "string",
    "groups": [
      "string"
    ],
    "name": "string",
    "picture": "string",
    "provider": {},
    "user_id": "string"
  })
});

const data = await response.json();
typescript
interface EnrichClaimsResponse {
  custom_claims?: Record<string, unknown>;
}

const response = await fetch("https://localhost:8080/api/v1/auth/claims-enrichment", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "attributes": {
      "key": "string"
    },
    "email": "string",
    "groups": [
      "string"
    ],
    "name": "string",
    "picture": "string",
    "provider": {},
    "user_id": "string"
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: EnrichClaimsResponse = await response.json();
python
import requests

response = requests.post(
    "https://localhost:8080/api/v1/auth/claims-enrichment",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "attributes": {
            "key": "string",
        },
        "email": "string",
        "groups": [
            "string",
        ],
        "name": "string",
        "picture": "string",
        "provider": {},
        "user_id": "string",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "attributes": {
	    "key": "string"
	  },
	  "email": "string",
	  "groups": [
	    "string"
	  ],
	  "name": "string",
	  "picture": "string",
	  "provider": {},
	  "user_id": "string"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://localhost:8080/api/v1/auth/claims-enrichment", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/api/v1/auth/claims-enrichment"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "attributes": {
                    "key": "string"
                  },
                  "email": "string",
                  "groups": [
                    "string"
                  ],
                  "name": "string",
                  "picture": "string",
                  "provider": {},
                  "user_id": "string"
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:8080/api/v1/auth/claims-enrichment");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "attributes": {
        "key": "string"
      },
      "email": "string",
      "groups": [
        "string"
      ],
      "name": "string",
      "picture": "string",
      "provider": {},
      "user_id": "string"
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:8080/api/v1/auth/claims-enrichment');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "attributes": {
        "key": "string"
      },
      "email": "string",
      "groups": [
        "string"
      ],
      "name": "string",
      "picture": "string",
      "provider": {},
      "user_id": "string"
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:8080/api/v1/auth/claims-enrichment")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "attributes": {
      "key": "string"
    },
    "email": "string",
    "groups": [
      "string"
    ],
    "name": "string",
    "picture": "string",
    "provider": {},
    "user_id": "string"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .post("https://localhost:8080/api/v1/auth/claims-enrichment")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "attributes": {
                "key": "string"
            },
            "email": "string",
            "groups": [
                "string"
            ],
            "name": "string",
            "picture": "string",
            "provider": {},
            "user_id": "string"
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Parameters

Header parameters

NameTypeDescription
Authorization
required
string

Bearer {api_secret}

Request bodyrequired

User information

application/json
  • attributesobject

    Keycloak only; diagnostics only

    Show properties

    Map of string

  • emailstringrequired
  • groupsstring[]

    Keycloak only; adds the groups claim

  • namestring
  • picturestring
  • providerobject

    Defaults to auth0

    Show properties

    object — Defaults to auth0

  • user_idstringrequired
Examplejson
{
  "attributes": {
    "key": "string"
  },
  "email": "string",
  "groups": [
    "string"
  ],
  "name": "string",
  "picture": "string",
  "provider": {},
  "user_id": "string"
}

Responses

200Custom claims to add to JWT (includes did_key_id if available)

application/json
  • custom_claimsobject
    Show properties

    Map of any

Examplejson
{
  "custom_claims": {
    "key": null
  }
}

400Bad request - Invalid request body

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401Unauthorized - Invalid API secret

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500Internal server error

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}