List available users and groups

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available

const options = {method: 'GET'};

fetch('https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available', 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/delegations/{machineIdentityId}/subjects/available",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available")

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

request = Net::HTTP::Get.new(url)

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

{
  "members": [
    {
      "type": "user",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "username": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "isOrgMembershipPending": true,
      "role": "<string>",
      "isActive": true,
      "addedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 123
}

{
  "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>"
}

GET

api

agent-vault

delegations

{machineIdentityId}

subjects

available

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available

const options = {method: 'GET'};

fetch('https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available', 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/delegations/{machineIdentityId}/subjects/available",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/agent-vault/delegations/{machineIdentityId}/subjects/available")

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

request = Net::HTTP::Get.new(url)

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

{
  "members": [
    {
      "type": "user",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "username": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "isOrgMembershipPending": true,
      "role": "<string>",
      "isActive": true,
      "addedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 123
}

{
  "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>"
}

Path Parameters

machineIdentityId

string<uuid>

required

The ID of the machine identity the delegation belongs to.

Query Parameters

actorType

enum<string>

List only users, or only groups.

Available options:

user,

group

string

Match users by name, username or email address, and groups by name.

Maximum string length: 255

Pattern: ^[^\x00-\x1f\x7f]*$

limit

integer

default:20

The maximum number of users and groups to return.

Required range: 1 <= x <= 100

offset

integer

default:0

How many users and groups to skip.

Required range: 0 <= x <= 10000

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

totalCount

number

required

How many users and groups match, across every page.

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

List available users and groups

Path Parameters

Query Parameters

Response