GEgetauctor

Save Grant

Changed on

Save credentials validated by a trusted integration callback.

put/api/py/integrations/{provider}/grant

Request

  • Base URL
    https://api.getauctor.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.getauctor.com/api/py/integrations/{provider}/grant
  • Auth
    none declared

Path parameters

providerstring required

Request body

principal_type'user' | 'org' required

Who owns a credential; extensible (AUC-5797 §2).

principal_idstring required
external_keystring
state'active' | 'pending'
access_tokenstring required
refresh_tokenstring nullable
expires_ininteger nullable
scopestring nullable
token_typestring nullable
metadataobject

Response

Successful Response

state'pending' | 'active' | 'needs_reauth' | 'revoked' required
providerstring required
grant_idstring nullable
grant_versionstring date-time nullable

Changes

  • 91ca93f86d79Revision changes
    • info

      added the new optional request property

  • a5de876e9fc3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status