Skip to content

Latest commit

 

History

History
222 lines (157 loc) · 8.3 KB

OAuthEndpointsApi.md

File metadata and controls

222 lines (157 loc) · 8.3 KB

OAuthEndpointsApi

All URIs are relative to https://api.smooch.io

Method HTTP request Description
authorize GET /oauth/authorize Authorize
getToken POST /oauth/token Get Token
revokeAccess DELETE /oauth/authorization Revoke Access

authorize

authorize(clientId, responseType, state, redirectUri)

Authorize

This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to Sunshine Conversations they will be redirected to the login page. If the user has many apps, they will first be prompted to select the one they wish to integrate with. They will then be presented with an Allow/Deny dialog, describing details of the access your integration is requesting.

Example

import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.OAuthEndpointsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");

        OAuthEndpointsApi apiInstance = new OAuthEndpointsApi(defaultClient);
        String clientId = "5e4af71a81966cfff3ef6550"; // String | Your integration’s unique identifier
        String responseType = "code"; // String | For now the only acceptable value is code.
        String state = "Pending"; // String | You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect.
        String redirectUri = "https://example.org"; // String | You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by your integration. If this option is not passed, the first URI present in the list will be used.
        // Add required body parameters

        try {
            apiInstance.authorize(clientId, responseType, state, redirectUri);
        } catch (ApiException e) {
            System.err.println("Exception when calling OAuthEndpointsApi#authorize");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
clientId String Your integration’s unique identifier
responseType String For now the only acceptable value is code.
state String You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect. [optional]
redirectUri String You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by your integration. If this option is not passed, the first URI present in the list will be used. [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
302 Found. Redirecting to /login -
404 The provided redirect_uri does not match the client_id configuration -

getToken

Object getToken(inlineObject)

Get Token

This endpoint is used to exchange an authorization code for an access token. It should only be used in server-to-server calls.

Example

import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.OAuthEndpointsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");

        OAuthEndpointsApi apiInstance = new OAuthEndpointsApi(defaultClient);
        InlineObject inlineObject = new InlineObject(); // InlineObject | 
        // Add required body parameters

        try {
            Object result = apiInstance.getToken(inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OAuthEndpointsApi#getToken");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
inlineObject InlineObject

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authorization is required -

revokeAccess

Object revokeAccess()

Revoke Access

This endpoint is used to revoke your integration’s access to the user’s Sunshine Conversations app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed. Calling this endpoint is equivalent to the user removing your integration manually in the Sunshine Conversations web app. Your integration’s `removeUrl` (if configured) will also be called when an integration is removed in this way.

Example

import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.OAuthEndpointsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        OAuthEndpointsApi apiInstance = new OAuthEndpointsApi(defaultClient);
        // Add required body parameters

        try {
            Object result = apiInstance.revokeAccess();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OAuthEndpointsApi#revokeAccess");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -