Skip to content

Integrations

Brex (User Token)

Connect a Brex company to Alter using a scoped user token

PropertyValue
Template IDbrex
CategoryFinance
Credential TypeBearer Token

Brex customer user tokens connect corporate cards, expenses, payments, travel and accounting. The managed Brex SDK supports both user-token managed secrets and partner OAuth.

  1. Sign in to the Brex Dashboard as an account admin or card admin.
  2. Open Developer → Settings. Accept the developer API agreement if prompted.
  3. Choose Create Token, give it a name and select the scopes needed for your integration.
  4. Review the selections and choose Allow Access.
  5. Copy the token immediately. Brex displays it only once.

The token acts within both its selected scopes and the creating user’s Brex permissions. For the example below, include users.readonly.

Open your application in the Developer Portal. Under Managed Secrets, add Brex, paste the User Token and save. Set the allowed host to api.brex.com, then create a system grant for the agent that will use it.

Terminal window
alter managed-secrets set-allowed-hosts <secret> --host api.brex.com

Brex has no documented verification endpoint available independently of a token’s scopes and the user’s role. Alter reports save-time verification as skipped. Confirm the token with an API operation it is authorized to use.

from alter_sdk import HttpMethod, PendingApproval
response = await alter_app.proxy_request(
HttpMethod.GET,
"https://api.brex.com/v2/users?limit=1",
grant_id="YOUR_GRANT_ID",
)
if isinstance(response, PendingApproval):
response = await alter_app.await_approval(response.approval_id)

Brex expires a user token after 90 days without API use and invalidates tokens owned by inactive users. Replace the stored token when either occurs. Customer tokens use production; Brex’s separate partner staging environment requires partner credentials. Onboarding referrals require partner client-credentials access and cannot use customer user tokens.

See Brex’s authentication guide, roles and scopes, and error codes.

Captured responses mask personal profile values, private metadata, banking numbers and card details at their reviewed locations. Benign fields remain visible; undiscriminated variants retain their sensitive upper bound. Calls returning narrow capabilities, such as signed receipt links or webhook secrets, are withheld from payload capture.

Budget-owner assignments and user roles other than Employee grant management authority and are denied by default. Those routes are available through raw managed execution rather than the SDK, and ordinary requests to them are allowed; a reviewed authority-granting branch requires a credential_minting allowance naming the provider, exact operation and authenticated API key or agent, with a reason and an absolute expiry in the future, at most one year ahead. Ordinary spending membership, employee manager assignments and employee status restoration remain governable by normal policy. Six credential-gated issuer identities require the same scoped fields and remain outside the SDK. No allowance can lift the five unsupported partner-authentication Onboarding routes. Other policies still apply, and expiry ends the exception.

