account

Claim or change the organization handle

Changed on

Claim the organization's handle, or change it. Its sign-in page then answers at https://auth.sv/{handle}, beside the base62 address of the account id, which keeps working. A change commits only against the impacts the server computes: send impacts_acknowledged empty, and a change answers 409 IMPACTS_CHANGED with details.impacts, the addresses it moves, and details.impacts_acknowledged, their acknowledgements; confirm by sending those acknowledgements back as listed. An acknowledgement names one impact whole (its kind and both addresses), so a confirm made before another change landed is refused again with the impacts the change has now. A first claim moves no address and commits at once. The old handle stays the organization's for good: its address redirects to the current one, and no one can claim it again, the organization included. An organization keeps at most 3 former handles: past them, the 409 also lists in details.tombstone_candidates the former handles the change may give up (those it left at least 30 days ago), and the confirm names one as tombstone_handle. A given-up handle stays the organization's, never claimable again, and stops redirecting. An organization claims or changes a handle only while it holds a product the handle serves (Secure Identity, the help desk or Notify), and changes it at most 3 times in 30 days; a first claim is no change. A request for the handle the organization already holds changes nothing. Each claim spends one of the account's 60 hourly handle checks. Org admins only, from an interactive session.

put/account/organization-handle

Request

Request body

handlestring required

An organization handle: three to 40 lowercase letters, digits and single hyphens, starting with a letter and ending with a letter or digit.

impacts_acknowledgedstring[] required

The impacts the admin confirmed: empty for a first claim, and for a change the acknowledgements a 409 IMPACTS_CHANGED answer listed in details.impacts_acknowledged, sent back as listed.

tombstone_handlestring

The former handle a change gives up, sent only when the organization already keeps the most former handles it can: one of the details.tombstone_candidates a 409 IMPACTS_CHANGED or HANDLE_TOMBSTONE_REQUIRED answer listed.

Response

The handle the organization now holds, and the addresses the change moved.

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

      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

    • 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

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      added the new help_desk_email_domain enum value to the /// response property for the response status

    • warning

      added the new notify_email_domain enum value to the /// response property for the response status

    • info

      removed the email_domain enum value from the /// response property for the response status