Skip to navigation

Authorize Inbox

Authorizes the AgentID sign-in a client is already waiting in, for the inbox in the path, and returns the ID of the pending public key it will activate. Read the key with Get API Key. A repeat for the same token, inbox, and bearer returns the same key ID. A 403 AppSignupLimitError means the app accepts no more sign-ups from your organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Request

This endpoint expects an object.
auth_tokenstringRequiredformat: "^[A-Za-z0-9_-]{22}$"=22 characters

Token identifying one pending AgentID sign-in, read from the sign-in action on exactly https://auth.agentid.com.

accept_disclosurebooleanOptional

Accept the app's disclosure on the agent's behalf, skipping the first-use disclosure page. Requires app_share_owner when owner scopes are involved.

Response

This endpoint returns an object.
api_key_idstring
ID of the public key the client will activate.
instructions"Authorization complete. Return to browser."
The agent's next step. Nothing further is required from the agent.

Errors

400
Validation Error
403
App Signup Limit Error
404
Not Found Error