OAUTH_AUTHENTICATE_CREDENTIAL Procedure

60.21 OAUTH_AUTHENTICATE_CREDENTIAL Procedure

This procedure performs OAuth authentication using a credential store. The obtained access token and its expiry date are stored in a package global.

Syntax

APEX_WEB_SERVICE.OAUTH_AUTHENTICATE_CREDENTIAL (
    p_token_url              IN VARCHAR2,    
    p_credential_static_id   IN VARCHAR2,
    p_proxy_override         IN VARCHAR2 DEFAULT NULL,
    p_transfer_timeout       IN NUMBER   DEFAULT 180,
    p_wallet_path            IN VARCHAR2 DEFAULT NULL,
    p_wallet_pwd             IN VARCHAR2 DEFAULT NULL,
    p_https_host             IN VARCHAR2 DEFAULT NULL );

Parameters

Parameter	Description
`p_token_url`	The url endpoint of the OAuth token service.
`p_credential_static_id`	The name of the Web Credentials to be used. Web Credentials are configured in Workspace Utilities.
`p_proxy_override`	The proxy to use for the request.
`p_transfer_timeout`	The amount of time in seconds to wait for a response.
`p_wallet_path`	The filesystem path to a wallet if request is HTTPS. For example, `file:/usr/home/oracle/WALLETS`
`p_wallet_pwd`	The password to access the wallet.
`p_https_host`	The host name to be matched against the common name (CN) of the remote server's certificate for an HTTPS request.

Example

BEGIN
    apex_web_service.oauth_authenticate_credential(
        p_token_url => 'https://api.example.com/ords/scott/oauth/token',
        p_credential_static_id => '[web-credential]');
END;

Parent topic: APEX_WEB_SERVICE