Search

Invokes the c1.api.hooks.v1.HooksSearch.Search method.

POST /api/v1/search/hooks

Search

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.HooksSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.HooksSearchResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.hooksSearch.search();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/search/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 123,
  "pageToken": "<string>",
  "query": "<string>",
  "refs": [
    {
      "id": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/search/hooks"

payload = {
    "pageSize": 123,
    "pageToken": "<string>",
    "query": "<string>",
    "refs": [{ "id": "<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({
    pageSize: 123,
    pageToken: '<string>',
    query: '<string>',
    refs: [{id: '<string>'}]
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/search/hooks', 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://{tenantDomain}.conductor.one/api/v1/search/hooks",
  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([
    'pageSize' => 123,
    'pageToken' => '<string>',
    'query' => '<string>',
    'refs' => [
        [
                'id' => '<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;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/search/hooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/search/hooks")

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  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}"

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

200

{
  "list": [
    {
      "builtinPattern": {
        "creditCardBlocking": {},
        "piiRedaction": {
          "redactFields": [
            "<string>"
          ],
          "replacement": "<string>"
        },
        "queryScopeLimit": {
          "fields": [
            "<string>"
          ],
          "maxLimit": 123
        },
        "sensitiveFileGuard": {
          "blockedDirectories": [
            "<string>"
          ],
          "blockedPatterns": [
            "<string>"
          ]
        },
        "writeAuthorization": {
          "blockedClassifications": [],
          "businessHours": {
            "days": [
              123
            ],
            "end": "<string>",
            "start": "<string>",
            "timezone": "<string>"
          }
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "enabled": true,
      "filter": {
        "celExpression": "<string>"
      },
      "function": {
        "commitId": "<string>",
        "functionId": "<string>"
      },
      "id": "<string>",
      "priority": 123,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The HooksSearchRequest message.

pageSize · integer<int32> | null

The pageSize field.

pageToken · string | null

The pageToken field.

query · string | null

The query field.

refs · Hook Ref · object[] | null

The refs field.

Show child attributes

Response

200 - application/json

Successful response

The HooksSearchResponse message.

list · Hook · object[] | null

The list field.

Show child attributes

nextPageToken · string | null

The nextPageToken field.