Method revoke_token

dwave/cloud/auth/flows.py:244–275

Revoke OAuth 2.0 token. Args: token: OAuth 2.0 access or refresh token to be revoked. If refresh token is specified, the authorization server should also revoke the corresponding access tokens. If ``token`` is not specified, then

(self, *,
                     token: Optional[str] = None,
                     token_type_hint: Optional[
                         Literal['access_token', 'refresh_token']] = None
                     )

        return token

    def revoke_token(self, *,
                     token: Optional[str] = None,
                     token_type_hint: Optional[
                         Literal['access_token', 'refresh_token']] = None
                     ) -> bool:
        """Revoke OAuth 2.0 token.

        Args:
            token:
                OAuth 2.0 access or refresh token to be revoked. If refresh token
                is specified, the authorization server should also revoke the
                corresponding access tokens. If ``token`` is not specified, then
                current refresh token is revoked.
            token_type_hint:
                Type of the token to be revoked.

        Returns:
            Token revocation status. True if revocation was successful, or token
            was invalid already. False in case of an error.

        Note:
            Token revocation requires that a ``revocation_endpoint`` is defined
            in :class:`~dwave.cloud.auth.flows.AuthFlow` construction.
        """
        if self.revocation_endpoint is None:
            raise TypeError("Revocation endpoint undefined.")

        response: requests.Response = self.session.revoke_token(
            url=self.revocation_endpoint, token=token,
            token_type_hint=token_type_hint)

        return response.ok

    def ensure_active_token(self):
        if not self.token: