Ballerina API Documentation

Functions of org.wso2.ballerina.connectors.oauth2 package

function constructAuthHeader(message request, string accessTokenValue, string accessToken) (string )

Parameters:

Parameter NameData TypeDescription
requestmessage
accessTokenValuestring
accessTokenstring

Return Parameters:

Return VariableData TypeDescription
string

function getAccessTokenFromRefreshToken(message request, string accessToken, string clientId, string clientSecret, string refreshToken, string refreshTokenEP) (string )

Parameters:

Parameter NameData TypeDescription
requestmessage
accessTokenstring
clientIdstring
clientSecretstring
refreshTokenstring
refreshTokenEPstring

Return Parameters:

Return VariableData TypeDescription
string


Connectors of org.wso2.ballerina.connectors.oauth2 package

connector ClientConnector (string baseUrl, string accessToken, string clientId, string clientSecret, string refreshToken, string refreshTokenEP)

OAuth2 client connector

Parameters:

Parameter NameData TypeDescription
baseUrlstringThe endpoint base url
accessTokenstringThe access token of the account
clientIdstringThe client Id of the account
clientSecretstringThe client secret of the account
refreshTokenstringThe refresh token of the account
refreshTokenEPstringThe refresh token endpoint url

Actions:

action delete()

Delete with OAuth2 authentication

Parameters:

Parameter NameData TypeDescription
clientConnectorClientConnectorThe oauth2 Connector instance
pathstringThe endpoint path
requestmessageThe request of the method

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action get()

Get with OAuth2 authentication

Parameters:

Parameter NameData TypeDescription
clientConnectorClientConnectorThe oauth2 Connector instance
pathstringThe endpoint path
requestmessageThe request of the method

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action patch()

Patch with OAuth2 authentication

Parameters:

Parameter NameData TypeDescription
clientConnectorClientConnectorThe oauth2 Connector instance
pathstringThe endpoint path
requestmessageThe request of the method

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action post()

Post with OAuth2 authentication

Parameters:

Parameter NameData TypeDescription
clientConnectorClientConnectorThe oauth2 Connector instance
pathstringThe endpoint path
requestmessageThe request of the method

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action put()

Put with OAuth2 authentication

Parameters:

Parameter NameData TypeDescription
clientConnectorClientConnectorThe oauth2 Connector instance
pathstringThe endpoint path
requestmessageThe request of the method

Return Parameters:

Return VariableData TypeDescription
messageresponse object


Menu

  • Functions
    • constructAuthHeader(message request, string accessTokenValue, string accessToken) (string )
    • getAccessTokenFromRefreshToken(message request, string accessToken, string clientId, string clientSecret, string refreshToken, string refreshTokenEP) (string )
  • Connectors
    • ClientConnector (string baseUrl, string accessToken, string clientId, string clientSecret, string refreshToken, string refreshTokenEP)
      • delete(ClientConnector clientConnector, string path, message request)
      • get(ClientConnector clientConnector, string path, message request)
      • patch(ClientConnector clientConnector, string path, message request)
      • post(ClientConnector clientConnector, string path, message request)
      • put(ClientConnector clientConnector, string path, message request)

Copyright 2017 Ballerina API Documentation