Search Past Grants

Search historical grants that have been revoked, filtered by app user or entitlement.

POST /api/v1/search/past-grants

SearchPastGrants

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

200

{
  "expanded": [
    {
      "@type": "<string>"
    }
  ],
  "list": [
    {
      "appPath": "<string>",
      "appUserPath": "<string>",
      "entitlementPath": "<string>",
      "history": {
        "appEntitlementId": "<string>",
        "appId": "<string>",
        "appUserId": "<string>",
        "grantedAt": "2023-11-07T05:31:56Z",
        "revokedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "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

The request message for searching historical grants.

appEntitlementRefs · App Entitlement Ref · object[] | null

A list of entitlement references to restrict the search to.

Show child attributes

appIds · string[] | null

A list of app IDs to restrict the search to.

appUserRefs · App User Ref · object[] | null

A list of app user references to restrict the search to.

Show child attributes

expandMask · App Entitlement User Binding Expand History Mask · object

The AppEntitlementUserBindingExpandHistoryMask message.

Show child attributes

pageSize · integer<int32>

The maximum number of results to return per page.

pageToken · string

The token for fetching the next page of results.

Response

200 - application/json

The SearchPastGrantsResponse message contains a list of past grants and a nextPageToken if applicable.

The SearchPastGrantsResponse message contains a list of past grants and a nextPageToken if applicable.

expanded · object[] | null

The expanded field.

Show child attributes

list · App Entitlement User Binding History View · object[] | null

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

Show child attributes

nextPageToken · string

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.