Authentication and Authorization (CLI)

Manages the Authentication and Authorization for recovery user (through iota-cli)

API

• Authorize

  • Description: On successful authorization, only returns 200, and on failure returns 401 or 403.

  • Path: /auth/login

  • Method: POST

  • Minimum user role: unauthorized

  • Request data schema:

    {
      "username": "<...>",
      "password": "<...>"
    }

    • username - any user’s username.
    • password - the secret/password in the configuration which can be retrieved via this api too.

  • Response on success -> 200 OK:

    {
        "message": "...",
        "data": {
            "token": "...",  // NOTE: the value is random and useless. it's only for compatibility with profitap-pam.
            "role": "..."    // NOTE: the value is random and useless. it's only for compatibility with profitap-pam.
        }
    }

  • Response on bad creds -> 401 UNAUTHORIZED: empty body.

• Get Credentials (secret/password)

  • Description: Get credentials for the cli login.

  • Path: /auth/recovery/creds

  • Method: GET

  • Minimum user role: admin

  • Response on success -> 200 OK:

    {"message": "...", "data": {"password": "..."}}

    • password - the secret/password to login.

  • NOTES: It’s not expected to fail.

• Generate New Credentials (new secret/password)

  • Description: Generates new secret/password and replaces the old one.

  • Path: /auth/recovery/creds/renew

  • Method: POST

  • Minimum user role: admin

  • Request data schema: empty. any given payload is ignored.

  • Response on success -> 200 OK:

    {"message": "...", "data": {"password": "..."}}

    • password - the secret/password to login.

  • NOTES: It’s not expected to fail.

Back to Index