Search

Search policies based on filters specified in the request body.

POST /api/v1/search/policies

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.PolicySearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SearchPoliciesResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

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.policySearch.search();

  for await (const page of result) {
    console.log(page);
  }
}

run();

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

import requests

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

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

fetch('https://{tenantDomain}.conductor.one/api/v1/search/policies', 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/policies",
  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([
    'displayName' => '<string>',
    'excludePolicyIds' => [
        '<string>'
    ],
    'includeDeleted' => true,
    'pageSize' => 123,
    'pageToken' => '<string>',
    'policyTypes' => [
        
    ],
    '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/policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"excludePolicyIds\": [\n    \"<string>\"\n  ],\n  \"includeDeleted\": true,\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"policyTypes\": [],\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/policies")

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

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

200

{
  "list": [
    {
      "annotations": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "id": "<string>",
      "policySteps": {},
      "postActions": [
        {
          "certifyRemediateImmediately": true
        }
      ],
      "reassignTasksToDelegates": true,
      "rules": [
        {
          "condition": "<string>",
          "policyKey": "<string>"
        }
      ],
      "systemBuiltin": true,
      "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

Search Policies by a few properties.

displayName · string | null

Search for policies with a case insensitive match on the display name.

excludePolicyIds · string[] | null

The policy IDs to exclude from the search.

includeDeleted · boolean | null

The includeDeleted field.

pageSize · integer<int32> | null

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

pageToken · string | null

The pageToken field.

policyTypes · enum<string>[] | null

The policy type to search on. This can be POLICY_TYPE_GRANT, POLICY_TYPE_REVOKE, POLICY_TYPE_CERTIFY, POLICY_TYPE_ACCESS_REQUEST, or POLICY_TYPE_PROVISION.

Available options: POLICY_TYPE_UNSPECIFIED, POLICY_TYPE_GRANT, POLICY_TYPE_REVOKE, POLICY_TYPE_CERTIFY, POLICY_TYPE_ACCESS_REQUEST, POLICY_TYPE_PROVISION

query · string | null

Query the policies with a fuzzy search on display name and description.

refs · Policy Ref · object[] | null

The refs field.

Show child attributes

Response

200 - application/json

Successful response

The SearchPoliciesResponse message.

list · Policy · object[] | null

The list field.

Show child attributes

nextPageToken · string | null

The nextPageToken field.