Skip to content

Create a connect code

Create a single-use agent sign-in code for the selected organization. The code lasts 15 minutes and replaces any unredeemed code. Requires an authenticated browser session.

Parameters

#
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
A connection code a program can redeem to request your approval.
Show 2 attributesHide attributes
codestringAlways present
Connection code in XXXX-XXXX form.
expires_atstring (date-time)Always present
When this code stops being redeemable.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • Requires a signed-in website session.
  • A key limited to a command list cannot run this command.