Get

Get usage controls, as an AppUsageControls object which describes some peripheral configuration, for an app.

GET /api/v1/apps/{app_id}/usage_controls

Get

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"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.AppUsageControls.Get(ctx, operations.C1APIAppV1AppUsageControlsServiceGetRequest{
        AppID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetAppUsageControlsResponse != nil {
        // handle response
    }
}

200

{
  "appUsageControls": {
    "appId": "<string>",
    "notify": true,
    "notifyAfterDays": 123,
    "revoke": true,
    "revokeAfterDays": 123
  },
  "hasUsageData": true
}

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.

Path Parameters

app_id · string | null · required

The appId field.

Response

200 - application/json

The GetAppUsageControlsResponse message contains the retrieved AppUsageControls object.

The GetAppUsageControlsResponse message contains the retrieved AppUsageControls object.

appUsageControls · App Usage Controls · object

The AppUsageControls object describes some peripheral configuration for an app.

Show child attributes

hasUsageData · boolean | null

HasUsageData is false if the access entitlement for this app has no usage data.