STstuut
ap-portals

Create Account Login

Create login

Register an AP-portal login (provider + credentials) for the org. Credentials are encrypted at rest and never returned. Tie a customer portal to it before sweeping.

post/v2/ap-portals/accounts

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

provider'kehe' | 'taulia' | 'coupa' | 'ariba' | 'meijer' | 'kroger' | 'walgreens' | 'albertsons' | 'target' | 'heb' | 'heb_sidm' | 'c_and_s' | 'walmart' | 'walmart_highradius' | 'cvs' | 'cvs_sap' | 'cvs_image_silo' | 'kroger_supplier_connect' | 'kroger_claimtrax' | 'kroger_verigon' | 'servicetitan' | 'sandbox' | 'generic' required

Supported AP Portal providers.

usernamestring required
passwordstring required
header_tokenstring nullable

Optional header token for API authentication (e.g. x-bot-token for Walmart).

totp_secretstring nullable

Base32 TOTP seed for authenticator-app MFA; the sweep mints the one-time code at login. Write-only.

scopeAPPortalScope[]

Non-empty list of document kinds to sweep. Defaults to INVOICES + ORDERS for all providers; omit INVOICES for orders-only logins.

login_urlstring nullable

The login's own sign-in page when it differs from the provider's default, such as https://go.servicetitan.com/ for a ServiceTitan user outside Enterprise Hub.

Response

Successful Response

idstring required
provider'kehe' | 'taulia' | 'coupa' | 'ariba' | 'meijer' | 'kroger' | 'walgreens' | 'albertsons' | 'target' | 'heb' | 'heb_sidm' | 'c_and_s' | 'walmart' | 'walmart_highradius' | 'cvs' | 'cvs_sap' | 'cvs_image_silo' | 'kroger_supplier_connect' | 'kroger_claimtrax' | 'kroger_verigon' | 'servicetitan' | 'sandbox' | 'generic' required

Supported AP Portal providers.

usernamestring nullable required
status'active' | 'locked' | 'awaiting_auth' | 'password_expiring' | 'password_expired' | 'connecting' required

Status of an AP portal account (the login/credential).

scopeAPPortalScope[] required
login_urlstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.