Operation IDFamiliesMethodProvider pathNotes
accounting:createIntegrationadmin, writePOST/v3/accounting/integration—
accounting:getIntegrationreadGET/v3/accounting/integration/{integration_id}—
accounting:listAmortizationTemplatesreadGET/v3/accounting/integration/{integration_id}/amortization—
accounting:createAmortizationTemplateadmin, writePOST/v3/accounting/integration/{integration_id}/amortization—
accounting:deleteAmortizationTemplatedeleteDELETE/v3/accounting/integration/{integration_id}/amortization/{brex_id}—
accounting:getAmortizationTemplatereadGET/v3/accounting/integration/{integration_id}/amortization/{brex_id}—
accounting:updateAmortizationTemplatedelete, writePATCH/v3/accounting/integration/{integration_id}/amortization/{brex_id}also delete when body.@UpdateAmortizationTemplateRequest.is_disabled is one of [true] ({"missing”: false, “type”: “boolean"}); also write when not (the body only sets is_disabled to true for the selected amortization template); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
accounting:disconnectIntegrationadmin, deletePOST/v3/accounting/integration/{integration_id}/disconnect—
accounting:reactivateIntegrationadmin, writePOST/v3/accounting/integration/{integration_id}/reactivate—
accounting:listTaxCodesreadGET/v3/accounting/integration/{integration_id}/tax-codes—
accounting:createTaxCodewritePOST/v3/accounting/integration/{integration_id}/tax-codes—
accounting:deleteTaxCodedeleteDELETE/v3/accounting/integration/{integration_id}/tax-codes/{brex_id}—
accounting:getTaxCodereadGET/v3/accounting/integration/{integration_id}/tax-codes/{brex_id}—
accounting:updateTaxCodedelete, writePATCH/v3/accounting/integration/{integration_id}/tax-codes/{brex_id}also delete when body.@TaxCodeSubsidiaryStatus.status is one of [“DISABLED”] ({"missing”: false, “type”: “string”, “valid_values”: [“ENABLED”, “DISABLED"]}); also write when not (the body contains a nonempty subsidiaries list whose entries only identify a subsidiary and set the tax-code status to DISABLED); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
accounting:listTaxGroupsreadGET/v3/accounting/integration/{integration_id}/tax-groups—
accounting:createTaxGroupwritePOST/v3/accounting/integration/{integration_id}/tax-groups—
accounting:deleteTaxGroupdeleteDELETE/v3/accounting/integration/{integration_id}/tax-groups/{brex_id}—
accounting:getTaxGroupreadGET/v3/accounting/integration/{integration_id}/tax-groups/{brex_id}—
accounting:updateTaxGroupdelete, writePATCH/v3/accounting/integration/{integration_id}/tax-groups/{brex_id}also delete when body.@TaxCodeSubsidiaryStatus.status is one of [“DISABLED”] ({"missing”: false, “type”: “string”, “valid_values”: [“ENABLED”, “DISABLED"]}); also write when not (the body contains a nonempty subsidiaries list whose entries only identify a subsidiary and set the tax-group status to DISABLED); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
accounting:listIntegrationsreadGET/v3/accounting/integrations—
accounting:queryAccountingRecordsreadGET/v3/accounting/recordsallowed; its secret is never stored in a payload capture
accounting:AccountingController_updateAccountingRecordswritePOST/v3/accounting/recordsallowed; its secret is never stored in a payload capture
accounting:reportAccountingExportResultswritePOST/v3/accounting/records/export-results—
accounting:getAccountingRecordreadGET/v3/accounting/records/{record_id}allowed; its secret is never stored in a payload capture
budgets:listBudgetProgramsreadGET/v1/budget_programs—
budgets:getBudgetProgramByIdreadGET/v1/budget_programs/{id}—
budgets:listBudgetsreadGET/v1/budgets—
budgets:createBudgetadmin, payment, send, writePOST/v1/budgetsaccount-security or privilege changes are refused by default when ((body.@CreateBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or ((body.@CreateBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) and (not (body.@CreateBudgetRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"}))))) (an explicit credential_minting allowance can allow the reviewed request); also admin when (body.@CreateBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or ((body.@CreateBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) and (not (body.@CreateBudgetRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})))); also send when (body.@CreateBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@CreateBudgetRequest.member_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})); the family column is the upper bound; base families are payment, write; unreadable or invalid effect inputs are refused when the request condition reads them
budgets:getBudgetByIdreadGET/v1/budgets/{id}—
budgets:updateBudgetadmin, delete, payment, send, writePUT/v1/budgets/{id}account-security or privilege changes are refused by default when (body.@UpdateBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) (an explicit credential_minting allowance can allow the reviewed request); also admin when body.@UpdateBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"}); also delete when (body.@UpdateBudgetRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateBudgetRequest.member_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})); also payment when (body.@UpdateBudgetRequest.limit is non-null ({"missing”: false, “nullable”: true})) or (body.@UpdateBudgetRequest.limit_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“HARD”, “SOFT"]})) or (body.@UpdateBudgetRequest.period_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“WEEKLY”, “MONTHLY”, “QUARTERLY”, “YEARLY”, “ONE_TIME"]})) or (body.@UpdateBudgetRequest.spend_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“BUDGET_PROVISIONED_CARDS_ONLY”, “NON_BUDGET_PROVISIONED_CARDS_ALLOWED"]})) or (body.@UpdateBudgetRequest.start_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) or (body.@UpdateBudgetRequest.end_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) or (body.@UpdateBudgetRequest.member_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})); also send when (body.@UpdateBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateBudgetRequest.member_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateBudgetRequest.limit is non-null ({"missing”: false, “nullable”: true})); also write when not (the body contains only empty member_user_ids and/or owner_user_ids arrays, with at least one supplied); also delete when body.@UpdateBudgetRequest.period_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“WEEKLY”, “MONTHLY”, “QUARTERLY”, “YEARLY”, “ONE_TIME"]}); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
budgets:archiveBudgetdelete, sendPOST/v1/budgets/{id}/archive—
budgets:listSpendBudgetsreadGET/v2/budgets—
budgets:createSpendBudgetadmin, send, writePOST/v2/budgetsaccount-security or privilege changes are refused by default when ((body.@CreateSpendBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or ((body.@CreateSpendBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) and (not (body.@CreateSpendBudgetRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"}))))) (an explicit credential_minting allowance can allow the reviewed request); also admin when (body.@CreateSpendBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or ((body.@CreateSpendBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) and (not (body.@CreateSpendBudgetRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})))); also send when (body.@CreateSpendBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})); the family column is the upper bound; base families are write; unreadable or invalid effect inputs are refused when the request condition reads them
budgets:getSpendBudgetByIdreadGET/v2/budgets/{id}—
budgets:updateSpendBudgetadmin, delete, send, writePUT/v2/budgets/{id}account-security or privilege changes are refused by default when (body.@UpdateSpendBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateSpendBudgetRequest.parent_budget_id is present ({"missing”: false, “nullable”: true, “type”: “string"})) (an explicit credential_minting allowance can allow the reviewed request); also admin when body.@UpdateSpendBudgetRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"}); also delete when (body.@UpdateSpendBudgetRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})); also send when (body.@UpdateSpendBudgetRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateSpendBudgetRequest.amount is non-null ({"missing”: false, “nullable”: true})); also write when not (the body only sets owner_user_ids to an empty array); also admin, delete when body.@UpdateSpendBudgetRequest.parent_budget_id is present ({"missing”: false, “nullable”: true, “type”: “string"}); also delete when body.@UpdateSpendBudgetRequest.period_recurrence_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“WEEKLY”, “MONTHLY”, “QUARTERLY”, “YEARLY”, “ONE_TIME"]}); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
budgets:archiveSpendBudgetdelete, sendPOST/v2/budgets/{id}/archive—
budgets:listSpendLimitsreadGET/v2/spend_limits—
budgets:createSpendLimitadmin, delete, payment, send, writePOST/v2/spend_limitsaccount-security or privilege changes are refused by default when ((body.@CreateSpendLimitRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or ((body.@CreateSpendLimitRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) and (not (body.@CreateSpendLimitRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"}))))) (an explicit credential_minting allowance can allow the reviewed request); also admin when (body.@CreateSpendLimitRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or ((body.@CreateSpendLimitRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) and (not (body.@CreateSpendLimitRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})))); also send when (body.@CreateSpendLimitRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@CreateSpendLimitRequest.member_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})); also delete when body.@CreateSpendLimitRequest.end_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"}); the family column is the upper bound; base families are payment, write; unreadable or invalid effect inputs are refused when the request condition reads them
budgets:getSpendLimitByIdreadGET/v2/spend_limits/{id}—
budgets:updateSpendLimitadmin, delete, payment, send, writePUT/v2/spend_limits/{id}account-security or privilege changes are refused by default when (body.@UpdateSpendLimitRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"})) (an explicit credential_minting allowance can allow the reviewed request); also admin when body.@UpdateSpendLimitRequest.owner_user_ids is present ({"missing”: false, “nullable”: true, “type”: “array"}); also delete when (body.@UpdateSpendLimitRequest.owner_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateSpendLimitRequest.member_user_ids is non-null ({"missing”: false, “nullable”: true, “type”: “array"})); also payment when (body.@UpdateSpendLimitRequest.authorization_settings is non-null ({"missing”: false, “nullable”: true})) or (body.@UpdateSpendLimitRequest.transaction_limit is non-null ({"missing”: false, “nullable”: true})) or (body.@UpdateSpendLimitRequest.set_transaction_limit_null is one of [true] ({"missing”: false, “nullable”: true, “type”: “boolean"})) or (body.@UpdateSpendLimitRequest.period_recurrence_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“PER_WEEK”, “PER_MONTH”, “PER_QUARTER”, “PER_YEAR”, “ONE_TIME"]})) or (body.@UpdateSpendLimitRequest.spend_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“BUDGET_PROVISIONED_CARDS_ONLY”, “NON_BUDGET_PROVISIONED_CARDS_ALLOWED"]})) or (body.@UpdateSpendLimitRequest.start_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) or (body.@UpdateSpendLimitRequest.end_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) or (body.@UpdateSpendLimitRequest.set_start_date_null is one of [true] ({"missing”: false, “nullable”: true, “type”: “boolean"})) or (body.@UpdateSpendLimitRequest.set_end_date_null is one of [true] ({"missing”: false, “nullable”: true, “type”: “boolean"})) or (body.@UpdateSpendLimitRequest.member_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateSpendLimitRequest.merchant_category_controls is non-null ({"missing”: false, “nullable”: true})) or (body.@UpdateSpendLimitRequest.expense_policy_id is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) or (body.@UpdateSpendLimitRequest.auto_create_limit_cards_setting is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“DISABLED”, “ALL_MEMBERS"]})) or (body.@UpdateSpendLimitRequest.auto_transfer_cards_setting is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“DISABLED”, “ENABLED"]})) or (body.@UpdateSpendLimitRequest.status is one of [“ACTIVE”] ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“ACTIVE”, “EXPIRED”, “ARCHIVED”, “DELETED"]})); also delete when body.@UpdateSpendLimitRequest.status is one of [“EXPIRED”, “ARCHIVED”, “DELETED”] ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“ACTIVE”, “EXPIRED”, “ARCHIVED”, “DELETED"]}); also delete when body.@UpdateSpendLimitRequest.period_recurrence_type is non-null ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“PER_WEEK”, “PER_MONTH”, “PER_QUARTER”, “PER_YEAR”, “ONE_TIME"]}); also send when (body.@UpdateSpendLimitRequest.owner_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateSpendLimitRequest.member_user_ids is nonempty ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@UpdateAuthorizationSettings.base_limit is non-null ({"missing”: false, “nullable”: true})) or (body.@UpdateSpendLimitRequest.status is one of [“EXPIRED”, “ARCHIVED”, “DELETED”] ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“ACTIVE”, “EXPIRED”, “ARCHIVED”, “DELETED"]})); also write when not (the body contains only EXPIRED/ARCHIVED/DELETED status and/or empty member_user_ids/owner_user_ids arrays, with at least one supplied); also delete when body.@UpdateSpendLimitRequest.end_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"}); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
budgets:archiveSpendLimitdelete, sendPOST/v2/spend_limits/{id}/archive—
expenses:listExpensesreadGET/v1/expensesallowed; its secret is never stored in a payload capture
expenses:listExpenses_1readGET/v1/expenses/cardallowed; its secret is never stored in a payload capture
expenses:receiptMatchsend, writePOST/v1/expenses/card/receipt_matchallowed; its secret is never stored in a payload capture
expenses:getCardExpensereadGET/v1/expenses/card/{expense_id}allowed; its secret is never stored in a payload capture
expenses:updateExpensesend, writePUT/v1/expenses/card/{expense_id}also send when body.@UpdateExpenseRequest.memo is nonempty ({"missing”: false, “nullable”: true, “type”: “string"}); the family column is the upper bound; base families are write; unreadable or invalid effect inputs are refused when the request condition reads them
expenses:receiptUploadwritePOST/v1/expenses/card/{expense_id}/receipt_uploadallowed; its secret is never stored in a payload capture
expenses:getExpensereadGET/v1/expenses/{id}allowed; its secret is never stored in a payload capture
fields:listFieldsreadGET/v1/fields—
fields:createFieldwritePOST/v1/fields—
fields:deleteFieldValuesdeleteDELETE/v1/fields/{field_id}/values—
fields:listFieldValuesreadGET/v1/fields/{field_id}/values—
fields:createFieldValueswritePOST/v1/fields/{field_id}/values—
fields:updateFieldValuesdelete, writePUT/v1/fields/{field_id}/valuesalso delete when body.@UpdateFieldValueDataBody.is_disabled is one of [true] ({"missing”: false, “nullable”: true, “type”: “boolean"}); also write when not (the body contains a nonempty items list whose entries only identify an existing option and set data.is_disabled to true); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
fields:getFieldValueByIdreadGET/v1/fields/{field_id}/values/{brex_id}—
fields:deleteFielddeleteDELETE/v1/fields/{id}—
fields:getFieldByIdreadGET/v1/fields/{id}—
fields:updateFielddelete, writePUT/v1/fields/{id}also delete when body.@FieldUpdateBody.is_disabled is one of [true] ({"missing”: false, “nullable”: true, “type”: “boolean"}); also write when not (the body only sets is_disabled to true for the selected custom field); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
onboarding:listReferralsreadGET/v1/referralsrefused on every connection: no rule or allowance can allow it; its secret is never stored in a payload capture
onboarding:createReferralRequestsend, writePOST/v1/referralsrefused on every connection: no rule or allowance can allow it; also send when body.@CreateReferralRequest.contact_preference is one of [“EMAIL_OUTBOUND”] ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“NO_OUTBOUND”, “EMAIL_OUTBOUND"]}); the family column is the upper bound; base families are write; unreadable or invalid effect inputs are refused when the request condition reads them; its secret is never stored in a payload capture
onboarding:getReferralreadGET/v1/referrals/{id}refused on every connection: no rule or allowance can allow it; its secret is never stored in a payload capture
onboarding:createDocumentwritePOST/v1/referrals/{id}/document_uploadrefused on every connection: no rule or allowance can allow it; its secret is never stored in a payload capture
onboarding:processDelayedEINDocumentwritePOST/v1/referrals/{id}/process_ein_documentrefused on every connection: no rule or allowance can allow it
payments:createIncomingTransferpayment, writePOST/v1/incoming_transfers—
payments:listLinkedAccountsreadGET/v1/linked_accounts—
payments:listTransfersreadGET/v1/transfers—
payments:createTransferpayment, send, writePOST/v1/transfers—
payments:getTransfersByIdreadGET/v1/transfers/{id}—
payments:listVendorsreadGET/v1/vendors—
payments:createVendorwritePOST/v1/vendors—
payments:deleteVendordeleteDELETE/v1/vendors/{id}—
payments:getVendorByIdreadGET/v1/vendors/{id}—
payments:updateVendorwritePUT/v1/vendors/{id}—
team:listCardsByUserIdreadGET/v2/cards—
team:createCarddelete, payment, send, writePOST/v2/cardsalso delete when body.@SpendControlRequest.lock_after_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"}); the family column is the upper bound; base families are payment, send, write; unreadable or invalid effect inputs are refused when the request condition reads them
team:getCardByIdreadGET/v2/cards/{id}—
team:updateCarddelete, payment, send, writePUT/v2/cards/{id}also payment when ((body.@UpdateCardRequest.spend_controls is present ({"missing”: false, “nullable”: true})) and (not (body.@UpdateCardRequest.spend_controls is non-null ({"missing”: false, “nullable”: true})))) or (body.@SpendControlUpdateRequest.spend_limit is present ({"missing”: false, “nullable”: true})) or (body.@Money.amount is present ({"missing”: false, “type”: “integer"})) or (body.@Money.currency is present ({"missing”: false, “nullable”: true, “type”: “string"})) or (body.@SpendControlUpdateRequest.spend_duration is present ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“MONTHLY”, “QUARTERLY”, “YEARLY”, “ONE_TIME"]})) or (body.@SpendControlUpdateRequest.allowed_merchant_details is present ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@SpendControlUpdateRequest.blocked_merchant_details is present ({"missing”: false, “nullable”: true, “type”: “array"})) or (body.@SpendControlUpdateRequest.lock_after_date is present ({"missing”: false, “nullable”: true, “type”: “string"})); also delete when body.@SpendControlUpdateRequest.lock_after_date is non-null ({"missing”: false, “nullable”: true, “type”: “string"}); also send when ((body.@UpdateCardRequest.spend_controls is present ({"missing”: false, “nullable”: true})) and (not (body.@UpdateCardRequest.spend_controls is non-null ({"missing”: false, “nullable”: true})))) or (body.@SpendControlUpdateRequest.spend_limit is present ({"missing”: false, “nullable”: true})) or (body.@SpendControlUpdateRequest.spend_duration is present ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“MONTHLY”, “QUARTERLY”, “YEARLY”, “ONE_TIME"]})) or (body.@SpendControlUpdateRequest.lock_after_date is present ({"missing”: false, “nullable”: true, “type”: “string"})); also write when not (the request body contains only spend_controls.lock_after_date with a non-null string); the family column is the upper bound; base families are none; unreadable or invalid effect inputs are refused when the request condition reads them
team:lockCarddelete, sendPOST/v2/cards/{id}/lock—
team:getCardNumberreadGET/v2/cards/{id}/pan—
team:emailCardNumbersend, writePOST/v2/cards/{id}/secure_email—
team:terminateCarddelete, sendPOST/v2/cards/{id}/terminate—
team:unlockCardsend, writePOST/v2/cards/{id}/unlock—
team:getCompanyreadGET/v2/company—
team:listCostCentersreadGET/v2/cost_centers—
team:getCostCenterByIdreadGET/v2/cost_centers/{id}—
team:listDepartmentsreadGET/v2/departments—
team:createDepartmentwritePOST/v2/departments—
team:deleteDepartmentdeleteDELETE/v2/departments/{id}—
team:getDepartmentByIdreadGET/v2/departments/{id}—
team:updateDepartmentwritePUT/v2/departments/{id}—
team:listLegalEntitiesreadGET/v2/legal_entities—
team:getLegalEntityreadGET/v2/legal_entities/{id}—
team:listLocationsreadGET/v2/locations—
team:createLocationwritePOST/v2/locations—
team:deleteLocationdeleteDELETE/v2/locations/{id}—
team:getLocationByIdreadGET/v2/locations/{id}—
team:updateLocationwritePUT/v2/locations/{id}—
team:listTitlesreadGET/v2/titles—
team:createTitlewritePOST/v2/titles—
team:deleteTitledeleteDELETE/v2/titles/{id}—
team:getTitleByIdreadGET/v2/titles/{id}—
team:updateTitlewritePUT/v2/titles/{id}—
team:listUsersreadGET/v2/users—
team:createUseradmin, send, writePOST/v2/usersaccount-security or privilege changes are refused by default when ((body.@CreateUserRequest.role_name is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) and (not (body.@CreateUserRequest.role_name is one of [“Employee”] ({"missing”: true, “nullable”: true, “type”: “string"})))) (an explicit credential_minting allowance can allow the reviewed request); unreadable or invalid effect inputs are refused when the request condition reads them
team:addUseradmin, writePOST/v2/users/create—
team:getMereadGET/v2/users/me—
team:getUserByIdreadGET/v2/users/{id}—
team:updateUseradmin, delete, writePUT/v2/users/{id}account-security or privilege changes are refused by default when ((body.@UpdateUserRequest.role_name is non-null ({"missing”: false, “nullable”: true, “type”: “string"})) and (not (body.@UpdateUserRequest.role_name is one of [“Employee”] ({"missing”: true, “nullable”: true, “type”: “string"})))) (an explicit credential_minting allowance can allow the reviewed request); also delete when body.@UpdateUserRequest.status is one of [“DISABLED”, “ARCHIVED”, “DELETED”] ({"missing”: false, “nullable”: true, “type”: “string”, “valid_values”: [“ACTIVE”, “DISABLED”, “ARCHIVED”, “INACTIVE”, “DELETED"]}); also write when not (Match the whole parsed request body against this reviewed no-reference pure-destruction shape.); the family column is the upper bound; base families are admin; unreadable or invalid effect inputs are refused when the request condition reads them
transactions:listCardAccountsreadGET/v2/accounts/card—
transactions:listPrimaryCardStatementsreadGET/v2/accounts/card/primary/statements—
transactions:listAccountsreadGET/v2/accounts/cash—
transactions:getPrimaryAccountreadGET/v2/accounts/cash/primary—
transactions:getAccountreadGET/v2/accounts/cash/{id}—
transactions:listCashStatementsreadGET/v2/accounts/cash/{id}/statements—
transactions:listPrimaryCardTransactionsreadGET/v2/transactions/card/primary—
transactions:listCashTransactionsreadGET/v2/transactions/cash/{id}—
travel:listTripsreadGET/v1/trips—
travel:getTripreadGET/v1/trips/{trip_id}—
travel:listTripBookingsreadGET/v1/trips/{trip_id}/bookingsallowed; its secret is never stored in a payload capture
travel:getBookingreadGET/v1/trips/{trip_id}/bookings/{booking_id}allowed; its secret is never stored in a payload capture
webhooks:listWebhookSubscriptionsreadGET/v1/webhooks—
webhooks:createWebhookSubscriptionadmin, send, writePOST/v1/webhooksdelivery address in policy parameter url
webhooks:listWebhookGroupsreadGET/v1/webhooks/groups—
webhooks:createWebhookGroupadmin, writePOST/v1/webhooks/groups—
webhooks:deleteWebhookGroupadmin, deleteDELETE/v1/webhooks/groups/{id}—
webhooks:getWebhookGroupreadGET/v1/webhooks/groups/{id}—
webhooks:addWebhookGroupMembersadmin, send, writePOST/v1/webhooks/groups/{id}/add_members—
webhooks:listWebhookGroupMembersreadGET/v1/webhooks/groups/{id}/members—
webhooks:removeWebhookGroupMembersadmin, deletePOST/v1/webhooks/groups/{id}/remove_members—
webhooks:listWebhookSecretsreadGET/v1/webhooks/secretsallowed; its secret is never stored in a payload capture
webhooks:deleteWebhookSubscriptionadmin, deleteDELETE/v1/webhooks/{id}—
webhooks:getWebhookSubscriptionreadGET/v1/webhooks/{id}—
webhooks:updateWebhookSubscriptionadmin, delete, send, writePUT/v1/webhooks/{id}also send when body.@UpdateWebhookSubscriptionRequest.status is one of [“ACTIVE”] ({"missing”: null, “type”: “string”, “valid_values”: [“ACTIVE”, “INACTIVE"]}); also delete when (body.@UpdateWebhookSubscriptionRequest.status is one of [“INACTIVE”] ({"missing”: null, “type”: “string”, “valid_values”: [“ACTIVE”, “INACTIVE"]})) or ((body.@UpdateWebhookSubscriptionRequest.group_id is present ({"missing”: false, “nullable”: true, “type”: “string"})) and (not (body.@UpdateWebhookSubscriptionRequest.group_id is non-null ({"missing”: false, “nullable”: true, “type”: “string"})))); also write when not (Match the whole parsed request body against this reviewed no-reference pure-destruction shape.); the family column is the upper bound; base families are admin; unreadable or invalid effect inputs are refused when the request condition reads them; delivery address in policy parameter url
auth:authorization_endpointadmin, send, writeGET/oauth2/default/v1/authorizerefused by default: hands the caller a provider credential, or revokes the connection’s own (a credential_minting rule can allow it); served by the provider but absent from its published spec
auth:token_endpointadmin, writePOST/oauth2/default/v1/tokenrefused by default: hands the caller a provider credential, or revokes the connection’s own (a credential_minting rule can allow it); served by the provider but absent from its published spec
auth:userinfo_endpointreadGET/oauth2/default/v1/userinfoallowed; its secret is never stored in a payload capture; served by the provider but absent from its published spec
auth:registration_endpointadmin, send, writePOST/oauth2/v1/clientsrefused by default: hands the caller a provider credential, or revokes the connection’s own (a credential_minting rule can allow it); account-security or privilege changes are refused by default when ((body.token_endpoint_auth_method is one of [“private_key_jwt”] ({"missing”: false})) and ((body.jwks_uri is nonempty ({"missing”: false})) or (body.jwks.keys is nonempty ({"missing”: false})))) (an explicit credential_minting allowance can allow the reviewed request); also send when (body.frontchannel_logout_uri is present ({"missing”: false})) or (body.jwks_uri is nonempty ({"missing”: false})) or (body.request_uris[*] is nonempty ({"missing”: false})); the family column is the upper bound; base families are admin, write; unreadable or invalid effect inputs are refused when the request condition reads them; served by the provider but absent from its published spec
auth:jwks_urireadGET/oauth2/default/v1/keysserved by the provider but absent from its published spec
auth:introspection_endpointreadPOST/oauth2/default/v1/introspectserved by the provider but absent from its published spec
auth:revocation_endpointadmin, deletePOST/oauth2/default/v1/revokerefused by default: hands the caller a provider credential, or revokes the connection’s own (a credential_minting rule can allow it); served by the provider but absent from its published spec
auth:end_session_endpointadmin, delete, sendGET/oauth2/default/v1/logoutserved by the provider but absent from its published spec
auth:device_authorization_endpointadmin, writePOST/oauth2/default/v1/device/authorizerefused by default: hands the caller a provider credential, or revokes the connection’s own (a credential_minting rule can allow it); served by the provider but absent from its published spec
auth:pushed_authorization_request_endpointadmin, writePOST/oauth2/default/v1/parallowed; its secret is never stored in a payload capture; served by the provider but absent from its published spec
auth:authorization_endpoint:postadmin, send, writePOST/oauth2/default/v1/authorizerefused by default: hands the caller a provider credential, or revokes the connection’s own (a credential_minting rule can allow it); served by the provider but absent from its published spec
auth:userinfo_endpoint:postreadPOST/oauth2/default/v1/userinfoallowed; its secret is never stored in a payload capture; served by the provider but absent from its published spec
auth:end_session_endpoint:postadmin, delete, sendPOST/oauth2/default/v1/logoutserved by the provider but absent from its published spec
team:listRolesreadGET/v2/roles—

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.