Menu AuthGuardHelp centre
Portuguêsauthguard.pt

Administrators · Approval requests

Third-party requests: operation types and machine clients

  • 1 min read
  • SaaS · Self-hosted
  • Video
Tutorial 13Approval requests1:58 · Narrated in Portuguese, with English captions.Transcript and details

One of your organization's systems (an ERP, a payments application) can ask a person to approve a specific operation. The administrator defines the operation types and machine clients under «Manage» › «Third-party requests». The pane appears only when the service has this feature.

Operation type

Under «Operation types», fill in:

FieldNotes
«Key»For example invoice.pay: lowercase, digits and . _ -, 3 to 64 characters
«Display name»What the person sees, up to 80 characters
«Maximum validity (seconds)»60 to 86,400
«Fields (JSON)»1 to 16 typed fields (text, integer, decimal, amount with currencies, date, yes/no, choice)
«Approval on the user's phone»«Not allowed on the phone», «With the code typed on the phone» or «By comparing the code on the phone»
Status«Active» or «Disabled»

Choose «Save type». Each save creates a revision; each request is tied to the revision it was created under.

With «With the code typed on the phone», the originating system must show the person the comparison code. Use compare mode only when the person cannot see the code: it does not protect against approvals given out of fatigue.

Machine client

Under «Machine clients», fill in the name, the scopes («Create requests (intents:write)», «Read requests (intents:read)»), the «Operation types (comma-separated)» and, optionally, the webhook (https://). Choose «Create client».

«Client created. Copy the secrets now: they will not be shown again.» The client ID, client secret and, with a webhook, the webhook secret are shown.

Afterwards: «Rotate secret» (the previous one is refused at once), «Webhook» (sets or removes the address and issues a new secret) and «Disable».

Webhooks

The server delivers only to domains the operator allowed. Without that list: «Webhooks are unavailable in this installation.»

Integration

The development team follows Create an approval request.

Error codes in this article

Article referencead-third-party-requestsquote it to support to identify this article. Checked against the product at commit 5f6607a8.