.. meta::
    :description: This documentation will guide you through the use of the Memset API.

.. index::
   double: Methods; memstore.user

.. _memstore.user:

Memstore User Methods
---------------------

These methods allow you to manage Memstore users.

This functionality is not available through the OpenStack Object Storage API.

.. function:: memstore.user.create

    Create a new user in a Memstore instance.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :param username: Name of the user. Username can only contain numbers, letters, dots, dashes and underscores, and can't start with a dot. Ensure this value has at most 50 characters.
    :type username: String
    
    :param password: User password.
    :type password: String
    
    :param enabled: If the user is enabled or not after being created.
    :type enabled: Boolean
    
    :returns: a dictionary as described in :func:`memstore.user.info`.
    
    The user name must be unique for the cloud storage - if not it returns
    :class:`ApiErrorNotUnique`.
    
    User name can only contain numbers, letters, dots, dashes and underscores, and can't
    start with a dot.

.. function:: memstore.user.delete

    Delete a user in a Memstore instance.
    
    The *admin* user can't be deleted.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :param username: Name of the user. Username can only contain numbers, letters, dots, dashes and underscores, and can't start with a dot. Ensure this value has at most 50 characters.
    :type username: String
    
    

.. function:: memstore.user.disable

    Disable a user in a Memstore instance.
    
    A disabled user can't login through any of the cloud storage interfaces.
    
    The *admin* user can't be disabled.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :param username: Name of the user. Username can only contain numbers, letters, dots, dashes and underscores, and can't start with a dot. Ensure this value has at most 50 characters.
    :type username: String
    
    

.. function:: memstore.user.enable

    Enable a user in a Memstore instance.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :param username: Name of the user. Username can only contain numbers, letters, dots, dashes and underscores, and can't start with a dot. Ensure this value has at most 50 characters.
    :type username: String
    
    

.. function:: memstore.user.info

    Describe an existing user in a Memstore instance.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :param username: Name of the user. Username can only contain numbers, letters, dots, dashes and underscores, and can't start with a dot. Ensure this value has at most 50 characters.
    :type username: String
    
    :returns: a dictionary with the following keys:
    
        **username**
            String: Name of the user.
        **enabled**:
            Boolean: If the user is enabled or not.
        **admin**
            Boolean: If the user is the administrator of the storage.

.. function:: memstore.user.list

    List all existing users in a Memstore instance.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :returns: a list of dictionaries where each dictionary is as described in :func:`memstore.user.info`.
    
    The returned user name must be concatenated to the storage name using a dot to get the
    username for authentication purposes (ie. *msstore1* and *admin* would be *msstore1.admin*).

.. function:: memstore.user.set_password

    Set a new password for an existing user in a Memstore instance.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :param username: Name of the user. Username can only contain numbers, letters, dots, dashes and underscores, and can't start with a dot. Ensure this value has at most 50 characters.
    :type username: String
    
    :param password: User new password.
    :type password: String