Search Denials

Search budget-denial episodes for the organization within a time window. Requires the denial-read permission.

POST /api/v1/spend-insights/denials/search

SearchDenials

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

200

{
  "episodes": [
    {
      "attemptCount": "<string>",
      "authorityId": "<string>",
      "authorityKind": "AUTHORITY_KIND_UNSPECIFIED",
      "authorityVersion": "<string>",
      "blockId": "<string>",
      "budgetKey": "<string>",
      "closedAt": "2023-11-07T05:31:56Z",
      "firstDeniedAt": "2023-11-07T05:31:56Z",
      "lastDeniedAt": "2023-11-07T05:31:56Z",
      "periodEnd": "2023-11-07T05:31:56Z",
      "periodKey": "<string>",
      "periodKind": "PERIOD_KIND_UNSPECIFIED",
      "periodStart": "2023-11-07T05:31:56Z",
      "reason": "DENY_REASON_UNSPECIFIED",
      "requestTaskId": "<string>",
      "requestTaskState": "TICKET_STATE_UNSPECIFIED",
      "scopeAppId": "<string>",
      "scopeKind": "SPEND_BLOCK_SCOPE_KIND_UNSPECIFIED",
      "scopeUserId": "<string>",
      "state": "SPEND_BLOCK_STATE_UNSPECIFIED"
    }
  ],
  "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

SearchDenialsRequest specifies denial filters and pagination.

filters · Denial Filters · object | null

DenialFilters selects budget-denial episodes.

Show child attributes

pageSize · integer<int32>

Maximum number of episodes to return. The default is 25 and the maximum is 100.

pageToken · string

Pagination token from a previous response with the same filters.

Response

200 - application/json

SearchDenialsResponse contains one page of denial episodes.

SearchDenialsResponse contains one page of denial episodes.

episodes · Denial Episode · object[] | null

Episodes ordered by most recent refusal, then unique ID, both descending.

Show child attributes

nextPageToken · string

Token for the next page. Empty when no more episodes remain.