Skip to main content
POST
/
api
/
v1
/
search
/
attributes
SearchAttributeValues
package main

import(
	"context"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	"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.AttributeSearch.SearchAttributeValues(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SearchAttributeValuesResponse != nil {
        // handle response
    }
}
{
  "list": [
    {
      "attributeTypeId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "value": "<string>"
    }
  ],
  "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 Attributes by a few properties.

attributeTypeIds
string[] | null

The attribute type ids for what type of attributes to search for.

excludeIds
string[] | null

Exclude attributes with these ids from the search results.

ids
string[] | null

Include attributes with these ids in the search results.

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.

query
string | null

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

value
string | null

Search for attributes with a case insensitive match on the attribute value which is the attribute name.

Response

200 - application/json

SearchAttributeValuesResponse is the response for searching AttributeValues.

SearchAttributeValuesResponse is the response for searching AttributeValues.

list
Attribute Value · object[] | null

The list of returned AttributeValues.

nextPageToken
string | null

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.