Skip to main content
POST
/
api
/
v1
/
search
/
policies
Search
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
            }
        }
    }
}
{
  "list": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "id": "<string>",
      "policySteps": {},
      "policyType": "POLICY_TYPE_UNSPECIFIED",
      "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

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

The includeDeleted field.

pageSize
integer<int32>

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

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

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

refs
Policy Ref · object[] | null

The refs field.

Response

200 - application/json

Successful response

The SearchPoliciesResponse message.

list
Policy · object[] | null

The list field.

nextPageToken
string

The nextPageToken field.