Search

Search access profiles across the tenant, filtered by application, resource server, or text query, or fetch a specific set by ref.

POST /api/v1/search/xaa/access_profiles

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.XAAAccessProfile.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.XAAAccessProfileServiceSearchResponse != nil {
        // handle response
    }
}

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

import requests

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

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

fetch('https://{tenantDomain}.conductor.one/api/v1/search/xaa/access_profiles', 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/xaa/access_profiles",
  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([
    'appIds' => [
        '<string>'
    ],
    'pageSize' => 123,
    'pageToken' => '<string>',
    'query' => '<string>',
    'refs' => [
        [
                'appId' => '<string>',
                'id' => '<string>'
        ]
    ],
    'xaaResourceServerIds' => [
        '<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/xaa/access_profiles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appIds\": [\n    \"<string>\"\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"appId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"xaaResourceServerIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

200

{
  "list": [
    {
      "appEntitlementId": "<string>",
      "appId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "id": "<string>",
      "scopeCount": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "xaaResourceServerId": "<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

XAAAccessProfileServiceSearchRequest searches access profiles with filters.

appIds · string[] | null

Optional filter by applications. Empty matches any application.

pageSize · integer<int32>

Page size (max 100).

pageToken · string

Page token for pagination.

query · string

Optional text query matched against display_name.

refs · Xaa Access Profile Ref · object[] | null

Optional: fetch a specific set of access profiles by ref (used by websocket notify to re-fetch individual rows).

Show child attributes

xaaResourceServerIds · string[] | null

Optional filter by resource servers. Empty matches any resource server.

Response

200 - application/json

XAAAccessProfileServiceSearchResponse returns matching access profiles.

XAAAccessProfileServiceSearchResponse returns matching access profiles.

list · Xaa Access Profile · object[] | null

Matching access profiles.

Show child attributes

nextPageToken · string

Token for the next page.