ballerina/auth

Package Overview

This package provides listener Basic authentication providers, which can be used to authenticate the provided credentials against a file user store or an LDAP user store, and a client Basic authentication provider, which can be used to authenticate against an external endpoint.

For information on the operations, which you can perform with this package, see the below Functions. For examples on the usage of the operations, see the following.

Functions

[1]

extractUsernameAndPassword

Extracts the username and the password from the base64-encoded username:password value.

Classes

[3]

ClientBasicAuthProvider

Represents the client Basic Auth provider.

ListenerFileUserStoreBasicAuthProvider

Represents the file user store based listener Basic Auth provider, which is an implementation of the auth:ListenerBasicAuthProvider object.

ListenerLdapUserStoreBasicAuthProvider

Represents the LDAP based listener Basic Auth provider.

Object Types

[1]

ListenerBasicAuthProvider

Represents the listener Basic Auth provider, which could be used to authenticate credentials.

Records

[5]

CredentialsConfig

Represents credentials for Basic Auth authentication.

FileUserStoreConfig

Represents the file user store configurations.

LdapUserStoreConfig

Represents the configurations that are required for an LDAP user store.

SecureSocket

Configures the SSL/TLS options to be used for LDAP communication.

UserDetails

Represents the details of the authenticated user.

Errors

[1]

Error

Represents the Auth error.