POST
/
api
/
v1
/
identities
/
search
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>"
      }
    ]
  }
}'
{
  "identities": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customRole": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "permissions": "<any>",
        "description": "<string>"
      },
      "identity": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "authMethods": [
          "<string>"
        ]
      }
    }
  ],
  "totalCount": 123
}

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
​
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.

​
search
object

The filters to apply to the search.

Response

200
application/json
Default Response
​
identities
object[]
required
​
totalCount
number
required

Was this page helpful?

Suggest editsRaise issue