---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: OAuth1
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_OAuth1Ref.html
---
# Chilkat OAuth1 — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · class=OAuth1
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/OAuth1.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/guide.md`.

## Purpose

**Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.**

`Chilkat.OAuth1` builds the signed OAuth 1.0 authentication data needed for APIs that still require OAuth 1.0 request signing. It can generate the signature base string, HMAC key, signature, URL-encoded signature, normalized signed parameter string, Authorization header, and generated URL containing OAuth query parameters. It supports consumer credentials, access tokens, nonce and timestamp generation, extra signed parameters, optional realm handling, HMAC-SHA1, HMAC-SHA256, RSA-SHA1, and RSA-SHA256 signing.

**OAuth 1.0 signing**

Generate the OAuth 1.0 signature and related authentication values from the HTTP method, request URL, credentials, token, nonce, and timestamp.

**Authorization header**

Produce the value to send in the HTTP `Authorization` header when OAuth parameters should be supplied as a header.

**Signed URL output**

Generate a URL that includes the OAuth 1.0 query parameters when the API expects authentication data in the request URL.

**Extra signed parameters**

Add or remove request-specific name/value parameters that must be included in the normalized parameter string and signature calculation.

**HMAC or RSA signatures**

Sign with `HMAC-SHA1`, `HMAC-SHA256`, `RSA-SHA1`, or `RSA-SHA256`, with RSA private keys supplied by `SetRsaKey`.

**Debuggable signing details**

Inspect the exact `BaseString`, `HmacKey`, `QueryString`, `Signature`, and `EncodedSignature` used to build the OAuth request.

**Common pattern:** Set `OauthMethod` and `OauthUrl`, provide the consumer key and secret, set any token and token secret, generate or assign `Nonce` and `Timestamp`, add request parameters with `AddParam`, then call `Generate`. Use `AuthorizationHeader` when sending OAuth data in an HTTP header, or `GeneratedUrl` when the signed OAuth parameters should be placed in the URL.

**URL guidance:** Set `OauthUrl` to the base request URL without query parameters. Add query parameters separately with `AddParam` so they are included correctly in the OAuth 1.0 signature calculation.

## Object creation, unlocking and error handling

**Object Creation**

```sql
DECLARE @hr int
DECLARE @oAuth1 int
EXEC @hr = sp_OACreate 'Chilkat.OAuth1', @oAuth1 OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @oAuth1 ...

