Skip to content

Latest commit

 

History

History
152 lines (112 loc) · 5.66 KB

OauthApi.md

File metadata and controls

152 lines (112 loc) · 5.66 KB
Raw

com.ultracart.admin.v2.Api.OauthApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
OauthAccessToken POST /oauth/token Exchange authorization code for access token.
OauthRevoke POST /oauth/revoke Revoke this OAuth application.

OauthAccessToken

OauthTokenResponse OauthAccessToken (string clientId, string grantType, string code = null, string redirectUri = null, string refreshToken = null)

Exchange authorization code for access token.

The final leg in the OAuth process which exchanges the specified access token for the access code needed to make API calls.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class OauthAccessTokenExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new OauthApi(simpleKey);

            var clientId = clientId_example;  // string | The OAuth application client_id.
            var grantType = grantType_example;  // string | Type of grant
            var code = code_example;  // string | Authorization code received back from the browser redirect (optional) 
            var redirectUri = redirectUri_example;  // string | The URI that you redirect the browser to to start the authorization process (optional) 
            var refreshToken = refreshToken_example;  // string | The refresh token received during the original grant_type=authorization_code that can be used to return a new access token (optional) 

            try
            {
                // Exchange authorization code for access token.
                OauthTokenResponse result = apiInstance.OauthAccessToken(clientId, grantType, code, redirectUri, refreshToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OauthApi.OauthAccessToken: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
clientId string The OAuth application client_id.
grantType string Type of grant
code string Authorization code received back from the browser redirect [optional]
redirectUri string The URI that you redirect the browser to to start the authorization process [optional]
refreshToken string The refresh token received during the original grant_type=authorization_code that can be used to return a new access token [optional]

Return type

OauthTokenResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OauthRevoke

OauthRevokeSuccessResponse OauthRevoke (string clientId, string token)

Revoke this OAuth application.

Revokes the OAuth application associated with the specified client_id and token.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class OauthRevokeExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new OauthApi(simpleKey);

            var clientId = clientId_example;  // string | The OAuth application client_id.
            var token = token_example;  // string | The OAuth access token that is to be revoked..

            try
            {
                // Revoke this OAuth application.
                OauthRevokeSuccessResponse result = apiInstance.OauthRevoke(clientId, token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OauthApi.OauthRevoke: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
clientId string The OAuth application client_id.
token string The OAuth access token that is to be revoked..

Return type

OauthRevokeSuccessResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]