• Getting started
  • With EC2
  • With Rackspace
  • With Eucalyptus
  • With OpenStack
  • With OVH/OpenStack
  • With Docker
  • With Xen/KVM/VMWare
  • With bare-metal using gPXE
• Tutorials
  • Writing an application template
  • Using the command-line interface
• User Guide
  • Introduction
  • Fundamental Concepts
  • Architecture
• API
  • Overview
  • Interactions
  • Resources
  • Services
  • Template Rendering
  • Schemas
  • Python Library
• Other
  • Frequently Asked Questions
  • Support

Account service

User account related methods. A user account may be created using 2 different ways: either the account is directly created by a ComodIT administrator, either the new user has registered itself, possibly using an invitation token.

In the case a user registered itself, its account must first be enabled before it may be used, this is generally done by clicking on a link sent by e-mail to the user.

When a user wants to delete its account, it should delete itself (see user resource URLs). If the user has forgotten its password, it may request ComodIT to provide a password reset token (sent by e-mail), which can be used to actually reset the password.

Methods

Verify authentication

/account/_verify

GET: verify that the user is authenticated by simply returning the JSON description of authenticated user.

Register a new user

/account/_register?token={token}

PUT: registers a new user whose representation is provided. token parameter has to be provided if ComodIT runs in INVITE mode. In PUBLIC mode, no token has to be provided. In PRIVATE mode, no registration is allowed.

Note that once a user is registered, it still needs to enable its account in order to be able to use ComodIT.

This URL does not require authentication.

Enable a registered user

/account/_enable?username={username}&token={token}

GET: Enables a registered user given its username and a provided token.

This URL does not require authentication.

Request password reset

/account/_requestPasswordReset?email={email}

PUT: Request for a password reset; provided e-mail must be associated to a ComodIT user. An e-mail containing a reset token is sent to provided address.

This URL does not require authentication.

Reset password

/account/_resetPassword

PUT: Resets password for given user. Provided data must be a JSON object as follows:

{
   "token" : "{token}",
   "username" : "{username}",
   "password" : "{password}"
}

• token is provided in an e-mail sent by ComodIT (see Request password reset).
• password is the new password of targeted user.

This URL does not require authentication.