SPsparkvault
hd

Sign the customer out

Changed on

End the sessions the sign-out's credentials name, on the server. A refresh token in the body is its own proof: the Secure Identity session it names is revoked at the identity service whatever the bearer, stale or absent. A help desk session token (hdt_…) as the bearer is revoked; a Secure Identity access token as the bearer, with no refresh token sent, revokes the session it names. A sign-out naming nothing it can end (no credential, or a bearer that is no customer's of this desk) ends nothing and answers the same. On a desk whose customers do not sign in with Secure Identity now, the identity service takes no revocation for it, so a Secure Identity session ends there on its own.

post/hd/desks/{desk_id}/auth/logout

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

refresh_tokenstring

The Secure Identity refresh token the portal holds.

Response

Signed out of what the sign-out names, and nothing else: while the desk's customers sign in with Secure Identity, the desk's Secure Identity session the refresh token sent names, or, with none sent, the one a bearer access token of the desk's names; and the help desk session an hdt_… bearer is. A bearer access token sent beside a refresh token is not revoked.

Changes

  • a9a10e328ba5Revision 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

  • 56d7c265a77aRevision changes
    • 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