logout_by_issuer.md

logout_by_issuer

Logs a user out of all Magic SDK sessions given the user's Decentralized ID (iss). This method is useful if you store the iss with your user data, which is recommended.

User.logout_by_issuer(issuer)

Arguments:

• issuer (str): The user's Decentralized ID, which can be parsed using Token.get_issuer

Raises:

• RateLimitingError: If you have sent too many requests within a given period of time.
• BadRequestError: If the supplied parameters are invalid.
• AuthenticationError: If your API secret key cannot be authenticated with Magic API server.
• ForbiddenError: If your API secret key is not authorized to access the resources.
• APIError: For any other API error.
• APIConnectionError: If your server cannot communicate with the Magic server. Normally this is a network communication error.

{% hint style="info" %} See Error Handling for more examples. {% endhint %}

Returns:

• A MagicResponse.

Example:

The example below is assuming you are already using a Python Web Framework (Django, Flask, Cherrypy, etc.) Web framework's specific imports are omitted in favor of the simplicity of the example. Only the magic_admin related imports are shown below.

from magic_admin import Magic
from magic_admin.error import DIDTokenError
from magic_admin.error import RequestError


@user.route('/v1/user/logout', method=['POST'])
def user_logout(self, user_id):
    magic = Magic(api_secret_key='<YOUR_API_SECRET_KEY>')

    # Load user by user_id.
    user = logic.User.load_by_id(user_id)
    
    try:
        magic.User.logout_by_issuer(user.issuer)
    except RequestError as e:
        # You can also remap this error to your own application error.
        return HttpError(str(e))
    
    return HttpResponse()