CloudTruth Utils API

openapi: 3.2.0
info:
  title: CloudTruth Management Utils API
  version: v1
  description: CloudTruth centralizes your configuration parameters and secrets making them easier to manage and use as a team.
  contact:
    name: CloudTruth Support
    email: support@cloudtruth.com
tags:
- name: Utils
paths:
  /api/v1/utils/generate_password/:
    post:
      operationId: utils_generate_password_create
      description: Endpoint for accessing utility functions
      summary: Get a randomly generated password using AWS Secrets Manager, with fallback to…
      parameters:
      - in: query
        name: length
        schema:
          type: integer
        description: The length of the password to generate.  Minimum of 8, maximum of 4095.
        required: true
      - in: query
        name: require_hardware_generation
        schema:
          type: boolean
          default: false
        description: 'Default behavior is to fallback to /dev/urandom if we fail to get a random password from AWS Secrets Manager.  If set to ''True'', we will not fallback to local password generation using /dev/urandom.  Default: False'
      - in: query
        name: require_lowercase
        schema:
          type: boolean
          default: true
        description: 'The password must include lowercase letters [a-z]. Default: True.'
      - in: query
        name: require_numbers
        schema:
          type: boolean
          default: true
        description: 'The password must include numbers [0-9].  Default: True.'
      - in: query
        name: require_spaces
        schema:
          type: boolean
          default: false
        description: 'The password must include spaces [ ].  Default: False.'
      - in: query
        name: require_symbols
        schema:
          type: boolean
          default: false
        description: 'The password must include symbols [!"#$%&''()*+,-./:;<=>?@[\]^_`{|}~].  Default: False.'
      - in: query
        name: require_uppercase
        schema:
          type: boolean
          default: true
        description: 'The password must include uppercase letters [A-Z].  Default: True.'
      tags:
      - Utils
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneratedPasswordResponse'
              examples:
                GenerateAPassword:
                  value:
                    value: S*f4wg8lR$7gfwefhuL>UIuyg4efb
                  summary: Generate a password
                  description: Successfully generated random password.
          description: ''
components:
  schemas:
    GeneratedPasswordResponse:
      type: object
      properties:
        value:
          type: string
          description: The generated password value
      required:
      - value
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your CloudTruth API Key to authenticate to the API.  You can get\nan API Key by creating a Service Account.  During setup of the Service\nAccount you will generate a long-lived API key intended for use by automation\nand API clients.  Access through the service account will be audited separately\nfrom any other user.\n\nIf you are just trying to use the API in a normal workflow, this is likely the\nauthentication mechanism you want to use.\n\nTo use the API Key, place your API Key in the Authorization header as 'Api-Key APIKEY', where\nAPIKEY is your CloudTruth API Key.  For example:\n\n    Authorization: Api-Key fskur.ghlsiudhrg84so938r5u\n        "
    JWTAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your JWT to authenticate to the API.  This is how the CloudTruth\nWeb UI authenticates to the backend.  It requires a user to have already logged in\nand gotten a JWT from the login process.  This is usually done by an Auth0 authentication\nflow from one of the Auth0 javascript libraries.  Alternatively, you can pull the\nJWT from your browser if you have a logged in session with the CloudTruth UI.\n\nThis authentication mechanism is intended for deeper integrations into the CloudTruth\nsystem, where you want to handle the user logins directly in your application.  For\nnormal API use, you likely want the Api-Key authentication header and not this one.\n\nTo use the JWT, place your JWT in the Authorization header as 'Bearer JWT', where\nJWT is your JWT.  For example:\n\n    Authorization: Bearer eyJhbGciOiJIkuydfy.eyJzdWIiOiIxMjM....\n        "
    tokenAuth:
      type: http
      scheme: bearer
externalDocs:
  url: https://docs.cloudtruth.com/