Count Grants For User By App

CountGrantsForUserByApp returns, for a user, the number of grants held per application. Use it to size or filter an access graph before calling SearchGraph: counts are computed directly from grant bindings and are an upper bound on what SearchGraph will render for the same user and app filter (SearchGraph applies additional filters that this count does not).

POST /api/v1/search/graph/counts

CountGrantsForUserByApp

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

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/search/graph/counts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appIds": [
    "<string>"
  ],
  "userId": "<string>"
}
'

import requests

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

payload = {
    "appIds": ["<string>"],
    "userId": "<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>'], userId: '<string>'})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/search/graph/counts', 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/graph/counts",
  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>'
    ],
    'userId' => '<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/graph/counts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appIds\": [\n    \"<string>\"\n  ],\n  \"userId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"userId\": \"<string>\"\n}"

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

200

{
  "appCount": 123,
  "appGrantCounts": [
    {
      "appId": "<string>",
      "grantCount": "<string>"
    }
  ],
  "appUsers": [
    {
      "appId": "<string>",
      "id": "<string>"
    }
  ],
  "totalGrants": "<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

CountGrantsForUserByApp request.

appIds · string[] | null

Restrict the count to these applications. Empty counts grants across all applications the user has access to.

userId · string

The user whose grants to count.

Response

200 - application/json

CountGrantsForUserByApp response. Grant counts are computed directly from grant bindings and are an upper bound on what SearchGraph renders for the same user and app filter — SearchGraph applies additional filters that these counts do not.

CountGrantsForUserByApp response. Grant counts are computed directly from grant bindings and are an upper bound on what SearchGraph renders for the same user and app filter — SearchGraph applies additional filters that these counts do not.

appCount · integer<int32>

The number of applications represented in app_grant_counts.

appGrantCounts · Graph App Grant Count · object[] | null

Grant counts, one entry per application the user has at least one grant in (or per requested app_id, if narrower).

Show child attributes

appUsers · App User Ref · object[] | null

The user's accounts, scoped by the app_ids filter when provided. Includes accounts with zero counted grants. Lets callers filter a subsequent access graph by account without a second lookup.

Show child attributes

band · enum<string>

Advisory size classification for the user's access graph. See GraphSizeBand.

Available options: GRAPH_SIZE_BAND_UNSPECIFIED, GRAPH_SIZE_BAND_NORMAL, GRAPH_SIZE_BAND_SUMMARIZED, GRAPH_SIZE_BAND_TOO_LARGE

totalGrants · string<int64>

The sum of grant_count across all app_grant_counts.