EQTY LabDocs

Issue project membership credential

Issues a revocable ProjectMembershipV1 credential, signed by the platform DID, stating that the agent its urn:uuid names belongs to the project with the given roles. A request for the same agent, roles, and expiry returns the credential already issued, unless it has been revoked, in which case a new one replaces it. The caller needs create_agent_memberships on the project.

posthttps://<host>/gov/v1/identity/membership/{project_uuid}
bash
curl --request POST \
  --url 'https://<host>/gov/v1/identity/membership/{project_uuid}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"expiryDate":"2027-05-05T09:00:00Z","role":["string"],"subject":"urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40","subjectDid":"urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"}'
javascript
const response = await fetch("https://<host>/gov/v1/identity/membership/{project_uuid}", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "expiryDate": "2027-05-05T09:00:00Z",
    "role": [
      "string"
    ],
    "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
    "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
  })
});

const data = await response.json();
typescript
interface MembershipIssueResponse {
  credential: Record<string, unknown>;
  credentialId: string;
  sourceCid: string;
}

const response = await fetch("https://<host>/gov/v1/identity/membership/{project_uuid}", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "expiryDate": "2027-05-05T09:00:00Z",
    "role": [
      "string"
    ],
    "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
    "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

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

response = requests.post(
    "https://<host>/gov/v1/identity/membership/{project_uuid}",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "expiryDate": "2027-05-05T09:00:00Z",
        "role": [
            "string",
        ],
        "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
        "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	body := strings.NewReader(`{
	  "expiryDate": "2027-05-05T09:00:00Z",
	  "role": [
	    "string"
	  ],
	  "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
	  "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://<host>/gov/v1/identity/membership/{project_uuid}", 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://<host>/gov/v1/identity/membership/{project_uuid}"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "expiryDate": "2027-05-05T09:00:00Z",
                  "role": [
                    "string"
                  ],
                  "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
                  "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
                }
                """))
            .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://<host>/gov/v1/identity/membership/{project_uuid}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "expiryDate": "2027-05-05T09:00:00Z",
      "role": [
        "string"
      ],
      "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
      "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
    }
    """, 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://<host>/gov/v1/identity/membership/{project_uuid}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "expiryDate": "2027-05-05T09:00:00Z",
      "role": [
        "string"
      ],
      "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
      "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
    }
    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://<host>/gov/v1/identity/membership/{project_uuid}")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "expiryDate": "2027-05-05T09:00:00Z",
    "role": [
      "string"
    ],
    "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
    "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
  }
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://<host>/gov/v1/identity/membership/{project_uuid}")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "expiryDate": "2027-05-05T09:00:00Z",
            "role": [
                "string"
            ],
            "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
            "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
        }))
        .send()
        .await?;

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

Authorizations

  • BearerAuth · HTTP bearer (JWT)

Parameters

Path parameters

NameTypeDescription
project_uuid
required
string

Project UUID

Request bodyrequired

application/json
  • expiryDatestring | null

    Optional expiry; omitted, null, or empty issues a credential that never expires.

  • rolestring[]

    Optional roles granted to the identity within the project.

  • subjectstringrequired

    The agent that belongs to the project, as its urn:uuid, so the membership covers every instance of the agent.

  • subjectDidstring | nulldeprecated

    The former name of subject, still accepted in its place, and like it only the agent's urn:uuid. A request may send one or the other, not both.

Examplejson
{
  "expiryDate": "2027-05-05T09:00:00Z",
  "role": [
    "string"
  ],
  "subject": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40",
  "subjectDid": "urn:uuid:3f2b8c1e-9d4a-4e7b-8c6f-2a1d5e9b7c40"
}

Responses

200Project membership credential issued, or the one already issued for the same subject, roles, and expiry

application/json
  • credentialobjectrequired
  • credentialIdstringrequired
  • sourceCidstringrequired
Examplejson
{
  "credential": {},
  "credentialId": "urn:uuid:aa115482-3a7d-498a-a05c-983722b501f8",
  "sourceCid": "bafybeibwzifp5oc5mirxgcq"
}

400The project UUID or expiryDate does not parse, the request names no subject or sends both subject and subjectDid, or the subject is not the agent's canonical, non-nil urn:uuid

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

401Missing or invalid bearer token

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

403Caller lacks create_agent_memberships on the project

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

500Internal error

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

503Auth Service or blob storage unavailable

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}