Add members

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/agent-vault/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [],
  "machineIdentityIds": [],
  "groupIds": [],
  "emails": [],
  "usernames": [],
  "projectId": "<string>"
}
'

import requests

url = "https://us.infisical.com/api/v1/agent-vault/members"

payload = {
    "userIds": [],
    "machineIdentityIds": [],
    "groupIds": [],
    "emails": [],
    "usernames": [],
    "projectId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    userIds: [],
    machineIdentityIds: [],
    groupIds: [],
    emails: [],
    usernames: [],
    projectId: '<string>'
  })
};

fetch('https://us.infisical.com/api/v1/agent-vault/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.infisical.com/api/v1/agent-vault/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userIds' => [
        
    ],
    'machineIdentityIds' => [
        
    ],
    'groupIds' => [
        
    ],
    'emails' => [
        
    ],
    'usernames' => [
        
    ],
    'projectId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://us.infisical.com/api/v1/agent-vault/members"

	payload := strings.NewReader("{\n  \"userIds\": [],\n  \"machineIdentityIds\": [],\n  \"groupIds\": [],\n  \"emails\": [],\n  \"usernames\": [],\n  \"projectId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.infisical.com/api/v1/agent-vault/members")
  .header("Content-Type", "application/json")
  .body("{\n  \"userIds\": [],\n  \"machineIdentityIds\": [],\n  \"groupIds\": [],\n  \"emails\": [],\n  \"usernames\": [],\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/agent-vault/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userIds\": [],\n  \"machineIdentityIds\": [],\n  \"groupIds\": [],\n  \"emails\": [],\n  \"usernames\": [],\n  \"projectId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "members": [
    {
      "type": "user",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "addedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "skipped": [
    {
      "type": "user",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>"
    }
  ]
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

POST

api

agent-vault

members

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/agent-vault/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [],
  "machineIdentityIds": [],
  "groupIds": [],
  "emails": [],
  "usernames": [],
  "projectId": "<string>"
}
'

import requests

url = "https://us.infisical.com/api/v1/agent-vault/members"

payload = {
    "userIds": [],
    "machineIdentityIds": [],
    "groupIds": [],
    "emails": [],
    "usernames": [],
    "projectId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    userIds: [],
    machineIdentityIds: [],
    groupIds: [],
    emails: [],
    usernames: [],
    projectId: '<string>'
  })
};

fetch('https://us.infisical.com/api/v1/agent-vault/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.infisical.com/api/v1/agent-vault/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userIds' => [
        
    ],
    'machineIdentityIds' => [
        
    ],
    'groupIds' => [
        
    ],
    'emails' => [
        
    ],
    'usernames' => [
        
    ],
    'projectId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://us.infisical.com/api/v1/agent-vault/members"

	payload := strings.NewReader("{\n  \"userIds\": [],\n  \"machineIdentityIds\": [],\n  \"groupIds\": [],\n  \"emails\": [],\n  \"usernames\": [],\n  \"projectId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.infisical.com/api/v1/agent-vault/members")
  .header("Content-Type", "application/json")
  .body("{\n  \"userIds\": [],\n  \"machineIdentityIds\": [],\n  \"groupIds\": [],\n  \"emails\": [],\n  \"usernames\": [],\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/agent-vault/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userIds\": [],\n  \"machineIdentityIds\": [],\n  \"groupIds\": [],\n  \"emails\": [],\n  \"usernames\": [],\n  \"projectId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "members": [
    {
      "type": "user",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "addedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "skipped": [
    {
      "type": "user",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>"
    }
  ]
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Body

application/json

role

enum<string>

required

The Agent Vault role: admin or member.

Available options:

admin,

member

userIds

string<uuid>[]

The IDs of the users to act on.

machineIdentityIds

string<uuid>[]

The IDs of the machine identities to act on.

groupIds

string<uuid>[]

The IDs of the groups to act on.

emails

string<email>[]

The email addresses of the users to give access to. Each must already be in the organization.

usernames

string[]

The usernames of the users to give access to. Each must already be in the organization.

Required string length: 1 - 255

projectId

string

The ID of the Agent Vault project.

Required string length: 1 - 36

Response

Default Response

members

(User · object | Machine identity · object | Group · object)[]

required

User
Machine identity
Group

Show child attributes

skipped

(User · object | Machine identity · object | Group · object)[]

required

The requested members who already had access to the project and were left as they were.

User
Machine identity
Group

Show child attributes

Get started

Organization

Project

Shared

Identity auth

Secrets Management

Certificate Management

Secret sharing

Agent Vault

Key Management Service (KMS)

KMIP servers

Gateways

External migrations

Other

Body

Response