EXEC @hr = sp_OADestroy @oAuth1
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.OAuth1.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @oAuth1, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `EXEC sp_OAGetProperty @oAuth1, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @oAuth1, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @oAuth1, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @oAuth1, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @oAuth1, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @oAuth1, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @oAuth1, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @oAuth1, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @oAuth1, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @oAuth1, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @oAuth1, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @oAuth1, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AuthorizationHeader` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'AuthorizationHeader', @sValue OUT` |
| `BaseString` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'BaseString', @sValue OUT` |
| `ConsumerKey` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'ConsumerKey', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'ConsumerKey', @sValue` |
| `ConsumerSecret` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'ConsumerSecret', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'ConsumerSecret', @sValue` |
| `EncodedSignature` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'EncodedSignature', @sValue OUT` |
| `GeneratedUrl` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'GeneratedUrl', @sValue OUT` |
| `HmacKey` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'HmacKey', @sValue OUT` |
| `Nonce` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'Nonce', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'Nonce', @sValue` |
| `OauthMethod` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'OauthMethod', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'OauthMethod', @sValue` |
| `OauthUrl` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'OauthUrl', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'OauthUrl', @sValue` |
| `OauthVersion` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'OauthVersion', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'OauthVersion', @sValue` |
| `QueryString` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'QueryString', @sValue OUT` |
| `Realm` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'Realm', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'Realm', @sValue` |
| `Signature` | property, read-only | `EXEC sp_OAGetProperty @oAuth1, 'Signature', @sValue OUT` |
| `SignatureMethod` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'SignatureMethod', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'SignatureMethod', @sValue` |
| `Timestamp` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'Timestamp', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'Timestamp', @sValue` |
| `Token` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'Token', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'Token', @sValue` |
| `TokenSecret` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'TokenSecret', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'TokenSecret', @sValue` |
| `UncommonOptions` | property, read/write | `EXEC sp_OAGetProperty @oAuth1, 'UncommonOptions', @sValue OUT EXEC sp_OASetProperty @oAuth1, 'UncommonOptions', @sValue` |
| `AddParam` | method | `EXEC sp_OAMethod @oAuth1, 'AddParam', @success OUT, @name, @value` |
| `Generate` | method | `EXEC sp_OAMethod @oAuth1, 'Generate', @success OUT` |
| `GenNonce` | method | `EXEC sp_OAMethod @oAuth1, 'GenNonce', @success OUT, @numBytes` |
| `GenTimestamp` | method | `EXEC sp_OAMethod @oAuth1, 'GenTimestamp', @success OUT` |
| `RemoveParam` | method | `EXEC sp_OAMethod @oAuth1, 'RemoveParam', @success OUT, @name` |
| `SetRsaKey` | method | `EXEC sp_OAMethod @oAuth1, 'SetRsaKey', @success OUT, @privKey` |

## Properties

### OAuth1.AuthorizationHeader

`Chilkat 11.7.0 · sqlserver · OAuth1 · AuthorizationHeader · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'AuthorizationHeader', @sValue OUT
```

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

### OAuth1.BaseString

`Chilkat 11.7.0 · sqlserver · OAuth1 · BaseString · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'BaseString', @sValue OUT
```

This is the exact string that was signed. For example, if the signature method is HMAC-SHA1, the BaseString is the exact string that passed to the HMAC-SHA1. An application does not set the BaseString property. The BaseString is exposed as a property to allow for debugging and to see the exact string that is signed.

### OAuth1.ConsumerKey

`Chilkat 11.7.0 · sqlserver · OAuth1 · ConsumerKey · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'ConsumerKey', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'ConsumerKey', @sValue
```

The consumer key.

### OAuth1.ConsumerSecret

`Chilkat 11.7.0 · sqlserver · OAuth1 · ConsumerSecret · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'ConsumerSecret', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'ConsumerSecret', @sValue
```

The consumer secret.

### OAuth1.EncodedSignature

`Chilkat 11.7.0 · sqlserver · OAuth1 · EncodedSignature · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'EncodedSignature', @sValue OUT
```

The URL encoded representation of the Signature property

### OAuth1.GeneratedUrl

`Chilkat 11.7.0 · sqlserver · OAuth1 · GeneratedUrl · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'GeneratedUrl', @sValue OUT
```

The URL that includes the OAuth1 query params.

### OAuth1.HmacKey

`Chilkat 11.7.0 · sqlserver · OAuth1 · HmacKey · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'HmacKey', @sValue OUT
```

The exact HMAC key used to sign the BaseString. An application does not directly set the HmacKey. The HmacKey property is read-only and is provided for debugging to see the exact HMAC key used to sign the BaseString. The HMAC key is composed from the consumer secret (if it exists) and the token secret (if it exists).

### OAuth1.Nonce

`Chilkat 11.7.0 · sqlserver · OAuth1 · Nonce · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'Nonce', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'Nonce', @sValue
```

The nonce.

### OAuth1.OauthMethod

`Chilkat 11.7.0 · sqlserver · OAuth1 · OauthMethod · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'OauthMethod', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'OauthMethod', @sValue
```

The HTTP method, such as `GET`, `POST`, `PUT`, `DELETE`, or `HEAD`. Defaults to `GET`.

### OAuth1.OauthUrl

`Chilkat 11.7.0 · sqlserver · OAuth1 · OauthUrl · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'OauthUrl', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'OauthUrl', @sValue
```

The OAuth URL, such as `http://echo.lab.madgex.com/echo.ashx`. See http://bettiolo.github.io/oauth-reference-page/ to compare Chilkat results with another tool's results.

**Note:** The OAuthUrl should not include query parameters. For example, do not set the OAuthUrl equal to

```
https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl?script=165&deploy=1
```

Instead, set OAuthUrl equal to

```
https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl
```

and then subsequently call AddParam for each query parameter.

### OAuth1.OauthVersion

`Chilkat 11.7.0 · sqlserver · OAuth1 · OauthVersion · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'OauthVersion', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'OauthVersion', @sValue
```

The oauth_version. Defaults to `1.0`. May be set to the empty string to exclude.

### OAuth1.QueryString

`Chilkat 11.7.0 · sqlserver · OAuth1 · QueryString · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'QueryString', @sValue OUT
```

Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.

### OAuth1.Realm

`Chilkat 11.7.0 · sqlserver · OAuth1 · Realm · property · read/write · since 9.5.0.70`

```sql
EXEC sp_OAGetProperty @oAuth1, 'Realm', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'Realm', @sValue
```

