Create Past Grants

Search Past Grants

client.search.createPastGrants(SearchCreatePastGrantsParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreatePastGrantsResponse

post/api/v1/search/past-grants

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

Parameters

bodyappEntitlementRefsunionappIdsunionappUserRefsunionexpandMaskAppEntitlementUserBindingExpandHistoryMaskpageSizenumberpageTokenstringSearchCreatePastGrantsParams

Hide ParametersShow Parameters

appEntitlementRefsunion

optional

Array<idstringappIdstringAppEntitlementRef> | null

The appEntitlementRefs field.

Hide ParametersShow Parameters

idstring

optional

The id field.

appIdstring

optional

The appId field.

appIdsunion

optional

Array<string> | null

The appIds field.

appUserRefsunion

optional

Array<idstringappIdstringAppUserRef> | null

The appUserRefs field.

Hide ParametersShow Parameters

idstring

optional

The ID of the app user.

appIdstring

optional

The ID of the application.

expandMaskpathsunionAppEntitlementUserBindingExpandHistoryMask

optional

The AppEntitlementUserBindingExpandHistoryMask message.

pageSizenumber

optional

The pageSize field.

formatint32

pageTokenstring

optional

The pageToken field.

Returns

SearchCreatePastGrantsResponse

The SearchPastGrantsResponse message contains a list of past grants 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.

historyappEntitlementIdstringappIdstringappUserIdstringgrantedAtstringrevokedAtstringHistory

optional

The AppEntitlementUserBindingHistory 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

grantedAtstring

optional

formatdate-time

revokedAtstring

optional

formatdate-time

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.search.createPastGrants();

console.log(response.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appPath": "appPath",
      "appUserPath": "appUserPath",
      "entitlementPath": "entitlementPath",
      "history": {
        "appEntitlementId": "appEntitlementId",
        "appId": "appId",
        "appUserId": "appUserId"
      }
    }
  ],
  "nextPageToken": "nextPageToken"
}