ballerina/auth Ballerina library

Represents the client Basic Auth provider, which is used to authenticate with an external endpoint by generating a Basic Auth token against the provided credential configurations.

auth:CredentialsConfig config = {
    username: "tom",
    password: "123"
}
auth:ClientBasicAuthProvider provider = new(config);

init (CredentialsConfig credentialsConfig)

function generateToken() returns string|Error

string token = check provider.generateToken();

Represents the file user store based listener Basic Auth provider, which is used to authenticate the provided credentials against the provided file user store configurations.

auth:ListenerFileUserStoreBasicAuthProvider provider = new;

The users are denoted by a section in the Config.toml file. The username, password, and the scopes of a particular user are denoted as keys under the users section as shown below. For multiple users, the complete section has to be duplicated.

[[ballerina.auth.users]]
username = "alice"
password = "password1"
scopes = ["scope1", "scope2"]

init (FileUserStoreConfig fileUserStoreConfig)

function authenticate(string credential) returns UserDetails|Error

auth:UserDetails result = check provider.authenticate("<credential>");

Represents the LDAP-based listener Basic Auth provider, which is used to authenticate the provided credentials against the provided LDAP user store configurations. This connects to an active directory or an LDAP, retrieves the necessary user information, and performs authentication and authorization.

auth:LdapUserStoreConfig config = {
    domainName: "ballerina.io",
    connectionURL: "ldap://localhost:389",
    connectionName: "cn=admin,dc=avix,dc=lk"
};
auth:ListenerLdapUserStoreBasicAuthProvider provider = new(config);

init (LdapUserStoreConfig ldapUserStoreConfig)

function authenticate(string credential) returns UserDetails|Error

auth:UserDetails result = check provider.authenticate("<credential>");