jon thompson

API Documentation : Random Password Generator

CONTENTS

Name

Random Password Generator

Description

Generate a random password

Version

1.0.001

Released

11th February 2019

Last Updated

11th February 2019

 

GET

The most basic method, with no configurable options apart from the length of the returned password

Returns

A plain-text response containing the password

Example 1: Default usage

/api/password/randomPasswordGenerator

Returns a 12-character random password, containing upper- and lower-case alphanumeric characters plus punctuation

Example 2: Specifying the password length

/api/password/randomPasswordGenerator/20

Returns a 20-character random password, containing upper- and lower-case alphanumeric characters plus punctuation

 

POST

Allows full control of all available options. This option is currently under development

Returns

A plain-text response containing the password

uppercase = boolean (default TRUE)

  • Include uppercase letters in the result

lowercase = boolean (default TRUE)

  • Include lowercase letters in the result

numbers = boolean (default TRUE)

  • Include numbers in the result

remove_confusing = boolean (default TRUE)

  • Remove characters that can be easily confused with others

must_uppercase = boolean (default FALSE)

  • The password must have at least 1 uppercase letter in it

must_lowercase = boolean (default FALSE)

  • The password must have at least 1 lowercase letter in it

must_numbers = boolean (default FALSE)

  • The password must have at least 1 number in it

must_punctuation = boolean (default FALSE)

  • The password must have at least 1 punctuation mark in it

serial_style = boolean (default FALSE)

  • This is a special-case option that uses a mix of uppercase letters and numbers to generate a random serial number-style password, with groups of four characters seperated by hyphens
  • Example: 5X75-PXBZ-SE4Z-WPGD

length = integer (default 12)

  • The length of the password to generate

 

HEAD

Not allowed