Module: Msf::WebServices::Documentation::Api::V1::UserApiDoc

Includes:

Swagger::Blocks

Defined in:

lib/msf/core/web_services/documentation/api/v1/user_api_doc.rb

Constant Summary

USERNAME_DESC =

'The username of the user.'

USERNAME_EXAMPLE =

'bmoose'

PASSWORD_DESC =

'The password of the user.'

PASSWORD_EXAMPLE =

'pass123'

CRYPTED_PASSWORD_DESC =

'The encrypted password of the user.'

CRYPTED_PASSWORD_EXAMPLE =

'$2a$10$ZOmd0VVkcVLTKW/0Cw0BMeqVITeVN4tPQvRvwBizNyM1NIz45oxda'

PASSWORD_SALT_DESC =

'The password salt for the user\'s password.'

PERSISTENCE_TOKEN_DESC =

'The persistence token for the user.'

PERSISTENCE_TOKEN_EXAMPLE =

'1a6347561b72aff163b4c1b8324cfdf9ccca37caa681e29d348677afe0cb56927e2e3ab4dc612723'

FULLNAME_DESC =

'The user\'s full name.'

FULLNAME_EXAMPLE =

'Bullwinkle J. Moose'

EMAIL_DESC =

'The user\'s email address.'

EMAIL_EXAMPLE =

'bullwinkle_moose@rapid7.com'

PHONE_DESC =

'The user\'s phone number.'

PHONE_EXAMPLE =

'555-555-5555'

COMPANY_DESC =

'The user\'s company.'

COMPANY_EXAMPLE =

'Rapid7'

PREFS_DESC =

'The user\'s preferences.'

PREFS_EXAMPLE =

{}

ADMIN_DESC =

'A boolean indicating whether the user is an admin.'

ADMIN_EXAMPLE =

false