Credential Schema

The Credential schema represents authentication credentials for Basic Authentication in Rusty Beam. It defines username/password combinations and role-based access control information.

Schema URL: https://rustybeam.net/schema/Credential
Used by: Basic Auth Plugin

Properties

Property Type Cardinality Description
username https://rustybeam.net/schema/Text 1 The user's login name
password https://rustybeam.net/schema/Text 1 The user's password (plaintext or hashed based on encryption property)
role https://rustybeam.net/schema/Text 0..n User roles for authorization (e.g., "administrators", "users")
encryption https://rustybeam.net/schema/Text 0..1 Password encryption type: "plaintext" or "bcrypt" (defaults to plaintext if not specified)

Example

Example credentials in an auth file:

<table itemscope itemtype="https://rustybeam.net/schema/Credential">
    <tr>
        <td><span itemprop="username">admin</span></td>
        <td><span itemprop="password">$2b$10$abc123...</span></td>
        <td><span itemprop="role">administrators</span></td>
        <td><span itemprop="encryption">bcrypt</span></td>
    </tr>
</table>

See Also