tokens

Documentation

Index

• type API
  • func NewAPI(httpClient *httpx.Client) *API
  • func (t *API) CreateRestrictedDataTokenRequest(restrictedResources *CreateRestrictedDataTokenRequest) (*apis.CallResponse[CreateRestrictedDataTokenResponse], error)
• type CreateRestrictedDataTokenRequest
• type CreateRestrictedDataTokenResponse
• type RestrictedResource

Types

type API

type API struct {
	// contains filtered or unexported fields
}

func NewAPI

func NewAPI(httpClient *httpx.Client) *API

func (*API) CreateRestrictedDataTokenRequest

func (t *API) CreateRestrictedDataTokenRequest(restrictedResources *CreateRestrictedDataTokenRequest) (*apis.CallResponse[CreateRestrictedDataTokenResponse], error)

CreateRestrictedDataTokenRequest returns a Restricted Data Token (RDT) for one or more restricted resources that you specify.

type CreateRestrictedDataTokenRequest

type CreateRestrictedDataTokenRequest struct {
	// The application ID for the target application to which access is being delegated.
	TargetApplication *string `json:"targetApplication,omitempty"`
	// A list of restricted resources. Maximum: 50
	RestrictedResources []RestrictedResource `json:"restrictedResources"`
}

CreateRestrictedDataTokenRequest The request schema for the createRestrictedDataToken operation.

type CreateRestrictedDataTokenResponse

type CreateRestrictedDataTokenResponse struct {
	// A Restricted Data Token (RDT). This is a short-lived access token that authorizes calls to restricted operations. Pass this value with the x-amz-access-token header when making subsequent calls to these restricted resources.
	RestrictedDataToken *string `json:"restrictedDataToken,omitempty"`
	// The lifetime of the Restricted Data Token, in seconds.
	ExpiresIn *int32 `json:"expiresIn,omitempty"`
}

CreateRestrictedDataTokenResponse The response schema for the createRestrictedDataToken operation.

type RestrictedResource

type RestrictedResource struct {
	// The HTTP method in the restricted resource.
	Method string `json:"method"`
	// The path in the restricted resource. Here are some path examples: - “`/orders/v0/orders“`. For getting an RDT for the getOrders operation of the Orders API. For bulk orders. - “`/orders/v0/orders/123-1234567-1234567“`. For getting an RDT for the getOrder operation of the Orders API. For a specific order. - “`/orders/v0/orders/123-1234567-1234567/orderItems“`. For getting an RDT for the getOrderItems operation of the Orders API. For the order items in a specific order. - “`/mfn/v0/shipments/FBA1234ABC5D“`. For getting an RDT for the getShipment operation of the Shipping API. For a specific shipment. - “`/mfn/v0/shipments/{shipmentID}“`. For getting an RDT for the getShipment operation of the Shipping API. For any of a selling partner's shipments that you specify when you call the getShipment operation.
	Path string `json:"path"`
	// Indicates the type of Personally Identifiable Information requested. This parameter is required only when getting an RDT for use with the getOrder, getOrders, or getOrderItems operation of the Orders API. For more information, see the [Tokens API Use Case Guide](doc:tokens-api-use-case-guide). Possible values include: - **buyerInfo**. On the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available. - **shippingAddress**. This includes information for fulfilling orders. - **buyerTaxInformation**. This includes information for issuing tax invoices.
	DataElements []string `json:"dataElements,omitempty"`
}

RestrictedResource Model of a restricted resource.