The realm (optional).

### OAuth1.Signature

`Chilkat 11.7.0 · sqlserver · OAuth1 · Signature · property · read-only · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'Signature', @sValue OUT
```

The generated base64 signature.

### OAuth1.SignatureMethod

`Chilkat 11.7.0 · sqlserver · OAuth1 · SignatureMethod · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'SignatureMethod', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'SignatureMethod', @sValue
```

The signature method. Defaults to `HMAC-SHA1`. Other possible choices are `HMAC-SHA256`, `RSA-SHA1`, and `RSA-SHA256` (or the equivalent `RSA-SHA2`).

### OAuth1.Timestamp

`Chilkat 11.7.0 · sqlserver · OAuth1 · Timestamp · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'Timestamp', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'Timestamp', @sValue
```

The timestamp, such as `1441632569`.

### OAuth1.Token

`Chilkat 11.7.0 · sqlserver · OAuth1 · Token · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'Token', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'Token', @sValue
```

The token.

### OAuth1.TokenSecret

`Chilkat 11.7.0 · sqlserver · OAuth1 · TokenSecret · property · read/write · since 9.5.0.53`

```sql
EXEC sp_OAGetProperty @oAuth1, 'TokenSecret', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'TokenSecret', @sValue
```

The token secret

### OAuth1.UncommonOptions

`Chilkat 11.7.0 · sqlserver · OAuth1 · UncommonOptions · property · read/write · since 9.5.0.85`

```sql
EXEC sp_OAGetProperty @oAuth1, 'UncommonOptions', @sValue OUT
EXEC sp_OASetProperty @oAuth1, 'UncommonOptions', @sValue
```

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

Can be set to a list of the following comma separated keywords:

- `INCLUDE_REALM` - Introduced in v9.5.0.85. Include the Realm in the signature calculation and outputs.

## Methods

### OAuth1.AddParam

`Chilkat 11.7.0 · sqlserver · OAuth1 · AddParam · method · since 9.5.0.53`

```sql
EXEC sp_OAMethod @oAuth1, 'AddParam', @success OUT, @name, @value
```

Adds an extra name/value parameter to the OAuth1 signature.

Returns 1 for success, 0 for failure.

### OAuth1.Generate

`Chilkat 11.7.0 · sqlserver · OAuth1 · Generate · method · since 9.5.0.53`

```sql
EXEC sp_OAMethod @oAuth1, 'Generate', @success OUT
```

Generate the signature based on the property settings. Input properties are OauthVersion, OauthMethod, Url, ConsumerKey, ConsumerSecret, Token, TokenSecret, Nonce, and Timestamp. Properties set by this method include: BaseString, Signature, HmacKey, EncodedSignature, QueryString, GeneratedUrl, andAuthorizationHeader.

Returns 1 for success, 0 for failure.

### OAuth1.GenNonce

`Chilkat 11.7.0 · sqlserver · OAuth1 · GenNonce · method · since 9.5.0.55`

```sql
EXEC sp_OAMethod @oAuth1, 'GenNonce', @success OUT, @numBytes
```

Generates a random nonce `numBytes` in length and sets the Nonce property to the hex encoded value.

Returns 1 for success, 0 for failure.

### OAuth1.GenTimestamp

`Chilkat 11.7.0 · sqlserver · OAuth1 · GenTimestamp · method · since 9.5.0.55`

```sql
EXEC sp_OAMethod @oAuth1, 'GenTimestamp', @success OUT
```

Sets the Timestamp property to the current date/time.

Returns 1 for success, 0 for failure.

### OAuth1.RemoveParam

`Chilkat 11.7.0 · sqlserver · OAuth1 · RemoveParam · method · since 9.5.0.53`

```sql
EXEC sp_OAMethod @oAuth1, 'RemoveParam', @success OUT, @name
```

Removes a name/value parameter from the OAuth1 signature.

Returns 1 for success, 0 for failure.

### OAuth1.SetRsaKey

`Chilkat 11.7.0 · sqlserver · OAuth1 · SetRsaKey · method · since 9.5.0.64`

```sql
EXEC sp_OAMethod @oAuth1, 'SetRsaKey', @success OUT, @privKey
```

Sets the RSA key to be used when the SignatureMethod is set to `RSA-SHA1` or `RSA-SHA2`.

Returns 1 for success, 0 for failure.

## Related classes

[`PrivateKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/PrivateKey.md)

