hd

Begin a Secure Identity sign-in

Changed on

The authorize URL of the desk organization's own Secure Identity for the desk's sign-in client, to send the browser to, and the binding the tab keeps until the sign-in returns. The sign-in returns to {origin}/auth/callback, where the portal completes it with that binding; it completes for no other tab. Only a desk whose customers sign in with Secure Identity answers it.

post/hd/desks/{desk_id}/auth/identity/start

Request

Path parameters

desk_idstring required

The desk, as its lookup answered it.

Headers

X-SV-Client'help-desk-portal' required

Names the portal. A request without it answers 400 CLIENT_HEADER_REQUIRED.

Request body

originstring required

The portal origin the sign-in starts on: one of the desk's own addresses.

return_tostring required

The path on that origin to return to after sign-in.

Response

Where to send the browser, and what to send back with the code.

Changes

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status