Search Feed

Search Grant Feed

client.grants.searchFeed(?, ?):

post/api/v1/grants/feed

Invokes the c1.api.app.v1.AppEntitlementUserBindingService.SearchGrantFeed method.

Parameters

body

Hide ParametersShow Parameters

afterstring

optional

formatdate-time

appEntitlementRefsunion

optional

Array<> | null

The list of app entitlements to limit the search to.

Hide ParametersShow Parameters

idstring

optional

The id field.

appIdstring

optional

The appId field.

appRefsunion

optional

Array<AppRef> | null

The list of apps to limit the search to.

Hide ParametersShow Parameters

idstring

optional

The id field.

appUserRefsunion

optional

Array<> | null

The list of app users to limit the search to.

Hide ParametersShow Parameters

idstring

optional

The ID of the app user.

appIdstring

optional

The ID of the application.

beforestring

optional

formatdate-time

expandMask

optional

The AppEntitlementUserBindingExpandHistoryMask message.

pageSizenumber

optional

The pageSize where 10 <= pageSize <= 100, default 25.

formatint32

pageTokenstring

optional

The page_token field for pagination.

userRefsunion

optional

Array<> | null

The list of C1 users to limit the search to.

Hide ParametersShow Parameters

idstring

optional

The id of the user.

Returns

GrantSearchFeedResponse

The SearchGrantFeedResponse message contains a list of grant event results and a nextPageToken if applicable.

Hide ParametersShow Parameters

expandedunion

optional

Array<Expanded> | null

The expanded field.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

listunion

optional

Array<List> | null

The list of results containing up to X results, where X is the page size defined in the request.

Hide ParametersShow Parameters

appPathstring

optional

The appPath field.

appUserPathstring

optional

The appUserPath field.

entitlementPathstring

optional

The entitlementPath field.

feed

optional

The AppEntitlementUserBindingFeed message.

Hide ParametersShow Parameters

appEntitlementIdstring

optional

The ID of the app entitlement that the app user has access to

appIdstring

optional

The ID of the app associated with the app entitlement

appUserIdstring

optional

The ID of the app user that has access to the app entitlement

datestring

optional

formatdate-time

eventTypeunion

optional

"GRANT_EVENT_TYPE_UNSPECIFIED" | "GRANT_EVENT_TYPE_ADDED" | "GRANT_EVENT_TYPE_REMOVED"

The eventType field.

Hide ParametersShow Parameters

"GRANT_EVENT_TYPE_UNSPECIFIED"

"GRANT_EVENT_TYPE_ADDED"

"GRANT_EVENT_TYPE_REMOVED"

ticketIdstring

optional

The ticketId field.

ticketPathstring

optional

The ticketPath field.

nextPageTokenstring

optional

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 retrieved. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.grants.searchFeed();

console.log(response.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appPath": "appPath",
      "appUserPath": "appUserPath",
      "entitlementPath": "entitlementPath",
      "feed": {
        "appEntitlementId": "appEntitlementId",
        "appId": "appId",
        "appUserId": "appUserId",
        "date": "2019-12-27T18:11:19.117Z",
        "eventType": "GRANT_EVENT_TYPE_UNSPECIFIED",
        "ticketId": "ticketId"
      },
      "ticketPath": "ticketPath"
    }
  ],
  "nextPageToken": "nextPageToken"
}