Agents

Read a pending agent authorization, for the consent screen

What the console shows a signed in owner before they approve an agent: the client's name, where its authorization code would go (redirect_host), whether that destination is a known assistant's own (verified, verified_as) or the person's own computer (local), whether the name imitates a brand it does not belong to (imitates; such a request cannot be approved), how the client identified itself, and the scopes asked for. The unguessable request id is the capability: it needs no other credential and reveals only this.

get/agent/consent-request/{id}

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/agent/consent-request/{id}
  • Auth: none required

Path parameters

idstring required

Response

The pending request

client_idstring required
client_namestring required
redirect_uristring required

Where the authorization code goes if the person approves.

scopesAgentScope[] required

What the agent asked for.

statestring

The agent's own state value, echoed back to it.

redirect_hoststring required

The host of redirect_uri. The client cannot choose it freely the way it chooses its name, so show it.

verifiedboolean required

True when redirect_host is a known assistant's own callback host or a loopback address, and the name imitates no brand.

verified_asstring

The known assistant redirect_host belongs to.

localboolean required

True when the code goes to a program on the approver's own computer (a loopback redirect).

imitatesstring

The brand the name claims without owning the redirect host. Such a request cannot be approved.

registration'dynamic' | 'metadata_document' required

How the client identified itself, by RFC 7591 registration or by a Client ID Metadata Document.

registered_atstring date-time

When a dynamically registered client registered.

client_id_hoststring

The host that publishes a metadata document client's document.

Changes

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