Skip to main content
POST
/
api
/
v1
/
identities
/
search
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/identities/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderBy": "name",
  "orderDirection": "asc",
  "limit": 50,
  "offset": 0,
  "search": {
    "name": "<string>",
    "role": "<string>",
    "$or": [
      {
        "name": "<string>",
        "role": "<string>"
      }
    ]
  }
}
'
import requests

url = "https://us.infisical.com/api/v1/identities/search"

payload = {
"orderBy": "name",
"orderDirection": "asc",
"limit": 50,
"offset": 0,
"search": {
"name": "<string>",
"role": "<string>",
"$or": [
{
"name": "<string>",
"role": "<string>"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderBy: 'name',
orderDirection: 'asc',
limit: 50,
offset: 0,
search: {
name: '<string>',
role: '<string>',
$or: [{name: '<string>', role: '<string>'}]
}
})
};

fetch('https://us.infisical.com/api/v1/identities/search', 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/identities/search",
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([
'orderBy' => 'name',
'orderDirection' => 'asc',
'limit' => 50,
'offset' => 0,
'search' => [
'name' => '<string>',
'role' => '<string>',
'$or' => [
[
'name' => '<string>',
'role' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/identities/search"

payload := strings.NewReader("{\n \"orderBy\": \"name\",\n \"orderDirection\": \"asc\",\n \"limit\": 50,\n \"offset\": 0,\n \"search\": {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"$or\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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/identities/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderBy\": \"name\",\n \"orderDirection\": \"asc\",\n \"limit\": 50,\n \"offset\": 0,\n \"search\": {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"$or\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/identities/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderBy\": \"name\",\n \"orderDirection\": \"asc\",\n \"limit\": 50,\n \"offset\": 0,\n \"search\": {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"$or\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n}"

response = http.request(request)
puts response.read_body
{
  "identities": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identity": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "authMethods": [
          "<string>"
        ],
        "activeLockoutAuthMethods": [
          "<string>"
        ],
        "hasDeleteProtection": false
      },
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastLoginAuthMethod": "<string>",
      "lastLoginTime": "2023-11-07T05:31:56Z",
      "customRole": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "permissions": "<unknown>",
        "description": "<string>"
      }
    }
  ],
  "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>"
}

Authorizations

Authorization
string
header
required

An access token in Infisical

Body

application/json
orderBy
enum<string>
default:name

The column to order identities by.

Available options:
name,
role
orderDirection
enum<string>
default:asc

The direction to order identities in.

Available options:
asc,
desc
limit
number
default:50

The number of identities to return.

Required range: x <= 100
offset
number
default:0

The offset to start from. If you enter 10, it will start from the 10th identity.

The filters to apply to the search.

Response

Default Response

identities
object[]
required
totalCount
number
required