ballerina/oauth2

Represents the client OAuth2 provider, which is used to generate OAuth2 access tokens using the configured OAuth2 token endpoint configurations. This supports the client credentials grant type, password grant type, refresh token grant type, and the JWT bearer grant type.

1. Client Credentials Grant Type

oauth2:ClientOAuth2Provider provider = new({
    tokenUrl: "https://localhost:9445/oauth2/token",
    clientId: "3MVG9YDQS5WtC11paU2WcQjBB3L",
    clientSecret: "9205371918321623741",
    scopes: ["token-scope1", "token-scope2"]
});

2. Password Grant Type

oauth2:ClientOAuth2Provider provider = new({
    tokenUrl: "https://localhost:9445/oauth2/token",
    username: "johndoe",
    password: "A3ddj3w",
    clientId: "3MVG9YDQS5WtC11paU2WcQjBB3L",
    clientSecret: "9205371918321623741",
    scopes: ["token-scope1", "token-scope2"]
});

3. Refresh Token Grant Type

oauth2:ClientOAuth2Provider provider = new({
    refreshUrl: "https://localhost:9445/oauth2/token",
    refreshToken: "XlfBs91yquexJqDaKEMzVg==",
    clientId: "3MVG9YDQS5WtC11paU2WcQjBB3L",
    clientSecret: "9205371918321623741",
    scopes: ["token-scope1", "token-scope2"]
});

init (GrantConfig grantConfig)

function generateToken() returns string|Error

string token = check provider.generateToken();

Represents the listener OAuth2 provider, which is used to validate the received credential (access token) by calling the configured introspection endpoint.

oauth2:IntrospectionConfig config = {
    url: "https://localhost:9196/oauth2/token/introspect"
};
oauth2:ListenerOAuth2Provider provider = new(config);

init (IntrospectionConfig introspectionConfig)

function authorize(string credential, map<string>? optionalParams) returns IntrospectionResponse|Error

boolean result = check provider.authorize("<credential>");